ImpulseResponse
Create an impulse response plot for 1D plot groups. This plot type requires the Acoustics Module.
Syntax
model.result(<pgtag>).create(<ftag>,"ImpulseResponse");
model.result(<pgtag>).feature(<ftag>).set(property,<value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result(<pgtag>).create(<ftag>,"ImpulseResponse") creates an impulse response plot feature named <ftag> belonging to the plot group <pgtag>.
Impulse response plots are primarily used for postprocessing of acoustics simulations. Impulse response plots can be added to 1D plot groups.
The following properties are available:
Table 7-60: Valid Properties for Impulse Response Plots.
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.
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.
dbmanualref
double
0
Reference value for display in dB, if dbref is manual (and indb is true).
dbref
maximum | manual
maximum
Use the maximum value of a manual value as the dB reference when indb is true.
dbtype
10log | 20log
10log
Use a 10 log or 20 log for the dB values when indb is true.
density
String
 
The density of the frequency expression.
descriptionintitle
on | off
on
Whether the title contribution should contain the description when titletype is custom.
expressionintitle
on | off
off
Whether the title contribution should contain the expression when titletype is custom.
fouriershow
real | imaginary | amplitude | phase | spectrum
amplitude
When transform is fourier: Show the DFT as real or imaginary part, amplitude, phase, or frequency spectrum.-
freqmax
integer
 
If fouriershow is spectrum and freqrangeactive is true: The upper frequency bound.
freqmin
integer
 
If fouriershow is spectrum and freqrangeactive is true: The lower frequency bound.
freqrangeactive
true | false
false
If fouriershow is spectrum: Controls whether a manual frequency range is used.
frequency
String
 
The frequency expression.
freqtype
octave | octave3 | octave6
octave
The frequency interpretation: octave, 1/3 octave, or 1/6 octave.
ignorelast
true | false
true
If fouriershow is not spectrum: ignore last sample.
indb
true | false
false
Display the amplitude or frequency spectrum in dB when fouriershow is amplitude or spectrum.
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.
linestyle
none | cycle | solid | dotted | dashed | dashdot
solid
The line style, if any. Cycle indicates that the line style is different for each line.
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.
maskdc
true | false
false
If fouriershow is not spectrum: set the DC value (zero frequency component) to zero.
movingaverage
true | false
false
If transform is fourier: Compute a moving average if set to true.
n
integer
1
If type is octave: The number for the denominator in a fractional octave band.
nfreqs
integer
1
If fouriershow is spectrum and nfreqsactive is true: The number of frequencies to plot.
nfreqsactive
true | false
false
If fouriershow is spectrum: Controls whether the number of frequencies is set manually.
nsamples
integer
1
If fouriershow is not spectrum and nsamplesactive is true: The number of uniform samples to use.
nsamplesactive
true | false
false
If fouriershow is not spectrum: Controls whether the number of uniform samples is set manually.
prefixintitle
String
 
Added prefix to contribution to title.
power
String
 
The power of the frequency expression.
ripplefactor
double
0.05
The ripple factor.
scale
none | multiplyperiod | dividenfreq
none
If fouriershow is spectrum, use no scaling, multiply by sampling period, or divide by number of frequencies.
scaleperiod
true | false
true
If fouriershow is not spectrum: scale with sampling period.
shiftzero
true | false
true
If fouriershow is not spectrum: shift zero frequency.
solnum
nonnegative 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.
soundspeed
String
 
The speed of sound.
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.
transform
none | fourier
none
Transformation of x-axis date.
type
linear | octave
linear
If movingaverage is true: Use a linear or 1/n octave moving average.
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
Color, EnergyDecay
See Also
LineGraph