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

6.2.11.1. Parameters

Tab

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)

Secondary/Field Strength – Field strength for the data item chosen by Qualifier 3.

Secondary/RF Period - RF period for the data item chosen by Qualifier 3. Only visible if rendering time-domain particles.

Information/Undecimated Particle Count - Total number of particles. This parameter is for informational purposes and read-only. (IParticleAnnotation/ParticleCount)

Information/Undecimated Position (Knot) Count – Number of positions (knots) in the particles. This parameter is for informational purposes and read-only. (IParticleAnnotation/KnotCount)

Information/Rendered Particle Count - Number of particles, less particles that are decimated, filtered, etc. This parameter is for informational purposes and read-only. (IParticleAnnotation/ParticleCount)

Display

Absolute Value - Controls if the absolute value of the data is used in rendering. (IFieldAnnoationConfig/Absolute)

Show in dB - Display the field values in dB (20*log10(|value|). (IFieldAnnoationConfig/FieldDB)

Color By - Controls how the particles are colored. Choices include None, Specie, Type, Generation, and Rainbow. Only visible for non-field based particle data. (IParticleAnnotationConfig/ColorBy)

Maximum Number of Particles to Show - Defines particle decimation to reduce clutter and rendering time. "0" shows all particles. Other values show the chosen number of particles sampled regularly. For example, a value of 10 will show particle 1, 11, 21, etc. (IParticleAnnotationConfig/NumDecimatedParticles)

Primary Birth Indices to Show - Shows the particles with matching primary birth indices. The indices are comma separated and range is specified with '-'. Example: 0-100,200,500-700. (IParticleAnnotationConfig/ParticleBirthIndicesToInclude)

Positions (Knots)/Visible - Visibility of positions (knots). (IParticleAnnotationConfig/ShowKnots)

Positions (Knots)/Maximum Number To Show Per Particle - Defines position (knot) decimation per particle. "0" shows all knots. Other values show the chosen number of knots per particle sampled accordingly. Only visible for steady-state simulations. (IParticleAnnotationConfig/NumDecimatedKnots)

Positions (Knots)/Indices To Show - Shows a specified set of positions (knots). The indices are comma separated and range is specified with '-'. Example: 0-100,200,500-700. Only visible for steady-state simulations. (IParticleAnnotationConfig/KnotsToInclude)

Positions (Knots)/Color - Color of positions (knots). (IParticleAnnotationConfig/KnotColor)

Positions (Knots)/Fixed Size - [PIXELS] - Size of positions (knots). (IParticleAnnotationConfig/FixedKnotSize)

Tracks/Visible - Visibility of tracks (lines). Only visible for steady-state simulations. (IParticleAnnotationConfig/ShowTracks)

Tracks/Color - Track (lines) color. Only visible for steady-state simulations. (IParticleAnnotationConfig/TrackColor)

Tracks/Thickness/Size - [PIXELS] - Thickness of particle tracks in pixels. Particularly useful to control the size of points rendered when taking a slice of the particles. Only visible for steady-state simulations. (IParticleAnnotationConfig/TrackThickness)

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

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.

Vectors/Maximum Number To Display - Maximum number of vectors to show. This is an additional cap that is applied after particle and position (knot) decimation. A value of 0 turns off the cap. (IParticleAnnotationConfig/MaximumNumberToDisplay)

Legend

If Data Source/Primary/Qualifier 3 is Particles or Particle Orbits no Legend displays.

Otherwise:

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. (IAnnotationLegendConfig/TitleFontSize)

Text/Label Size – Relative size for the legend label font. (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