Polarization
Create a polarization plot to visualize the polarization state for diffraction orders, simulated for periodic structures.
The Polarization plot requires a license for the RF Module or Wave Optics Module.
Syntax
model.result(<pgtag>).create(<ftag>,"Polarization");
model.result(<pgtag>).feature(<ftag>).selection(...);
model.result(<pgtag>).feature(<ftag>).set(property,<value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result(<pgtag>).create(<ftag>,"Polarization") creates a polarization plot feature named <ftag> belonging to the plot group <pgtag>.
A polarization plot is used to visualize the polarization state using polarization ellipses. Polarization plots can be added to 1D plot groups.
The following properties are available:
Table 7-116: Valid Properties for Polarization.
name
Value
Default
Description
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.
centerpos
auto | user
auto
The center position for the polarization ellipses. If set to user, enter the center position’s components using the xcenter and ycenter properties.
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.
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.
differential
on | off
on
Whether the expression should be linearized at the linearization point. Applicable only if evalmethod is harmonic.
display
none | manual | model dependent
model dependent
What to display as polarization ellipses. If you choose manual, enter the expression’s components using the xexpr and yexpr properties.
evalmethod
linpoint | harmonic | lintotal | lintotalavg | lintotalrms | lintotalpeak
harmonic
Applicable only for solutions with a stored linearization point. Controls if the linearization point, the perturbation, or a combination should be used when evaluating the expression.
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.
legendprefix
String
 
A prefix added to the automatic legend.
legends
String array
The last computed automatic legends
Manual legends active when legendmethod is set to manual.
legendsuffix
String
 
A suffix added to the automatic legend.
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 colors 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.
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.
linestyle
none | cycle | solid | dotted | dashed | dashdot
solid
The line style, if any. Cycle indicates that the line style is different for each line.
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.
scale
double
1
The scaling of the polarization ellipses.
showrotdir
true | false
true
Whether to show the direction of rotation.
solnum
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.
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 | label | manual | none
auto
auto, if the title should be computed automatically. 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.
xcenter
String
0
The x-coordinate for the center position, when centerpos is set to user.
xexpr
String
Model dependent
The x-coordinate for the polarization ellipses, when display is set to manual.
ycenter
String
0
The y-coordinate for the center position, when centerpos is set to user.
yexpr
String
Model dependent
The y-coordinate for the polarization ellipses, when display is set to manual.
Attribute
Color
See Also
LineGraph