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

Description

Includes (or excludes) particles for display, based on their emission energy. Can consider potential energy, kinetic energy, or both.

Annotation Types

Particle

Parameters

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

Enabled - If false, filter is excluded from filter chain. (IFilter/Enabled)

Type - Type of energy to filter on. (IEnergyFilter/EnergyType)

Inclusion - Determines whether particles that fall within the minimum and maximum values are included or excluded. (IEnergyFilter/Inclusion)

Minimum - [ENERGY] - If a particle's energy is greater than or equal to this value then the particle is included subject to the choice for Inclusion. (IEnergyFilter/LaunchKineticEnergyMinimum)

Maximum - [ENERGY] - If a particle's energy is less than or equal to this value then the particle is included subject to the choice for Inclusion. (IEnergyFilter/LaunchKineticEnergyMaximum)

Reference Voltage - [VOLTAGE] - Reference voltage for the launch potential energy. Visible if Type is not Launch Kinetic Energy.

Example(s)

range: 0 -- 1e-14(J):

range: 0 -- 1e-15(J):

range: 1e-15 -- 1e-14(J):

User Interface Button

Requirements

Example Script

PyViewConfig_1.Get_IView3DConfig().RemoveIsolated((PyFieldAnnotation_1.Get_IIsolatable())) PyEnergyFilter_1 = PyConfig_1.Get_IAnnotationConfig().NewFilter("EnergyFilter", "Energy_1")

Scripting Interfaces

“IEnergyFilter”
“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