Documentation Center

  • Trials
  • Product Updates

sigmaoptions

Create list of singular-value plot options

Syntax

P = sigmaoptions
P = sigmaoptions('cstprefs')

Description

P = sigmaoptions returns a list of available options for singular value plots with default values set. You can use these options to customize the singular value plot appearance from the command line.

P = sigmaoptions('cstprefs') initializes the plot options with the options you selected in the Control System Toolbox™ Preferences Editor. For more information about the editor, see Toolbox Preferences Editor in the User's Guide documentation.

This table summarizes the sigma plot options.

Option Description
Title, XLabel, YLabel Label text and style
TickLabelTick label style
Grid Show or hide the grid
Specified as one of the following strings: 'off' | 'on'
Default: 'off'
XlimMode, YlimModeLimit modes
Xlim, Ylim Axes limits
IOGrouping Grouping of input-output pairs
Specified as one of the following strings: 'none' |'inputs'|'output'|'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 strings:

  • '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.

FreqScaleFrequency scale
Specified as one of the following strings: 'linear' | 'log'
Default: 'log'
MagUnits Magnitude units
Specified as one of the following strings: 'dB' | 'abs'
Default: 'dB'
MagScale Magnitude scale
Specified as one of the following strings: 'linear' | 'log'
Default: 'linear'

Examples

In this example, set the frequency units to Hz before creating a plot.

P = sigmaoptions; % Set the frequency units to Hz in options 
P.FreqUnits = 'Hz'; % Create plot with the options specified by P
h = sigmaplot(rss(2,2,3),P);      

The following singular value plot is created with the frequency units in Hz.

See Also

| |

Was this topic helpful?