Go to www.awrcorp.com
Back to search page Click to download printable version of this guide.

6.2.10.1. Parameters

Tab Label

Parameters

Data Source

Label - A unique name that identifies the annotation. (IAnnotation/Label)

Primary/Qualifier 1 – Label of the simulation containing the desired data set. (IDataItemSelection/Qualifier1)

Primary/Qualifier 2 – Label of the desired data set (typically an AMR iteration) in the simulation chosen by Qualifier 1. (IDataItemSelection/Qualifier2)

Primary/Qualifier 3 – Label of the data item in the data set chosen by Qualifier 2. (IDataItemSelection/Qualifier3)

Information/Element Count – Number of elements in the chosen mesh. This parameter is for informational purposes and read-only. (IFieldAnnotation/ElementCount)

Information/Node Count – Number of nodes in the chosen mesh. This parameter is for informational purposes and read-only. (IFieldAnnotation/NodeCount)

Display

Show as Vector – Controls the dimensionality of the data for rendering. Only visible when working with a vector field. Choose Scalar to convert the vector field data to scalar field data and then display the field as colors overlaid on the mesh. Choose Vector to display the field as conical glyphs located at each mesh node, oriented to indicate field direction. (IFieldAnnotationConfig/DimensionModifier).

Complex Modifier – Controls how complex field values are manipulated prior to rendering. (IFieldAnnotationConfig/ComplexModifier)

Component - Allows zeroing one or more components of a vector field. Only visible if rendering vectors. For example, if set to XY, all Z components of the vector field are zeroed. (IFieldAnnotationConfig/VectorComponent)

Absolute Value - Controls if the absolute value of the field data is used during rendering. (IFieldAnnotationConfig/Absolute)

Show in dB - Display the field values in decibels. (IFieldAnnotationConfig/FieldDB)

Absolute Value - Controls if the absolute value of the field data is used during rendering. (IFieldAnnotationConfig/Absolute)

Scale Factor - Allows scaling of field values for export to another application, or for a field integration. Also can be used to compensate for a setting to the field normalization parameters, rather than resimulating with different normalization parameters.

Vectors/Symbol - Control the symbol used to display vector magnitude and direction. Only visible if rendering vectors.

Vectors/Location - Allows display of vector glyphs on a regular grid, or at mesh nodes. (IAnnotationVectorConfig/Location)

Vectors/Regular Grid Density - Control the density of the grid on which vector glyphs are displayed. Grid density can be set on each of X, Y, and Z axes. Only visible if displaying vector glyphs on regular grid. (IAnnotationVectorConfig/RegularGridDensity)

Vectors/Decimation - Reduces glyph density to 1/N. Typically used to reduce view clutter and rendering time. Only visible if displaying vector glyphs at mesh nodes. (IAnnotationVectorConfig/VectorDecimation)

Vectors/Scale by Magnitude - Scale glyph size by field magnitude. Only visible if rendering vectors. (IAnnotationVectorConfig/VectorScaleByMagnitude)

Vectors/Size Mode - Controls how the size of the glyphs is defined. Choose Pixel to set the size of the largest glyph in pixels. Choose Absolute Value to set the size of the largest glyph as a value relative to the bounding box of the underlying mesh. (IAnnotationVectorConfig/VectorSizeMode)

Vectors/Absolute Size - Maximum glyph length. Only visible if Size Mode is Absolute. (IAnnotationVectorConfig/AbsoluteVectorSize)

Vectors/Pixel Size - [PIXELS] - Maximum glyph length. Only visible if Size Mode is Pixels. (IAnnotationVectorConfig/PixelVectorSize)

Vectors/Resolution - Resolution of glyph base. "2" is a line base, 3" is a triangular base, "6" is a hexagonal base, etc. Reducing this value can decrease rendering times. Only visible if rendering vectors. (IAnnotationVectorConfig/VectorResolution)

Vectors/Radius to Height Ratio - Ratio of glyph radius to length. Only visible if rendering vectors. (IAnnotationVectorConfig/VectorRadiusToHeightRatio)

Vectors/Shaft Height - [PERCENT] - Shaft height as a percentage of total arrow height. Only visible if Symbol is Arrow.

Vectors/Shaft Radius - [PERCENT] - Shaft radius as a percentage of arrow tip radius. Only visible if Symbol is Arrow.

Scalars/Style - Controls how scalar fields are rendered. Shaded, Contour Bands, or Contour Edges . Only visible if rendering scalars. (IIsoSurfaceFilter/DisplayStyle)

Scalars/Enable Smoothing - If true, the mesh on which scalar fields are rendered is refined to the user defined smoothing angle is met. Typically used to produce presentation quality images.

Scalars/Smoothing Angle - This value controls how finely the mesh on which scalar fields are rendered is re-faceted. The smaller this value, the coarser the re-faceting. Too larger of a value may result in rounding of corners.

Display/Number of Contours - Controls the number of contour intervals in the range of field values. Only visible if Display/Style is Contour Bands or Contour Edges. (IIsoSurfaceFilter/NumberOfContours)

Legend

Visible - Controls legend visibility. (IAnnotationLegendConfig/Visible)

Color Map - Controls coloring of values in legend. (IAnnotationLegendConfig/ColorMap)

Scale - Use a linear or base-10 log scale for the color map. (IAnnotationLegendConfig/ColorMap)

Number of Colors - Controls the number of colors in the legend. Minimum value is 2. (IAnnotationLegendConfig/NumberOfColors)

Range/Minimum Mode - Choose Automatic Filtered or Automatic for system defined minimum of range (Automatic Filtered takes into account any annotation filters). Choose Manual for user-defined range limit. (IAnnotationLegendConfig/RangeMinMode)

Range/Minimum Value - If Minimum Mode is Manual, sets the lower limit for the legend. Otherwise this parameter is read-only. If Scale is Log10 Range/Minimum Value and Range/Maximum Value can not cross the value 0.(IAnnotationLegendConfig/RangeMin)

Range/Maximum Mode - Choose Automatic Filtered or Automatic for system defined maximum of range (Automatic Filtered takes into account any annotation filters). Choose Manual for user-defined range limit. (IAnnotationLegendConfig/RangeMaxMode)

Range/Maximum Value - If Maximum Mode is Manual, sets the upper limit for the legend. Otherwise this parameter is read-only. If Scale is Log10 Range/Minimum Value and Range/Maximum Value can not cross the value 0.(IAnnotationLegendConfig/RangeMax)

Size/Overall Width - [PERCENT] – Width of the color bar as a percentage of the view width. (IAnnotationLegendConfig/OverallWidth)

Size/Color Bar Height - [PERCENT] – Height of the color bar as a percentage of the view height. (IAnnotationLegendConfig/ColorBarHeight)

Text/Font - Legend font family. (IAnnotationLegendConfig/Font)

Text/Title Size - Relative size for the legend title font. Maximum size is limited by the dimensions of the view. (IAnnotationLegendConfig/TitleFontSize)

Text/Number Size - Relative size for the legend label font. Maximum size is limited by the dimensions of the view. (IAnnotationLegendConfig/LabelFontSize)

Captions/Minimum - Choose On to display a caption on the annotation, indicating the location of the annotation's minimum value. Choose Verbose to display a more verbose caption. Choose Off to suppress the caption.

Captions/Maximum - Choose On to display a caption on the annotation, indicating the location of the annotation's maximum value. Choose Verbose to display a more verbose caption. Choose Off to suppress the caption.

Please send email to awr.support@ni.com if you would like to provide feedback on this article. Please make sure to include the article link in the email.

Legal and Trademark Notice