Ray (1D Plot)
Create a ray plot, which plots ray properties over time or compares ray properties against each other at a set of time steps.
Syntax
model.result(<pgtag>).create(<ftag>,"Ray1D");
model.result(<pgtag>).feature(<ftag>).set(property,<value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result(<pgtag>).create(<ftag>,"Ray1D") creates a ray plot feature named <ftag> belonging to the plot group <pgtag>.
With the ray plot, you can plot properties of all rays in a dataset versus time, or plot two ray properties against each other at a set of selected times. When plotting ray properties versus time, it is possible to apply data series operations to the ray data. The ray plot is available in 1D plot groups.
The following properties are available:
Table 7-119: Valid Properties for Ray Plots.
name
Value
Default
Description
autodescr
true | false
Model dependent
Whether the automatic legends should include the expression descriptions.
autoexpr
true | false
Model dependent
Whether the automatic legends should include the expressions.
autoplotlabel
true | false
false
Whether the automatic legends should include the plot label.
autosolution
true | false
true
Whether the automatic legends should include the solution.
autounit
true | false
false
Whether the automatic legends should include the unit.
colorcycle
default | long
default
The color cycle, when linecolor is set to cycle. With default, it contains 7 colors; with long, it contains 19 colors.
const
String array of property/value pairs
Empty
Parameters to use in the expressions.
customlinecolor
RGB-triplet
{0,0,1} or last used edgecolor
The color to use for the lines. Active when linecolor is set to custom.
data
none | parent | dataset name
parent
The dataset this feature refers to.
dataseries
none | average | sum | maximum | minimum | rms | stddev | variance
sum
The data series operation that is applied to all rays. Effective only when xdata is not expr.
descr
String array
Model dependent
The description of the expressions in expr. Is used in the automatic legends.
descriptionintitle
on | off
on
Whether the title contribution should contain the description when titletype is custom.
expr
String array
Model dependent
The expressions to plot.
expressionintitle
on | off
off
Whether the title contribution should contain the expression when titletype is custom.
innerinput
all | first | last | manual | manualindices | interp
all
How to input the solution to use. manual indicates that solnum is used. manualindices indicates that solnumindices is used. interp indicates that t is used.
interp
double row matrix
Empty on all levels.
The times to use, for transient levels. Available when data is not parent and the underlying data is transient.
legend
on | off
off
Whether to show legends.
legendexprprecision
positive integer
3
The precision for the evaluated expression when legendmethod is set to evaluated.
legendmethod
automatic | manual | evaluated
automatic
Whether to use the automatic legends or the legends added manually or evaluated.
legendpattern
String
 
A legend string to be evaluated when legendmethod is set to evaluated.
legends
String array
The last computed automatic legends.
Manual legends active when legendmethod is set to manual.
linecolor
custom | cycle | black | blue | cyan | gray | green | magenta | red | white | yellow
cycle
How to color the lines in the graph. Cycle indicates that the color is different for each line.
linewidth
double | preference
1
The line width.
linemarker
none | cycle | asterisk | circle | diamond | plus | point | square | star | triangle
none
The line markers, if any. Cycle indicates that the marker is different for each line.
linestyle
none | cycle | solid | dotted | dashed | dashdot
solid
The line style, if any. Cycle indicates that the line style is different for each line.
looplevel
integer row matrix
All solutions on all levels
The solutions to use, per level
looplevelindices
integer row matrix
Empty
An alternative way to specify the solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when looplevelinput is manualindices on a level.
looplevelinput
String array with all | first | last | manual | manualindices | interp on each level
all on all levels
How to input the solution to use, per level. manual on a level indicates that looplevel is used on that level. manualindices on a level indicates that looplevelindices is used on that level. interp on a level indicates that interp is used on that level.
markerpos
interp | datapoints
interp
Controls whether the positions of the markers are in the data points of the plot, or interpolated depending on the number (set in markers). Markers are visible when linemarker is set.
markers
integer
8
The number of markers to show. Markers are visible when linemarker is set.
outerinput
all | first | last | manual | manualindices
all
How to input the outer solutions to use. Applicable only for parametric sweep models. manual indicates that outersolnum is used. manualindices indicates that outersolnumindices is used.
outersolnum
nonnegative integer array
1
The index of the outer solutions to use. Applicable only for parametric sweep models. Since the various outer solutions can have different number of solnum, the solnum property is not used.
outersolnumindices
String or integer array
Empty
An alternative way to specify the outer solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when outerinput is manualindices.
prefixintitle
String
Empty
Added prefix to contribution to title.
solnum
nonnegative integer array
All solutions
The solutions to plot. Available when data is not parent and the underlying data has multiple solutions.
solnumindices
String or integer array
Empty
An alternative way to specify the solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when innerinput is manualindices.
solrepresentation
solnum | solutioninfo
solutioninfo
Indicates which method of selecting solutions is active.
solutionparams
manual | parent
manual
If data is a local dataset with nontrivial data, specify solutions manually or take them from the parent plot group.
suffixintitle
String
Empty
Added suffix to contribution to title.
t
double array
Empty
The times to plot. Available when data is not parent and the underlying solution is transient.
title
String
The auto-title.
The title to use when titletype is manual.
titletype
auto | custom | label | manual | none
auto
auto, if the title should be computed automatically. custom, if the title should be computed automatically, but customized. label, if the title should be the plot group’s label. manual, if the manual title should be used (the title property). none, if no title should be displayed.
typeintitle
on | off
on
Whether the title contribution should contain the type when titletype is custom.
unit
String
Model dependent
The unit to use for the expression in expr. If the old unit is not valid when the expression changes, the unit property is reset to default.
unitintitle
on | off
on
Whether the title contribution should contain the unit when titletype is custom.
xdata
expr | solution
solution
x-axis data. expr uses the expression in xdataexpr. solution uses the available solutions in the underlying dataset, such as time steps.
xdataexpr
String
Model dependent
Expression for x-axis data.
xdatadescr
String
Model dependent
Description of expression in xdataexpr.
xdataphaseunit
String
rad
The unit in which xdataphaserange is described.
xdatasolnumtype
all | inner | outer | valid level
outer
Whether the expression should be evaluated for every inner or every outer solution, or for a specific level (level1, level2, and so on). Applicable only for models containing multiple levels.
xdataunit
String
Model dependent
The unit to use for the expression in xdataexpr. If the old unit is not valid when the expression changes, the unit property is reset to default.
Attributes
Color (applies to lines), Global (Numerical)
See Also
Ray (Evaluation), RayTrajectories, RayBin