Vector

Figure D-17: Visualization Browser with Vector Properties Displayed

VizBrowserVector.gif

These properties control vector visualizations. For each property, the type of control and the values that can be assigned are listed, along with the property identifier and allowed values for use by the iTools Procedural Interface. For a description of how a particular control is used, refer to Property Controls.

Table D-47: Vector Properties 

Interface:
Property Name
Control Type: Values
API:
Property Identifier
API:
Allowed Values

Grid units

String List: Set grid units type. Choose from:

  • Not applicable
  • Meters
  • Degrees

Default = Not applicable

GRID_UNITS

0 (Not applicable--default)

1 (Meters)

2 (Degrees)

Vector style

String List: Set vector style type. Choose between these values:

  • Arrows
  • Wind barbs

Default = Arrows

VECTOR_STYLE

0 (Arrows--default)

1 (Wind barbs)

Length scale

Number: Length. Enter value.

Default = 1

LENGTH_SCALE

Floating point

Head size

Number: Head size. Enter value.

Default = 1

HEAD_SIZE

Floating point

Arrow style

String List: Set arrow style type. Choose between these values:

  • Lines
  • Filled

Default = Filled

ARROW_STYLE

0 (Lines)

1 (Filled--default)

Proportional heads

Boolean: Make arrow heads proportional? Choose True or False. Default = False

HEAD_PROPORTIONAL

0 (Do not make arrow heads proportional)

1 (Make arrow heads proportional)

Arrowhead angle

Number: Arrowhead angle value. Enter value.

Default = 30

HEAD_ANGLE

Floating point

Arrowhead indentation

Number: Arrowhead indentation value. Enter value.

Default = 0.4

HEAD_INDENT

Floating point

Arrow thickness

Number: Arrow thickness level. Choose value 1 through 10.

Default = 2

ARROW_THICK

A floating-point value between 1.0 (the default) and 10.0.

Line thickness

Number: Line thickness level. Choose value 1 through 10.

Default = 1

THICK

A floating-point value between 1.0 (the default) and 10.0.

Data location

String List: Select location along arrow for data. Choose Tail, Center, or Head. Default = Center

DATA_LOCATION

0 (Tail)

1 (Center--default)

2 (Head)

Automatic color

String List: Select color setting. Choose None, Magnitude, or Direction. Default = Magnitude

AUTO_COLOR

0 (None)

1 (Magnitude--default)

2 (Direction)

Color

Color: Color for arrows. Click to choose from the default color palette, or specify RGB values. Default = [0,0,0] (black)

COLOR

3D integer array of the form:

[R, G, B]

Each color value may range from 0 to 255.

Color palette

Color: By selecting Edit color table → Edit access the color table to manipulate vector color values

VizBrowserVectorColorPaletteEditor.gif

Note - To edit the opacity only in the editor, uncheck the R, G, and B boxes in both the Modify and Display rows. Edit the remaining line by clicking on and dragging the line in the window. Click OK when finished.

None

None

Transparency

Number: Percent transparency. Move slider to change value.

Default = 0

TRANSPARENCY

Integer from 0 to 100.

Minimum magnitude

Number: minimum magnitude. Enter value.

Default = None

MIN_VALUE

Floating point value

Maximum magnitude

Number: maximum magnitude. Enter value.

Default = None

MAX_VALUE

Floating point value

Z value

Number: Z value of plane on to which to project the vector visualization. Edit the number to change the value.

Note - If the Z value is zero then the vector visualization is considered to be 2D. If the Z value is nonzero, then the vector visualization is considered to be 3D, and the dataspace associated with this vector will be automatically switched to 3D.

Default = 0

ZVALUE

Floating point

Automatic subsampling

Boolean: Automatically subsample the vector visualization? Choose True or False. Default = False

AUTO_SUBSAMPLE

0 (Do not automatically subsample)

1 (Automatically subsample)

Subsampling method

String List: Set subsample type. Choose between these values:

  • Nearest neighbor
  • Linear

Default = Nearest neighbor

SUBSAMPLE_METHOD

0 (Nearest neighbor--default)

1 (Linear)

X subsampling factor

Number: Subsample factor in the x direction.

Default = 1

X_SUBSAMPLE

Integer

Y subsampling factor

Number: Subsample factor in the y direction.

Default = 1

Y_SUBSAMPLE

Integer

Direction convention

String List: Choose direction convention. Select Polar, Meteorological, or Wind azimuths. Default = Polar (counterclockwise from X axis)

DIRECTION_CONVENTION

0 (Polar--default)

1 (Meteorological)

2 (Wind azimuths)

Missing point symbol

Symbol: Symbol to be used for missing points. Choose a symbol from the list. Default = No symbol for arrow visualizations, Points for wind barb visualization.

SYM_INDEX

0 (No symbol)

1 (Plus sign)

2 (Asterisk)

3 (Period)

4 (Diamond)

5 (Triangle)

6 (Square)

7 (X)

8 (Arrowhead)

Symbol size

Number: Factor from 0 - 1 determining the size of the selected symbol. Move slider to change the size. Default = 0.2

SYM_SIZE

Floating point between 0 and 1.

Use default color

Boolean: Activate Symbol color property. Choose True or False. Default = False

USE_DEFAULT_COLOR

0 (Do not activate symbol color)

1 (Activate symbol color)

Symbol color

Color: Color for the selected symbol. Click to choose from the default color palette, or specify RGB values. Default = [0,0,0] (black)

SYM_COLOR

3D integer array of the form:

[R, G, B]

Each color value may range from 0 to 255.