Line Profile Annotation Properties
These properties control line profile annotation 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
|
Interface:
Property Name |
Control Type: Values
|
API:
Property Identifier |
API:
Allowed Values |
|---|---|---|---|
| Vertex Colors Color Table |
User Defined: By selecting Edit Color → Table Edit ![]()
|
None |
None |
| Transparency |
Number: Transparency of the plot from 0% to 100%. Move the slider to change the value. Default = |
TRANSPARENCY |
Integer from 0 to 100. |
| Color |
Color: Color to be used for the line. Click to choose from the default color palette, or specify RGB values. Default = |
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 line profile annotation. Select a line style from the list. Default = |
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 line profile annotation in points. Select a thickness from the list. Default = |
THICK |
A floating-point value between 1.0 (the default) and 10.0. |
| Minimum value |
Number: Minimum value for line profile. Edit number to change value. No default value. |
MIN_VALUE |
Floating point value |
| Maximum value |
Number: Maximum value for line profile.Edit number to change value. No default value. |
MAX_VALUE |
Floating point value |
| Histogram plot |
Boolean: Show line profile as a histogram plot? Choose True or False. Default = False |
HISTOGRAM |
0 (Do not show line profile as a histogram plot--default) 1 (Show line profile as a histogram plot) |
| Number of points to average |
Number: Set number of points to average. Enter a value.
Default = |
NSUM |
Integer |
| Polar plot |
Boolean: Show line profile as a polar plot? Choose True or False. Default = False |
POLAR |
0 (Do not show line profile as a polar plot--default) 1 (Show line profile as a polar plot) |
| Fill plot |
Boolean: Fill plot? Choose True or False. Default = False |
FILL_BACKGROUND |
0 (Do not fill plot--default) 1 (Fill plot) |
| Fill level |
Number: Set level to fill. Enter value.
Default = |
FILL_LEVEL |
Floating point value |
| Fill color |
Color: Color used for fill. For color to display, Fill Plot property must be set to True. Click to choose from the default color palette, or specify RGB values.
Default = |
FILL_COLOR |
3D integer array of the form: [R, G, B] Each color value may range from 0 to 255. |
| Fill transparency |
Number: Transparency of the plot fill from 0% to 100%. Move the slider to change the value. Default = |
FILL_TRANSPARENCY |
Integer from 0 to 100. |
| Z value |
Number: Z value of plane on which to project the plot. Edit the number to change the value.
Default = |
ZVALUE |
Floating point value |
| Symbol |
Symbol: Symbol to appear at regular intervals on the plot line. Choose a symbol from the list. 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: Factor from 0 - 1 determining the size of the selected symbol. Move slider to change the size. Default = |
SYM_SIZE |
Floating point from 0 to 1.0. |
| Use default color |
Boolean: Activate Symbol color property. Choose True or False. Default = False |
USE_DEFAULT_COLOR |
0 (Do not use default color--default) 1 (Use default color) |
| Symbol color |
Color: Color for the selected symbol. Click to choose from the default color palette, or specify RGB values. Default = |
SYM_COLOR |
3D integer array of the form: [R, G, B] Each color value may range from 0 to 255. |
| Symbol thickness |
Number: Line thickness from 1 - 9.9 for the selected symbol. Move slider to change the thickness. Default = |
SYM_THICK |
Floating point value from 1.0 to 9.9. |
| Symbol increment |
Number: Interval at which symbols will be displayed on the plot line. Influenced by Number of points to average (above). Edit to change the value. Default = |
SYM_INCREMENT |
Integer |
.
