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: 
manual | none
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
custom | black | blue | cyan | gray | green |magenta | red | white | yellow
colortable | uniform | gradient
on | off
linear | linearsymmetric | logarithmic
The color table to use when coloring is set to colortable. See Color Tables for a list of color tables.
none | reverse | nonlinear | nonlinearsymmetric
Transformation of the color table, when coloring is set to colortable or gradient.
on | off
lines | filled
{1,0,0} or last used color.
The uniform color to use. Active when bottomcolor is set to custom.
{1,0,0} or last used color.
{1,0,0} or last used color.
{1,0,0} or last used color.
The uniform color to use. Active when topcolor is set to custom.
none | parent | dataset name
The dataset this feature refers to. From parent is only available in 1D.
The description of the expression in expr. Is used in the automatic title.
on | off
on | off
linpoint | harmonic | lintotal | lintotalavg | lintotalrms | lintotalpeak
on | off
on | off
logarithmic | linear
on | off
If inheritplot is not none: Determines if the color is inherited.
none | plot name
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.
frequencyx | frequencyy
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
If contourlabels is on: The label color to use.
If contourlabels is on: The number of significant digits in the labels.
number | levels
Round the contour level values, if levelmethod is set to number.
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.
on | 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.
angle | max | none
If anglerestr is manual: The minimum phi angle in degrees.
If anglerestr is manual: The phi angle’s range in degrees.
off | pprint | ppr
{0, 0, 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.
norefine | coarse | normal | fine | finer | extrafine | custom
The index of the solution to use. Available when data is not parent and the underlying data has multiple solutions.
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 time to use, for transient problems. Available when data is not parent and the underlying data is transient.
manual | none
Threshold value (0-1), if threshold is set to manual.
on | off
on if t is used to determine time steps; off if solnum is used.
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
Attributes
None.
See Also
Contour (Plot)