dataPlotOptions

Option set for idplot when plotting input/output estimation data contained in a timetable, numeric matrices, or an iddata object

Since R2023a

Syntax

opt = dataPlotOptions('time')

opt = dataPlotOptions('frequency')

opt = dataPlotOptions(___,'identpref')

Description

opt = dataPlotOptions('time') creates the default option set for plotting time-domain data. Use dot notation to customize the option set, if needed.

opt = dataPlotOptions('frequency') creates a default option set for plotting frequency-domain data. Use dot notation to customize the option set, if needed.

opt = dataPlotOptions(___,'identpref') initializes the plot options with the System Identification Toolbox™ preferences. This syntax can include any of the input argument combinations in the previous syntaxes. Use this syntax to change a few plot options but otherwise use your toolbox preferences.

Examples

Create Option Set for Plotting Time-Domain Data

Create an options set with default options for time-domain data.

opt = dataPlotOptions('time');

Specify plot properties, such as time units and grid. View the plot in minutes

 opt.TimeUnits = 'minutes';
 % Turn grid on
 opt.Grid = 'on';

Create a plot using the specified options.

load iddata1 z1
h = idplot(z1, opt);

Change Orientation of Input-Output Data Axes

Generate data with two inputs and one output.

z = iddata(randn(100,1),rand(100,2));

Configure a time plot.

opt = iddataPlotOptions('time');

Plot the data.

h = idplot(z,opt);

Change the orientation of the plots such that all inputs are plotted in one column, and all outputs are in a second column.

opt.Orientation = 'two-column';
h = idplot(z,opt);

Alternatively, use setoptions.

setoptions(h,'Orientation','two-column')

You can also change the orientation by right-clicking the plot and choosing Orientation in the context menu.

Create Option Set for Plotting Frequency-Domain Data

Create an option set with default options for frequency-domain data.

opt = dataPlotOptions('frequency');

Specify plot properties, such as phase visibility and frequency units.

opt.PhaseVisible = 'off'; 
opt.FreqUnits = 'Hz';

Create a plot with the specified options.

load iddata7 z7
zf = fft(z7);
h = idplot(zf,opt);

Initialize a Plot Using Toolbox Preferences

opt = dataPlotOptions('time','identpref');

Output Arguments

opt — Option set for idplot

dataPlotOptions option set

Option set containing the specified options for idplot. The structure has the following fields:

Field	Description
Title, XLabel, YLabel	Text and style for axes labels and plot title, specified as a structure array with the following fields: String — Title and axes label text, specified as a character vector. Default Title: 'Input-Output Data' Default XLabel: 'Time' Default YLabel: 'Amplitude' FontSize — Font size, specified as scalar value greater than 0. Default: 8 FontWeight — Thickness of text, specified as one of the following values: 'Normal' | 'Bold' Default: 'Normal' Font Angle — Text character angle, specified as one of the following values: 'Normal' | 'Italic' Default: 'Normal' Color — Color of text, specified as vector of RGB values between 0 to 1. Default: [0,0,0] Interpreter — Interpretation of text characters, specified as one of the following values: 'tex' | 'latex'| 'none' Default: 'tex'
TickLabel	Tick label style, specified as a structure array with the following fields: FontSize — Font size, specified as scalar value greater than 0. Default: 8 FontWeight — Thickness of text, specified as one of the following values: 'Normal' | 'Bold' Default: 'Normal' Font Angle — Text character angle, specified as one of the following values: 'Normal' | 'Italic' Default: 'Normal' Color — Color of text, specified as vector of RGB values between 0 to 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,0,0]
Grid	Show or hide the grid, specified as one of the following values: 'off' | 'on' Default: 'off'
GridColor	Color of the grid lines, specified as one of the following values: 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	Axes limit modes, specified as one of the following values: 'auto' — The axis limits are based on the data plotted 'manual' — The values explicitly set with Xlim, Ylim Default: 'auto'
Xlim, Ylim	Axes limits, specified as maximum and minimum values. Default: [0 1]
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 on individual plot axes, specified as a structure array with the following fields: FontSize — Font size, specified as data type scalar. Default: 8 FontWeight — Thickness of text, specified as one of the following values: 'Normal' | 'Bold' Default: 'Normal' Font Angle — Text character angle, specified as one of the following values: 'Normal' | 'Italic' Default: 'Normal' Color — Color of text, specified as a vector of RGB values between 0 to 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.4,0.4,0.4] Interpreter — Interpretation of text characters, specified as one of the following values: 'tex' | 'latex'| 'none' Default: 'tex'
InputVisible, OutputVisible	Visibility of input and output channels, specified as one of the following values: 'off' | 'on' Default: 'on'
Orientation	Orientation of the input and output data plots, specified as one of the following values: 'two-row' — Plot all outputs in one row and all inputs in a second row 'two-column' — Plot all outputs in one column and all inputs in a second column 'single-row' — Plot all inputs and outputs in one row 'single-column'— Plot all inputs and outputs in one column Default: 'two-row'.
For time-domain data plots only: Field Description TimeUnits Time units, specified as one of the following values: 'nanoseconds' 'microseconds' 'milliseconds' 'seconds' 'minutes' 'hours' 'days' 'weeks' 'months' 'years' You can also specify 'auto' which uses time units specified in the TimeUnit property of the data. For multiple systems with different time units, the units of the first system is used. Normalize Normalize responses, specified as one of the following values: 'on' |'off' Default: 'off' InputInterSample Input-channel intersample behavior for plotting the input signals, specified as 'auto', 'zoh', or 'foh'. The definitions of the three behavior values are as follows: 'auto'— If the data is represented by an iddata object, the software uses the value of the object property InterSample. It uses a stairstep plot if the value is 'zoh' and a line plot if the value is 'foh'. If the data is specified as a numeric pair or a timetable, the software interprets 'auto' as 'zoh'. 'zoh'— Zero-order hold maintains a piecewise-constant input signal between samples. The software plots the input signal as a stairstep plot. 'foh'— First-order hold maintains a piecewise-linear input signal between samples. The software plots the input signal as a line plot. The software applies the same option value to all input channels and all experiments. Default: 'auto'
For frequency-domain data plots only: Field Description FreqUnits Frequency units, specified as one of the following values: 'Hz' 'rad/s' '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. FreqScale Frequency scale, specified as one of the following values: 'linear' | 'log' Default: 'log' MagUnits Magnitude units, specified as one of the following values: 'dB' | 'abs' Default: 'dB' MagScale Magnitude scale, specified as one of the following values: 'linear' | 'log' Default: 'linear' MagVisible Magnitude plot visibility, specified as one of the following values: 'on' | 'off' Default: 'on' MagLowerLimMode Enables a lower magnitude limit, specified as one of the following values: 'auto' | 'manual' Default: 'auto' MagLowerLim Lower magnitude limit, , specified as data type double. It is typically decided by the range of the amplitudes the plotted data takes. PhaseUnits Phase units, specified as one of the following values: 'deg' | 'rad' Default: 'deg' PhaseVisible Phase plot visibility, specified as one of the following values: 'on' | 'off' Default: 'on' PhaseWrapping Enable phase wrapping, specified as one of the following values: 'on' | 'off' Default: 'off' PhaseWrappingBranch Phase value at which the plot wraps accumulated phase when PhaseWrapping is set to 'on'. Default: –180 (phase wraps into the interval [–180º,180º)) PhaseMatching Enable phase matching, specified as one of the following values: 'on' | 'off' Default: 'off' PhaseMatchingFreq Frequency for matching phase, specified as data type double. PhaseMatchingValue The value to which phase responses are matched closely, specified as a real number representing the desired phase value PhaseMatchingFreq.

Version History

Introduced in R2023a

R2023a: dataPlotOptions function replaces the iddataPlotOptions method of iddata

dataPlotOptions is the option set for the new idplot function, which was expanded to include timetables and numeric input/output matrix pairs.

dataPlotOptions continues to work with plot, which idplot replaced. Use of idddataPlotOptions is not recommended.

R2022b: Time-domain estimation data is accepted in the form of timetables and matrices

Most estimation, validation, analysis, and utility functions now accept time-domain input/output data in the form of a single timetable that contains both input and output data or a pair of matrices that contain the input and output data separately. These functions continue to accept iddata objects as a data source as well, for both time-domain and frequency-domain data.