Spot Diagram

Create a spot diagram plot.

Syntax

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

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

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

model.result(<pgtag>).feature(<ftag>).runCommand("createFocalPlaneDataset");

model.result(<pgtag>).feature(<ftag>).runCommand("recomputeFocalPlaneDataset");

Description

model.result(<pgtag>).create(<ftag>,"SpotDiagram") creates a Spot Diagram plot named <ftag> belonging to the plot group <pgtag>.

A Spot Diagram can be added to a 2D Plot Group but the associated dataset must either be a Ray dataset solved for in a 3D model component, or an Intersection Point 3D dataset.

The following properties are available:

Table 7-132: Valid Property/Value Pairs for Phase Portrait
name	Value	Default	Description
additionallogical- -expression	String	1	Additional logical expression that must be nonzero for rays to be included in the plot.
additionallogical- -expressionactive	on \| off	off	If on, activates an additional logical expression for including rays in the plot.
arrangement	release \| wavelength \| single	release	Controls how the rays are sorted before plotting, possibly by grouping them into separate spots.
circleactive	on \| off	off	If on, draw a circle at the origin of the spot diagram.
circleradiusexpr	String	1[um]	Radius of the circle to be plotted at the origin, if circleactive is on.
columns	positive integer	3	Maximum number of vertical columns of spots. Used if layout is rectangular.
data	none \| parent \| dataset name	parent	The dataset this feature refers to.
distribution	equalnumber \| equalwidth	equal- -number	Used when sorting rays by wavelength into a specified number of intervals. Determines how the interval endpoints are calculated.
filterrelease	positive integer	1	Index of the release feature of rays to plot if filterreleaseactive is on.
filterreleaseactive	on \| off	off	If on, filter rays by release feature to determine which rays appear in the plot.
filterwavelength	String	632.8[nm]	Wavelength of rays to plot if filterwavelengthactive is on.
filterwavelengthactive	on \| off	off	If on, filter rays by wavelength to determine which rays appear in the plot.
filterwavelengthtol	String	1[nm]	Numerical tolerance for filtering rays by wavelength if filterwavelengthactive is on.
fitannotationstospot	on \| off	off	If on, move text closer to some spots in the array when the spots have unequal sizes.
layout	automatic \| rectangular	automatic	Method for positioning multiple spots in the Graphics window, if arrangement is release or wavelength.
limits	String		Limits of intervals for sorting spots by wavelength.
origin	rays \| area	rays	Determines how the center of each spot is determined when positioning it relative to other spots, if arrangement is release or wavelength.
method	limits \| number \| tolerance	tolerance	Method for sorting rays by wavelength. Used if arrangement is wavelength.
normal	directionbased \| positionbased \| userdefined	direction--based	Determines how the normal direction to the plane is calculated.
normalexpr	String array of length 3	{0,0,1}	Expression for the normal direction to the surface, active if normal is userdefined.
number	positive integer	10	Number of wavelength intervals. Used when sorting rays by wavelength if method is number.
numberofreflections	nonnegative integer	0	Rays that have reflected the specified number of times will be included in the plot. Used if numberofreflectionsactive is on.
numberofreflectionsactive	on \| off	off	If on, activates the filtering of rays based on number of reflections.
paddinghoriz	double	0.5	Padding factor for horizontal spacing between spots, if arrangement is release or wavelength.
paddingvert	double	0.5	Padding factor for vertical spacing between plots, if arrangement is release or wavelength.
pointcolor	custom \| black \| blue \| cyan \| gray \| green \| magenta \| red \| white \| yellow	red	The uniform color to use for points.
posexpr	String array of length 2	{0,0}	Expressions for the spot diagram origin location in local coordinates.
showframe	on \| off	off	If on, draw a box around each text annotation in the Graphics window. Applies to every type of annotation.
spotcoordsactive	on \| off	off	If on, show a text annotation for the coordinates of the center of each spot.
spotcoordsposition	above \| below	above	Position of the annotations for spot coordinates, if spotcoordsactive is on.
spotcoordsprecision	positive integer	3	Numerical precision of the annotations for spot coordinates, if spotcoordsactive is on.
spotcoordssystem	local \| global	local	Coordinate system to use when displaying annotations for spot coordinates, if spotcoordsactive is on.
spotcoordsunit	length unit	mm	Length unit used in the annotations for spot coordinates, if spotcoordsactive is on.
spotsizeactive	on \| off	on	If on, show a text annotation for the RMS spot size next to every spot.
spotsizeposition	above \| below	above	Position of the annotations for RMS spot size, if spotsizeactive is on.
spotsizeprecision	positive integer	3	Numerical precision of the annotations for RMS spot size, if spotsizeactive is on.
spotsizeunit	length unit	um	Length unit of the annotations for RMS spot size, if spotsizeactive is on.
tolerance	String	1[nm]	Tolerance for sorting rays by wavelength.
transverse	automatic \| user defined	automatic	Determines how the transverse direction in the plane is calculated.
transverseexpr	String array of length 3	{1,0,0}	Transverse direction in the surface if transverse is userdefined.
wavelengthactive	on \| off	off	If on, show a text annotation for the vacuum wavelength next to every spot.
wavelengthposition	above \| below	below	Position of the annotations for wavelength, if wavelengthactive is on.
wavelengthprecision	positive integer	4	Numerical precision of the annotations for wavelength, if wavelengthactive is on.
wavelengthunit	length unit	nm	Length unit of the annotations for wavelength, if wavelengthactive is on.

Attributes

Color