Main Content

hsvoptions

Create list of Hankel singular value plot options

expand all in page

    Description

    Use the hsvoptions command to create an HSVOptions object to customize your Hankel singular value (HSV) plot appearance. Use this object to customize the appearance of an HSV plot created using hsvplot and override the plot preferences for the MATLAB® session in which you create the HSV plot.

    The options you specify for an HSVOptions object correspond to properties of an HSVPlot chart object.

    Creation

    Syntax

    plotoptions = hsvoptions
    plotoptions = hsvoptions("cstprefs")

    Description

    plotoptions = hsvoptions returns a default set of plot options for use with hsvplot. You can use these options to customize the HSV plot appearance using the command line. This syntax is useful when you want to write a script to generate plots that look the same regardless of the preference settings of the MATLAB session in which you run the script.

    example

    plotoptions = hsvoptions("cstprefs") initializes the plot options with the options you selected in the Control System Toolbox™ Preferences Editor. For more information about the editor, see Specify Toolbox Preferences for Linear Analysis Plots. This syntax is useful when you want to change a few plot options but otherwise use your default preferences. A script that uses this syntax may generate results that look different when run in a session with different preferences.

    example

    Properties

    expand all

    Scaling

    Scale for Y-axis, specified as either 'log' or 'linear'.

    This option corresponds to the YScale property of the chart object.

    Title and Axis Labels

    Title text and style, specified as a structure with the following fields:

    • String — Label text, specified as a character vector. By default, the plot is titled 'Bode Diagram'.

    • FontSize — Font size, specified as a scalar value greater than zero in point units. The default font size depends on the specific operating system and locale. One point equals 1/72 inch.

    • FontWeight — Character thickness, specified as 'Normal' or 'bold'. MATLAB uses the FontWeight property to select a font from those available on your system. Not all fonts have a bold weight. Therefore, specifying a bold font weight can still result in the normal font weight.

    • FontAngle — Character slant, specified as 'Normal' or 'italic'. Not all fonts have both font styles. Therefore, the italic font might look the same as the normal font.

    • Color — Text color, specified as an RGB triplet. The default color is black specified by the RGB triplet [0,0,0].

    • Interpreter — Text interpreter, specified as one of these values:

      • 'tex' — Interpret characters using a subset of TeX markup. This is the default value of Interpreter.

      • 'latex' — Interpret characters using LaTeX markup.

      • 'none' — Display literal characters.

    This option corresponds to the Title property of the chart object.

    X-axis label text and style, specified as a structure with the following fields:

    • String — Label text, specified as a character vector. By default, the axis is titled based on the frequency units FreqUnits.

    • FontSize — Font size, specified as a scalar value greater than zero in point units. The default font size depends on the specific operating system and locale. One point equals 1/72 inch.

    • FontWeight — Character thickness, specified as 'Normal' or 'bold'. MATLAB uses the FontWeight property to select a font from those available on your system. Not all fonts have a bold weight. Therefore, specifying a bold font weight can still result in the normal font weight.

    • FontAngle — Character slant, specified as 'Normal' or 'italic'. Not all fonts have both font styles. Therefore, the italic font might look the same as the normal font.

    • Color — Text color, specified as an RGB triplet. The default color is black specified by the RGB triplet [0,0,0].

    • Interpreter — Text interpreter, specified as one of these values:

      • 'tex' — Interpret characters using a subset of TeX markup. This is the default value of Interpreter.

      • 'latex' — Interpret characters using LaTeX markup.

      • 'none' — Display literal characters.

    This option corresponds to the XLabel property of the chart object.

    Y-axis label text and style, specified as a structure with the following fields:

    • String — Label text, specified as a cell array of character vectors. By default, the axis label is a 1x2 cell array with 'Magnitude' and 'Phase'.

    • FontSize — Font size, specified as a scalar value greater than zero in point units. The default font size depends on the specific operating system and locale. One point equals 1/72 inch.

    • FontWeight — Character thickness, specified as 'Normal' or 'bold'. MATLAB uses the FontWeight property to select a font from those available on your system. Not all fonts have a bold weight. Therefore, specifying a bold font weight can still result in the normal font weight.

    • FontAngle — Character slant, specified as 'Normal' or 'italic'. Not all fonts have both font styles. Therefore, the italic font might look the same as the normal font.

    • Color — Text color, specified as an RGB triplet. The default color is black specified by the RGB triplet [0,0,0].

    • Interpreter — Text interpreter, specified as one of these values:

      • 'tex' — Interpret characters using a subset of TeX markup. This is the default value of Interpreter.

      • 'latex' — Interpret characters using LaTeX markup.

      • 'none' — Display literal characters.

    This option corresponds to the YLabel property of the chart object.

    Tick label style, specified as a structure with the following fields:

    • FontSize — Font size, specified as a scalar value greater than zero in point units. The default font size depends on the specific operating system and locale. One point equals 1/72 inch.

    • FontWeight — Character thickness, specified as 'Normal' or 'bold'. MATLAB uses the FontWeight property to select a font from those available on your system. Not all fonts have a bold weight. Therefore, specifying a bold font weight can still result in the normal font weight.

    • FontAngle — Character slant, specified as 'Normal' or 'italic'. Not all fonts have both font styles. Therefore, the italic font might look the same as the normal font.

    • Color — Text color, specified as an RGB triplet. The default color is black specified by the RGB triplet [0,0,0].

    Grid

    Toggle grid display on the plot, specified as either 'off' or 'on'.

    This option corresponds to the GridVisible property of the chart object.

    Color of the grid lines, specified as an RGB triplet. The default color is light grey specified by the RGB triplet [0.15 0.15 0.15].

    Axis Limits

    X-axis limit selection mode, specified as one of the following values:

    • 'auto' — Enable automatic limit selection, which is based on the total span of the plotted data.

    • 'manual' — Manually specify the axis limits. To specify the axis limits, set the XLim option.

    This option corresponds to the XLimitsMode property of the chart object.

    Selection mode for the y-axis limits, specified as one of these values:

    • 'auto' — Enable automatic limit selection, which is based on the total span of the plotted data.

    • 'manual' — Manually specify the axis limits. To specify the axis limits, set the YLim option.

    This option corresponds to the YLimitsMode property of the chart object.

    X-axis limits, specified as a cell array of two-element vector of the form [min,max].

    This option corresponds to the XLimits property of the chart object.

    Y-axis limits, specified as a cell array of two-element vector of the form [min,max].

    This option corresponds to the YLimits property of the chart object.

    Object Functions

    hsvplot(Not recommended) Plot Hankel singular values

    Examples

    collapse all

    Use hsvplot to create a Hankel singular-value plot and customized plot properties.

    Create an options set for hsvplot that sets the Yscale property.

    P = hsvoptions;
P.YScale = 'linear';

    Use the options set to generate an HSV plot. Note the linear y-axis scale in the plot.

    h = hsvplot(rss(12),P);

    hsvplot is not recommended. Use reducespec along with view instead. In this case, set plot options for the view function using name-value arguments, where the name corresponds to a property of hsvoptions.

    R = reducespec(sys,"balanced");
view(R,YScale="linear")

    Tips

    • Both balred and hsvplot generate Hankel singular-value plots. hsvplot is useful when you want to customize properties of your plot such as axis limits, scale, and label styles. Use hsvoptions with hsvplot to define properties for your plot.

    Version History

    Introduced in R2008a

    See Also

    | | |

    Topics