OctaveBand
Create an Octave Band Plot.
The Octave Band Plot requires a license for the Acoustics Module.
Syntax
model.result(<pgtag>).create(<ftag>,"OctaveBand");
model.result(<pgtag>).feature(<ftag>).set(property, <value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result(<pgtag>).create(<ftag>,"OctaveBand") creates an octave band plot feature named <ftag> belonging to the plot group <pgtag>.
The octave band plots a weighted frequency response in bands (octave or 1/3 octave) or as a continuous frequency response. The frequency can be weighted.
The following properties are available:
Table 7-81: Valid Property/Value Pairs for Octave Band Plots
name
Value
Default
Description
amplref
double
1
Reference level for the amplitude expression type.
bandtype
octave | octave3 | octave6
octave
The band type: octave bands, 1/3 octave bands, or 1/6 octave bands, if quantity is bandtype or bandaveragepsd.
const
String array of property/value pairs
Empty
Parameters to use in the expressions.
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.
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.
expr
String
Model-dependent.
The expression used to transform the input to plot.
expressionintitle
on | off
off
Whether the title contribution should contain the expression when titletype is custom.
exprtype
amplitude | power | transfer
amplitude
Type of expression: amplitude, power, or transfer function.
inband
on | off
on
Whether to use in-band data only.
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.
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.
legends
String array
The last computed automatic legends.
Manual legends active when legendmethod is set to manual.
levelref
double
0
Reference level for the transfer function expression type.
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
0.5
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.
linestyle
none | cycle | solid | dotted | dashed | dashdot
solid
The line style, if any. Cycle indicates that the line style 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.
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.
powerref
double
1
Reference level for the power expression type.
prefixintitle
String
Empty
Added prefix to contribution to title
quantity
continuous | bandpower | bandaveragepsd
bandaveragepsd
The quantity to plot: a continuous power spectral density (PSD), the band power, or the band average PSD
sdim
fromdataset | 0 | 1 | 2 | 3
fromdataset
The space dimension to evaluate the underlying dataset in
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.
suffixintitle
String
Empty
Added suffix to contribution to title
title
String
The auto-title.
The title to use when titletype is manual
titletype
auto | custom | label | manual | none
auto
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.
type
bar | outline | line
bar
Use a filled histogram (bar), a histogram drawn using lines (outline), or a graph connecting the centerpoints of the bands (line). This property is only available when function is discrete.
typeintitle
on | off
on
Whether the title contribution should contain the type when titletype is custom.
weightexpr
expression
 
Value or expression to use as weighting.
weighting
a | c | z | expression
z
Weighting function for octave band plot: A-weighting, C-weighting, Z-weighting, or a user-defined expression.