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:
true | false
true | false
true | false
true | false
true | false
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
default | long
The color cycle, when linecolor is set to cycle. With default, it contains 7 colors; with long, it contains 19 colors.
The color table to use when linecolor is set to cyclecolortable. See Color Tables for a list of color tables.
Parameters to use in the expressions as an N‑by‑3 matrix containing name, value, and description. Only parameters provided by the physics interfaces in the model can be set.
{1,0,0} or last used color
The uniform color to use. Active when bottomcolor is set to custom.
{0,0,1} or last used edgecolor
{1,0,0} or last used color
The uniform color to use. Active when topcolor is set to custom.
auto | manual
The length of color cycle when linecolor is cyclegradient.
none | parent | dataset name
none | average | sum | maximum | minimum | rms | stddev | variance
The description of the expressions in expr. Is used in the automatic legends.
on | off
on | off
all | first | last | manual | manualindices | interp
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.
The times to use, for transient levels. Available when data is not parent and the underlying data is transient.
on | off
The precision for the evaluated expression when legendmethod is set to evaluated.
automatic | manual | evaluated
A legend string to be evaluated when legendmethod is set to evaluated.
Manual legends active when legendmethod is set to manual.
custom | cycle | cyclereset | cyclecolortable | cyclegradient | fromtheme | black | blue | cyan | gray | green | magenta | red | white | yellow
How to color the lines in the graph. Cycle indicates that the colors is different for each line. Use cyclereset to restart the cycling of colors from the first color. Use fromtheme to take the color from the selected color theme.
double | preference
none | cycle | asterisk | circle | diamond | plus | point | square | star | triangle
none | cycle | solid | dotted | dashed | dashdot
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.
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.
interp | datapoints
all | first | last | manual | manualindices
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.
The solutions to plot. Available when data is not parent and the underlying data has multiple solutions.
An alternative way to specify the solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when innerinput is manualindices.
solnum | solutioninfo
manual | parent
If data is a local dataset with nontrivial data, specify solutions manually or take them from the parent plot group.
The times to plot. Available when data is not parent and the underlying solution is transient.
The title to use when titletype is manual.
auto | custom | label | manual | none
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.
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
on | off
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.
on | off
expr | solution
x-axis data. expr uses the expression in xdataexpr. solution uses the available solutions in the underlying dataset, such as time steps.
The unit in which xdataphaserange is described.
all | inner | outer | valid level
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.
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