RayTrajectories
Create a ray trajectories plot in 2D and 3D
Syntax
model.result(<pgtag>).create(<ftag>,"RayTrajectories");
model.result(<pgtag>).feature(<ftag>).set(property,<value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result(<pgtag>).create(<ftag>,"RayTrajectories") creates a ray trajectories plot feature named <ftag> belonging to plot group <pgtag>.
A ray dataset is required to plot ray trajectories. The ray dataset identifies the geometry in which the ray data is stored and the degrees of freedom which determine the position of each ray.
The following properties are available:
Table 7-123: Valid Properties for Ray Trajectories Plots.
Name
Value
Default
Description
arrowbase
heat | tail | center
head
Whether the head, tail, or center of the arrow is located at the ray position.
arrowexpr
string array
 
Active when pointtype is set to arrow. Determines the direction in which the arrow points.
arrowlength
logarithmic | normalized | proportional
proportional
The arrow scaling: Proportional uses the actual arrow length, normalized a unit length, and logarithmic a length proportional to the logarithm of the arrow length.
arrowscale
positive double
1
If arrowscaleactive is true: the length scale factor.
arrowscaleactive
boolean
false
If true, arrowscale is used, otherwise the scale factor is computed automatically.
arrowtype
arrow | arrowhead | cone
arrow
The type of arrow to draw.
comettailexpr
String array
inverse of velocity vector of the first available ray tracing interface
Active when pointtype is set to comettail. Determines the direction in which the comet tail points and the relative sizes of the tails of different rays.
data
none | parent | dataset name
parent
The dataset this feature refers to.
ellipsearrowbase
head | tail
head
The base for the arrow to draw for ellipses.
ellipsearrowtype
arrow | cone | none
arrow
The type of arrow to draw for ellipses.
ellipsearrowscale
double
 
The ellipse arrow scale factor, if ellipsearrowscaleactive is set to true.
ellipsearrowscaleactive
Boolean
false
Set to true to specify an ellipse arrow scale when pointtype is ellipse.
ellipsecount
positive integer
10
Maximum number of ellipses, when ellipseentrymethod is numberofellipses.
ellipseentrymethod
numberofellipses | listoftimes
numberofellipses
The ellipse entry type when pointtype is ellipse: number of ellipses or a list of times.
ellipsetimes
String array
 
Collection of times for polarization ellipses when ellipseentrymethod is listoftimes.
extrasteps
none | specifiedtimes | proportional
proportional
Controls how the number of extra time steps rendered in the trajectory plot is calculated. These extra time steps typically correspond to the exact times of reflections and refractions.
fixedpointsize
Boolean
false
Use constant radii for the plotted spheres.
inheritarrowscale
Boolean
true
If inheritplot is not none: Determines if the arrow scale is inherited.
inheritcolor
Boolean
true
If inheritplot is not none: Determines if the color is inherited.
inheritdeformscale
Boolean
true
If inheritplot is not none: Determines if the deformation scale is inherited.
inheritellipsescale
Boolean
true
If inheritplot is not none: Determines if the ellipse scale factor is inherited.
inheritplot
none | plot name
none
The plot that color, color range, and plot scales are inherited from.
inheritrange
Boolean
true
If inheritplot is not none: Determines if the color and data ranges are inherited.
inheritspherescale
Boolean
true
If inheritplot is not none: Determines if the radius scale factor is inherited.
inherittailscale
Boolean
true
If inheritplot is not none: Determines if the tail scale factor is inherited.
inherittransparency
Boolean
true
If inheritplot is not none: Determines if the transparency settings are inherited.
inherittubescale
Boolean
true
If inheritplot is not none: Determines if the tube radius scale factor is inherited.
interpcount
positive integer
100
Number of interpolated time, when interpolation is set to uniform.
interpolation
none | uniform
none
The type of interpolation used to plot lines when linetype is line or tube.
linecolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
black (2D), red (3D)
The uniform color to use for lines.
linetype
none | line | ribbon | tube
line
Plot ray traces as lines, ribbons, or tubes, or not at all.
logrange
double > 1
100
If arrowlength is logarithmic: The ratio between the maximum arrow length and the arrow length below which no arrow is drawn.
numextrasteps
nonnegative integer
100
If extrasteps is specifiedtimes, controls the maximum number of extra time steps to render in the plot.
pointautoscale
on | off
on
If enabled, the point radii are scaled based on the size of the geometry.
pointcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
red
The uniform color to use for points.
pointlineanim
on | off
off
When animating ray trajectories plots with points, this property indicates whether the points at the current time should appear on top of the lines.
pointradiusexpr
String
0.001
The point radius expression.
pointtype
none | point | comettail | arrow | ellipse
none
Plot particles as points, with comet tails, with arrows, with polarization ellipses (3D only), or not at all.
propextrasteps
nonnegative integer
1
If extrasteps is proportional, controls the maximum number of extra time steps to render in the plot. The maximum number of extra steps is the product of this proportionality factor with the number of solution times.
radiusexpr
String
1
The tube radius expression.
sphereradiusscale
positive double
 
The scale factor applied to the point radii if sphereradiusscaleactive is on.
sphereradiusscaleactive
on | off
off
If on, sphereradiusscale is used; otherwise the scale factor is computed automatically.
solutionparams
manual | parent
manual
If data is a local dataset with nontrivial data, specify solutions manually or take them from the parent plot group.
tailscale
positive double
1
Active when pointtype is set to comettail and tailscaleactive is on. Specifies the manual scale factor with which the comet tail expression is multiplied.
tailscaleactive
on | off
off
Active when pointtype is set to comettail. Specifies whether manual tail scaling is enabled.
title
String
 
Active when title is set to manual. Specifies the plot title.
titletype
automatic | manual | none
automatic
Determines how the plot title is specified.
tuberadiusscale
String
1
The scale factor applied to the tube radii if tuberadiusscaleactive is on.
tuberadiusscaleactive
on | off
off
If on, tuberadiusscale is used; otherwise, the scale factor is computed automatically.
Attributes
Color, Deform, Export, Filter (Particle Tracing, Point Trajectories, Ray Tracing), MaterialAppearance, Translation, Transparency (3D only)
See Also
ParticleTrajectories, PointTrajectories, Ray (Dataset), Ray (1D Plot), Ray (Evaluation)