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

Description

Includes (or excludes) steady state particles for display, based on their entry or exit location.

Annotation Types

Particle (Steady State Only)

Parameters

Label - A unique name that identifies the filter. (IFilter/Label)

Criteria - Controls if the particles are filtered based on entry or exit location. (IParticleLocationFilter/Criteria)

Location Type - Type of shape to be used. (IParticleLocationFilter/LocationType)

Inclusion - Controls if particles inside the shape are included or excluded. (IParticleLocationFilter/Inclusion)

Axis Point - [LENGTH] - Point on the axis of the annulus defined in the world coordinate system. This is a unitless vector and its magnitude is irrelevant. Only visible if type is annulus. (IParticleLocationFilter/AxisPoint)

Axis Direction - Direction of the axis of the annulus defined in the world coordinate system. This is a unitless vector and its magnitude is irrelevant. Only visible if type is annulus. (IParticleLocationFilter/AxisDirection)

Inner Radius - [LENGTH] – Inner radius of annulus. Only visible if type is annulus. (IParticleLocationFilter/InnerRadius)

Outer Radius - [LENGTH] – Outer radius of annulus. Only visible if type is annulus. (IParticleLocationFilter/OuterRadius)

Corner - [LENGTH] – Corner of box. Only visible if type is box. (IParticleLocationFilter/Corner)

Extent - [LENGTH] – Extent of box. Only visible if type is box. (IParticleLocationFilter/Extent)

Example(s)

User Interface Button

Requirements

Only valid for steady state particles.

Example Script

Config_1 = ParticleAnnotation_1.Get_IParticleAnnotation().GetConfig()
ocationFilter_1 = Config_1.Get_IAnnotationConfig().NewFilter("ParticleLocationFilter", "Location_1")

Scripting Interfaces

“IParticleLocationFilter”
“IFilter”

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