compass (MathScript RT Module Function)

Owning Class: plots

Requires: MathScript RT Module

Syntax

compass(z)

compass(z, attributes)

compass(x, y)

compass(x, y, attributes)

obj = compass(z)

obj = compass(z, attributes)

obj = compass(x, y)

obj = compass(x, y, attributes)

Description

Generates a compass plot. compass(z) is equal to compass(real(z), imag(z)).

Examples

Inputs

Name	Description
x	Specifies a real vector with values that are the x-coordinates of each arrow to plot.
y	Specifies a real vector with values that are the y-coordinates of each arrow to plot.
z	Specifies a complex vector with real and imaginary values that are the x- and y-coordinates of each arrow to plot.
attributes	Specifies valid plot attributes. Order the plot attributes by color, point-style, and line-style. For example, 'bo-' specifies that the plot is blue, marks points with circles, and uses solid lines. attributes is a string that can take a combination of the following values: 'b' Colors the plot blue. 'c' Colors the plot cyan. 'g' Colors the plot green. 'k' Colors the plot black. 'm' Colors the plot magenta. 'r' Colors the plot red. 'y' Colors the plot yellow. '.' Marks points with dots. 'o' Marks points with circles. 'x' Marks points with crosses. '+' Marks points with plus signs. '*' Marks points with asterisks. '-' Uses solid lines. ':' Uses dotted lines. '-.' Uses dashed and dotted lines. '--' Uses dashed lines.

Outputs

Name	Description
obj	Returns the reference to the line object. obj is a reference to a line object.

Details

The following table lists the support characteristics of this function.

Supported in the LabVIEW Run-Time Engine	No (returns error or is ignored)
Supported on RT targets	No

Examples

T = 0:0.2:5*pi;
[X, Y] = polar_to_cart(T, T)
compass(X, Y);

Related Topics

feather
polar