pzoptions

Create list of pole/zero plot options

collapse all in page

Syntax

P = pzoptions
P = pzoption('cstprefs')

Description

P = pzoptions returns a list of available options for pole/zero plots (pole/zero, input-output pole/zero and root locus) with default values set.. You can use these options to customize the pole/zero plot appearance from the command line.

P = pzoption('cstprefs') initializes the plot options with the options you selected in the Control System and System Identification Toolbox Preferences Editor. For more information about the editor, see Toolbox Preferences Editor.

This table summarizes the available pole/zero plot options.

OptionDescription
Title, XLabel, YLabelLabel text and style
TickLabelTick label style
Grid Show or hide the grid, specified as one of the following values: 'off' | 'on'
Default: 'off'
GridColorColor of the grid lines, specified as one of the following: Vector of RGB values in the range [0,1]| character vector of color name |'none'. For example, for yellow color, specify as one of the following: [1 1 0], 'yellow', or 'y'.
Default: [0.15,0.15,0.15]
XlimMode, YlimMode Limit modes
Xlim, YlimAxes limits
IOGrouping Grouping of input-output pairs, specified as one of the following values: 'none' |'inputs'|'outputs'|'all'
Default: 'none'
InputLabels, OutputLabels Input and output label styles
InputVisible, OutputVisibleVisibility of input and output channels
FreqUnits

Frequency units, specified as one of the following values:

  • 'Hz'

  • 'rad/second'

  • 'rpm'

  • 'kHz'

  • 'MHz'

  • 'GHz'

  • 'rad/nanosecond'

  • 'rad/microsecond'

  • 'rad/millisecond'

  • 'rad/minute'

  • 'rad/hour'

  • 'rad/day'

  • 'rad/week'

  • 'rad/month'

  • 'rad/year'

  • 'cycles/nanosecond'

  • 'cycles/microsecond'

  • 'cycles/millisecond'

  • 'cycles/hour'

  • 'cycles/day'

  • 'cycles/week'

  • 'cycles/month'

  • 'cycles/year'

Default: 'rad/s'

You can also specify 'auto' which uses frequency units rad/TimeUnit relative to system time units specified in the TimeUnit property. For multiple systems with different time units, the units of the first system are used.

TimeUnits

Time units, specified as one of the following values:

  • 'nanoseconds'

  • 'microseconds'

  • 'milliseconds'

  • 'seconds'

  • 'minutes'

  • 'hours'

  • 'days'

  • 'weeks'

  • 'months'

  • 'years'

Default: 'seconds'

You can also specify 'auto' which uses time units specified in the TimeUnit property of the input system. For multiple systems with different time units, the units of the first system is used.

ConfidenceRegionNumberSD

Number of standard deviations to use when displaying the confidence region characteristic for identified models (valid only iopzplot).

Examples

collapse all

Open Live Script

Create a default option set for root locus plots.

opt = pzoptions;

In the plot options, specify the grid as visible.

opt.Grid = 'on';

Use the specified options to plot the root locus of a transfer function.

 h = rlocusplot(tf(1,[1,.2,1,0]),opt);

The root locus plot is generated with the grid enabled.

See Also

| | |

Introduced in R2008a

Control System Toolbox Documentation

Support