InterferencePattern

InterferencePattern

Plot the interference pattern resulting from the intersection of rays with a cut plane.

model.result(<pgtag>).create(<ftag>,"InterferencePattern");

model.result(<pgtag>).feature(<ftag>).selection(...);

model.result(<pgtag>).feature(<ftag>).set(property,<value>);

model.result(<pgtag>).feature(<ftag>).run();

model.result(<pgtag>).create(<ftag>,"InterferencePattern") creates an interference pattern plot feature named <ftag> belonging to the plot group <pgtag>. The interference pattern plot is used to visualize the interference of multiple rays as they intersect a cut plane. Interference pattern plots can be added to 2D plot groups.

The following properties are available:

Table 7-61: Valid Properties for Interference Pattern Plots.
Property	Value	Default	Description
bottomcolor	custom \| black \| blue \| cyan \| gray \| green \| magenta \| red \| white \| yellow	black	The bottom color to use for a color gradient. Active when coloring is gradient.
color	custom \| black \| blue \| cyan \| gray \| green \| magenta \| red \| white \| yellow	red	The uniform color to use. Active when coloring is uniform.
coloring	colortable \| uniform \| gradient	colortable	How to color the plot: using a color table, a uniform color, or a color gradient.
colorlegend	on \| off	on	Whether to show color legend, when coloring is set to colortable.
colorscalemode	linear \| linearsymmetric \| logarithmic	linear	Scaling of the color table: linear, linear symmetric around 0, or logarithmic, when coloring is set to colortable or gradient.
colortable	color table name	Rainbow	The color table to use when coloring is set to colortable. See Color Tables for a list of color tables.
colortabletrans	none \| reverse \| nonlinear \| nonlinearsymmetric	none	Transformation of the color table, when coloring is set to colortable or gradient.
custombottomcolor	RGB-triplet	{1,0,0} or last used color	The uniform color to use. Active when bottomcolor is set to custom.
customcolor	RGB-triplet	{1,0,0} or last used color	The uniform color to use. Active when color is set to custom.
customtopcolor	RGB-triplet	{1,0,0} or last used color	The uniform color to use. Active when topcolor is set to custom.
data	none \| parent \| dataset name	parent	The dataset this feature refers to.
inheritcolor	Boolean	true	If inheritplot is not none: Determines if the color is inherited.
inheritplot	none \| plot name	none	The plot that color and color range are inherited from.
inheritrange	Boolean	true	If inheritplot is not none: Determines if the color and data ranges are inherited.
interp	double array	Time corresponding to last selected solnum for transient levels	The time to use, for transient levels. Available when data is not parent and the underlying data is transient.
looplevel	array of nonnegative integers and strings	Last solution for transient or parametric solution for each level. Otherwise, first solution for each level.	The index of the solution to use, per level, or interp, but only for transient solutions. Available when data is not parent and the underlying data has multiple solutions.
nonlinearcolortablerev	on \| off	off	Whether to reverse to color table or gradient when coloring is set to colortable or gradient and colortabletrans is set to nonlinear or nonlinearsymmetric.
originspec	manual \| index \| intensity	manual	Determines how the origin of the interference plot is defined.
originx	double	0	If originspec is manual, determines the x-coordinate of the origin.
originy	double	0	If originspec is manual, determines the y-coordinate of the origin.
originz	double	0	If originspec is manual, determines the z-coordinate of the origin.
outersolnum	nonnegative integer	1	The index of the outer solutions to use. Applicable only for parametric sweep models.
rangecoloractive	on \| off	off	Whether to use the manual color range specified in rangecolormin and rangecolormax. The color range specifies the minimum and maxim value in the plotted colors. Default is the minimum and maximum data values.
rangecolormax	double	Plot dependent	The maximum color range value. Active when rangecoloractive is on.
rangecolormin	double	Plot dependent	The minimum color range value. Active when rangecoloractive is on.
rangedatactive	on \| off	off	Whether to use the manual data range specified in rangedatamin and rangedatamax. Values outside the data range is not plotted.
rangedatamax	double	Plot dependent	The maximum data value. Active when rangedataactive is on.
rangedatamin	double	Plot dependent	The minimum data value. Active when rangedataactive is on.
rangexactive	on \| off	off	Whether to use a manual range of x-coordinates for the grid points.
rangexmax	double	Plot dependent	The maximum x-coordinate in the local coordinate system of the interference pattern plot. Active when rangexactive is on.
rangexmin	double	Plot dependent	The minimum x-coordinate in the local coordinate system of the interference pattern plot. Active when rangexactive is on.
rangeyactive	on \| off	off	Whether to use a manual range of y-coordinates for the grid points.
rangeymax	double	Plot dependent	The maximum y-coordinate in the local coordinate system of the interference pattern plot. Active when rangeyactive is on.
rangeymin	double	Plot dependent	The minimum y-coordinate in the local coordinate system of the interference pattern plot. Active when rangeyactive is on.
rayindex	int	1	The index of the ray used to define the location of the origin of the interference pattern plot. The origin is located at the intersection of the specified ray with the cut plane. Active when originspec is index.
solnum	nonnegative integer	Last solution for transient or parametric solution. Otherwise, first solution.	The index of the solution to use. Available when data is not parent and the underlying data has multiple solutions.
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.
t	double	Time corresponding to last selected solnum.	The time to use, for transient problems. Available when data is not parent and the underlying data is transient.
timeinterp	on \| off	off	on if t is used to determine time steps; off if solnum is used.
title	String	The auto-title.	The title to use when titletype is manual.
titletype	auto \| manual \| none	auto	auto, if the title contribution should be computed automatically, possibly using the group’s customization. manual, if the manual title contribution should be used (the title property). none, if no title contribution should be used.
topcolor	custom \| black \| blue \| cyan \| gray \| green \| magenta \| red \| white \| yellow	white	The top color to use for a color gradient. Active when coloring is gradient.
xyresolution	int	200	The number of grid points in each direction to use when rendering the interference pattern. Cannot be greater than 1000.