getoptions

(Not recommended) Get options for linear analysis plot object

getoptions is not recommended. Set plot options by accessing chart object properties using dot notation. For more information, see Version History.

getoptions is still recommended for idplot and spectrumplot. For more information, see getoptions (System Identification Toolbox).

Syntax

opts = getoptions(plotobj)

optValue = getoptions(plotobj,option)

Description

opts = getoptions(plotobj) returns the options for the plot associated with linear analysis chart object plotobj.

• You can use opts when creating new plots of the same type as plotobj.

• To customize an existing plot, you can modify opts and then use the resulting options object with setoptions.

optValue = getoptions(plotobj,option) returns the specified option, option, for the plot associated with chart object plotobj.

Examples

Impulse Plot with Specified Grid Color

For this example, consider a MIMO state-space model with 3 inputs, 3 outputs and 3 states. Create an impulse plot with red colored grid lines.

Create the MIMO state-space model sys_mimo.

J = [8 -3 -3; -3 8 -3; -3 -3 8];
F = 0.2*eye(3);
A = -J\F;
B = inv(J);
C = eye(3);
D = 0;
sys_mimo = ss(A,B,C,D);
size(sys_mimo)

Create an impulse plot with plot handle h and use getoptions for a list of the options available.

h = impulseplot(sys_mimo)

p = getoptions(h)

Use setoptions to update the plot with the required customization.

setoptions(h,'Grid','on','GridColor',[1 0 0]);

The impulse plot automatically updates when you call setoptions. For MIMO models, impulseplot produces a grid of plots, each plot displaying the impulse response of one I/O pair.

Input Arguments

plotobj — Plot

chart object

Plot, specified as one of the following chart objects.

Chart Object	Description
impulseplot	Impulse response
initialplot	Initial condition response
lsimplot	Simulated time response to arbitrary inputs
stepplot	Step plot
bodeplot	Frequency response plot
nicholsplot	Nichols plot
nyquistplot	Nyquist plot
sigmaplot	Singular value plot
pzplot	Impulse plot
iopzplot	Pole-zero map for input-output pairs
rlocusplot	Root locus plot
hsvplot	Hankel singular values plot

option — Option name

string | character vector

Option name, specified as a string or character vector. To see the supported options for a specific plot type, see the corresponding option object page indicated in opts.

Output Arguments

opts — Plot options

plot option object

Plot options, returned as one of the following plot option objects depending on the chart object specified in plotobj.

Option Object	plotobj Type
timeoptions	impulseplot initialplot lsimplot stepplot
bodeoptions	bodeplot
nicholsoptions	nicholsplot
nyquistoptions	nyquistplot
sigmaoptions	sigmaplot
pzoptions	iopzplot pzplot rlocusplot
hsvoptions	hsvplot

optValue — Options value

scalar | vector | character vector | logical value | structure | cell array

Option value, returned as a scalar, vector, character vector, logical value, structure, or cell array depending on the option specified in option.

Alternative Functionality

You can also obtain property values of linear analysis plot objects using dot notation. For example, obtain the phase units for a Bode plot.

bp = bodeplot(sys);
phaseUnits = bp.PhaseUnits;

Version History

Introduced before R2006a

R2024b: Not recommended

getoptions is not recommended. Obtain plot options by accessing chart object properties using dot notation. getoptions continues to work.

This table shows some typical usages of getoptions and how to update your code to access chart object properties instead. Some chart object property names do not match the corresponding option name for getoptions.

If your code has this form:	Use this code instead:
bp = bodeplot(sys); phaseUnits = getoptions(bp,"PhaseUnits");	bp = bodeplot(sys); phaseUnits = bp.PhaseUnits;
bp = bodeplot(sys); phaseUnits = getoptions(bp,"FreqScale");	bp = bodeplot(sys); phaseUnits = bp.FrequencyScale;