Filter (Particle Tracing, Point Trajectories, Ray Tracing)
Add a filter attribute to a particle trajectories or particle, point trajectories, or ray or ray tracing plot.
Syntax
model.result(
<pgtag>
).feature(
<ftag>
).create(
<atag>
,
"ParticleTrajectoriesFilter");
model.result(
<pgtag>
).feature(
<ftag>
).create(
<atag>
,
"PointTrajectoriesFilter");
model.result(
<pgtag>
).feature(
<ftag>
).create(
<atag>
,
"RayTrajectoriesFilter");
model.result(
<pgtag>
).feature(
<ftag>
).feature(
<atag>
).set(
property
,
<value>
);
Description
model.result
(<pgtag>
).feature(
<ftag>
).create(
<atag>
,"ParticleTrajectoriesFilter")
creates a filter attribute named
<atag>
belonging to the plot feature
<ftag>
.
Use filters to plot a subset of particles, points, or rays in a dataset.
Filters can be added to particle trajectories plots and particle plots; point trajectories plots; and ray trajectories plots and ray plots.
The following properties are available:
Table 7-37:
Valid Properties for the Filters for particle trajectories, Point Trajectories, and Ray Tracing
Property
Value
Default
Description
evaluate
all|fraction| number
all
Determines which particles are rendered when creating the plot.
fraction
Double
1
Fraction of particles that are rendered. Active when
evaluate
is set to
fraction
.
logical
Double
1
Logical statement that must be true for a particle, point, or ray to be included in the plot. Active when
type
is set to
logical
.
number
Integer
100
Number of particles, points, or rays that are rendered. Active when
evaluate
is set to
number
.
type
all
|
primary| secondary| logical
all
Determines which particles, points, or rays that are included when creating the plot.
primary
and
secondary
are not available for point trajectories.