Histogram

Figure D-23: Visualization Browser with Histogram Properties Displayed

VizBrowserHistogram.gif

These properties control histogram object 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-53: Histogram Container Properties 

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

Vertex Colors Color Table

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

paletteeditor.gif

None

None

Histogram binsize

Number: Set histogram binsize.

Default = 1

HIST_BINSIZE

Floating point value

Plot Transparency

Number: Level of transparency.

Default = 0

TRANSPARENCY

Integer

Color

Color: Color to be used for the plot lines. RGB values are assigned or you may edit your color.

Default = varies

COLOR

3D integer array of the form:

[R, G, B]

Each color value may range from 0 to 255.

Line style

Line Style: Style of the colorbar lines. Select a line style from the list.

Default = Histogram-30.jpg(solid line)

LINESTYLE

An integer value specifying a predefined line style, or a two-element vector specifying a stippling pattern.

The predefined line styles are:

0 (Solid line--the default)

1 (Dotted)

2 (Dashed)

3 (Dash dot)

4 (Dash dot dot dot)

5 (Long dash)

6 (No line drawn)

To define your own stippling pattern, specify a two-element vector [repeat, bitmask], where repeat indicates the number of times consecutive runs of 1's or 0's in the bitmask should be repeated. (That is, if three consecutive 0's appear in the bitmask and the value of repeat is 2, the line will have six consecutive bits turned off.) The value of repeat must be in the range 1 <= repeat <= 255.

The bitmask indicates which pixels are drawn and which are not along the length of the line. Bitmask is most conveniently specified as a 16-bit hexadecimal value.

For example, LINESTYLE = [2, 'F0F0'X] describes a dashed line (8 bits on, 8 bits off, 8 bits on, 8 bits off).

Thickness

Line Thickness: Thickness of the colorbar lines in points. Select a thickness from the list.

Default = 1

THICK

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

Minimum value

Number: Minimum histogram value. Enter a number.

Default = varies

MIN_VALUE

Floating point value

Maximum value

Number: Maximum histogram value. Enter a number.

Default = varies

MAX_VALUE

Floating point value

Histogram plot

Boolean: Set histogram to show or not show. Choose True or False.

Default = True (show)

HISTOGRAM

0 (Not Show)

1 (Show)

Number of points to average

Number: Number of points in plot to be averaged. Enter a number.

Default = 1

NSUM

Integer

Polar plot

Boolean: Set histogram to show or not show as a polar plot. Choose True or False.

Default = False (hide)

POLAR

0 (Not Show)

1 (Show)

Fill plot

Boolean: Set histogram to show or not show as a filled plot. Choose True or False.

Default = False (hide)

FILL_BACKGROUND

0 (Not Show)

1 (Show)

Fill level

Number: Level to fill if fill plot is selected. Enter a number.

Default = varies

FILL_LEVEL

Floating point value

Fill color

Color: Color to be used for fill plot if selected.

Default = [128, 128, 128] (grey)

FILL_COLOR

3D integer array of the form:

[R, G, B]

Each color value may range from 0 to 255.

Fill transparency

Number: Value of transparency if fill plot is selected. Enter a number.

Default = 0

FILL_TRANSPARENCY

Integer

Z value

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

Default = 0

ZVALUE

Floating point

Symbol

String List: Font used for legend text. Select a font from the list. Choose from the list of symbols.

Default = No symbol

SYM_INDEX

0 (No symbol)

1 (Plus sign)

2 (Asterisk)

3 (Period)

4 (Diamond)

5 (Triangle)

6 (Square)

7 (X)

8 (Right arrowhead)

9 (Left arrowhead)

Symbol size

Number: Value for symbol size in points if fill symbol is selected. Enter a number.

Default = 0.2

SYM_SIZE

Floating point

Use default color

Boolean: Set to use default color for symbols. Choose True or False.

Default = True (use default color)

USE_DEFAULT_COLOR

0 (Do not use default color)

1 (Use default color)

Symbol color

Color: Color to be used for symbols if default color is set to False. Enter a value.

Default = varies

SYM_COLOR

3D integer array of the form:

[R, G, B]

Each color value may range from 0 to 255.

Symbol thickness

Number: Value for symbol thickness in points if symbol is selected. Enter a number.

Default = 1

SYM_THICK

Floating point

Symbol increment

Number: Value for symbol increments if fill symbol is selected. Enter a number.

Default = 1

SYM_INCREMENT

Integer

.