Directivity
Create a directivity plot. A directivity plot is an extension of far-field plots and is a common acoustic plot for speakers. This plot collects spatial information across frequencies and shows this data as a contour plot.
Directivity plots are available in 1D and 2D plot groups with the Acoustics Module.
Syntax
model.result(<pgtag>).create(<ftag>,"Directivity");
model.result(<pgtag>).feature(<ftag>).set(property, <value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
 model.result(<pgtag>).create(<ftag>,"Directivity") creates a directivity plot feature named <ftag> belonging to the plot group <pgtag>. Directivity plots are available in 2D plot groups.
The following properties are available: 
Table 7-23: Valid Property/Value Pairs for Directivity
Property
Value
Default
Description
anglerestr
manual | none
none
Use no angle restriction or a user-defined start angle and range.
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.
centerz
double
0
z-coordinate for center of evaluation.
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.
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.
colortablerev
on | off
off
Whether to reverse to color table or color gradient when coloring is set to colortable or gradient.
colortablesym
on | off
off
Whether to symmetrize the color range around 0 when coloring is set to colortable or gradient.
const
String array of property/value pairs
Empty
Parameters to use in the expressions.
contourlabels
on | off
off
Whether to display labels next to the contour lines. Only applicable in 2D and if contourtype is lines.
contourtype
lines | filled
lines
Whether to display lines for each level or a surface with bands of color.
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.
customlabelcolor
RGB-triplet
{1,0,0} or last used color.
If contourlabels is on and labelcolor is custom: The label color to use.
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. From parent is only available in 1D.
descr
String
Model-dependent.
The description of the expression in expr. Is used in the automatic title.
descriptionintitle
on | off
on
Whether the title contribution should contain the description when titletype is custom.
differential
on | off
on
Whether the expression should be linearized at the linearization point. Applicable only if evalmethod is harmonic.
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.
expr
String
Model-dependent.
The expression to plot.
expressionintitle
on | off
off
Whether the title contribution should contain the expression when titletype is custom.
filledlegend
on | off
on
Whether to show the color legend as a filled legend.
frequencyscale
logarithmic | linear
logarithmic
Whether to use a logarithmic or linear frequency scale in the plot (2D only).
includeoutside
on | off
on
Fill surfaces outside of contour levels if contourtype is filled.
inheritcolor
Boolean
true
If inheritplot is not none: Determines if the color is inherited.
inheritplot
none | plot name
none
The plot that color is inherited from.
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.
layout
frequencyx | frequencyy
frequencyx
Plot the frequency on the x-axis or on the y-axis.
labelcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
red
If contourlabels is on: The label color to use.
labelprec
positive integer
4
If contourlabels is on: The number of significant digits in the labels.
levelmethod
number | levels
number
How to specify contour levels.
levelrounding
Boolean
true
Round the contour level values, if levelmethod is set to number.
levels
String array
 
The specific levels to plot. Active when levelmethod equals levels.
linewidth
double
1
The line width. Only applicable in 1D and if contourtype is lines.
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.
normal
double array of length 3
{0, 1, 0}
The normal direction for the evaluation.
normalization
angle | max | none
angle
Normalization of the expression values with respect to the angle (the default), with respect to the maximum value, or no normalization.
number
positive integer
20
Total number of contour levels. Active when levelmethod equals number.
outersolnum
nonnegative integer
1
The index of the outer solutions to use. Applicable only for parametric sweep models.
phidisc
integer >= 2
50
The angular discretization (resolution) in the phi direction.
phimin
double
0
If anglerestr is manual: The minimum phi angle in degrees.
phirange
double
360
If anglerestr is manual: The phi angle’s range in degrees.
prefixintitle
String
Empty
Added prefix to contribution to title.
radius
double
1
Radius of evaluation distance.
recover
off | pprint | ppr
off
The derivative recovery method (off, within domains, or everywhere).
refdir
double array of length 3
{0, 0, 1}
The reference direction for the evaluation.
refine
nonnegative integer
1
The element refinement to use, if resolution is set to manual. Bear in mind that this is the refinement used for the base dataset, so the number of elements in the model can increase radically if the plot uses, for example, a revolve dataset.
resolution
norefine | coarse | normal | fine | finer | extrafine | custom
normal
Controls the plot’s resolution. A finer setting results in a higher resolution by modifying the internally computed default refinement. Use custom to enter your own refinement in the refine property.
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.
suffixintitle
String
Empty
Added suffix to contribution to title.
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.
threshold
manual | none
none
Use a smoothing threshold.
thresholdvalue
double
0.1
Threshold value (0-1), if threshold is set to manual.
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 | custom | manual | none
auto
auto if the title contribution should be computed automatically, possibly using the group’s customization. custom if the title contribution should be computed automatically, but customized. 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.
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.
Attributes
None.
See Also
Contour