LTPDA Toolbox™ contents Method: matrix/display   Method: matrix/report

Method matrix/iplot

  IPLOT calls ao/iplot on all inner ao objects.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: IPLOT calls ao/iplot on all inner ao objects.
 
  CALL:        obj = iplot(mat)
               obj = mat.iplot()
 
  Note: if the matrix object does not contain AOs, then an error will be
  thrown.
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class matrix
Sealed 0
Static 0

Parameter Description

Sets for this method …
Time-series Plot
Frequency-series Plot
Y Data Plot
X-Y Data Plot
3D Plot

Time-series Plot
no description
Key Default Value Options Description
iplot
FIGURE [] none The handle of the figure to plot in to. This will be ignored if the AOs to plot are inconsistent,
containing different class of data (such as tsdata and fsdata), or if the 'arrangement'
parameter is passed as 'single'.
ARRANGEMENT 'stacked'
  • 'stacked'
  • 'single'
  • 'subplots'
 Select the plot layout:
  • 'single' - plot all AOs on individual figures
  • 'stacked' - plot all AOs on the same axes
  • 'subplots' - plot all AOs on subplots
FUNCTION 'plot'
  • 'plot'
  • 'stairs'
  • 'stem'
 Specify the plot function:
  • 'plot'
  • 'stairs'
  • 'stem'
[*** doesn't work for xyzdata AOs]
LINECOLORS '' none A cell-array of color definitions, one for each trace.
Give an empty string to use the default color.
LINESTYLES '' none A cell-array of line styles, one for each trace.
Give an empty string to use the default style.
MARKERS '' none A cell-array of markers, one for each trace.
MARKERSIZES '' none A cell-array of marker sizes, one for each trace.
LINEWIDTHS '' none A cell-array of line widths, one for each trace.
Give an empty string to use the default line width.
LEGENDS '' none Give a cell-array of strings to be used for
the plot legends. If a cell contains an empty
string, the default legend string is built.
If a single string 'off' is given instead of a
cell-array, then the legends are all switched off.
LEGENDLOCATION 'NorthEast'
  • 'North'
  • 'South'
  • 'East'
  • 'West'
  • 'NorthEast'
  • 'NorthWest'
  • 'SouthEast'
  • 'SouthWest'
  • 'NorthOutside'
  • 'SouthOutside'
  • 'EastOutside'
  • 'WestOutside'
  • 'NorthEastOutside'
  • 'NorthWestOutside'
  • 'SouthEastOutside'
  • 'SouthWestOutside'
  • 'Best'
  • 'BestOutside'
 Choose the legend location.
LEGENDFONTSIZE 20 none Choose the legend font size.
FIGURENAMES '' none Sets the figure name.
SHOW PROVENANCE 1
  • 1
  • 0
 A flag to enable/disable the provenance text patch.
XERRL [] none Lower bound error values for the X data points.
XERRU [] none Upper bound error values for the X data points.
YERRL [] none Lower bound error values for the Y data points.
YERRU [] none Upper bound error values for the Y data points.
XSCALES '' none A cell-array specifying the scale to be used on each x-axis.
For example, {'lin', 'log'}
YSCALES '' none A cell-array specifying the scale to be used on each y-axis.
For example, {'lin', 'log'}
XRANGES '' none A cell-array specifying the ranges to be displayed on each x-axis.
For example, {[0 1], [-4 4]}.
YRANGES '' none A cell-array specifying the ranges to be displayed on each y-axis.
For example, {[0 1], [-4 4]}.
TITLES '' none A cell-array specifying the titles to be displayed above each set of axes.
LATEXLABELS 0
  • 0
  • 1
 Use latex interpreter for axis labels.
AUTOERRORS 0
  • 0
  • 1
 If the AO contains errors, they will be plotted. You can avoid plotting the
errors by setting this to false.
ERRORBARTYPE 'bar'
  • 'bar'
  • 'area'
 Choose the way the errors should be displayed.
XLABELS 'Time' none Specify the labels to be used on the x-axes. The units are added from
the data object 'xunits' property.
YLABELS 'Amplitude' none Specify the labels to be used on the y-axes. The units are added from
the data object 'yunits' property.
XUNITS 's'
  • 'us'
  • 'ms'
  • 's'
  • 'm'
  • 'h'
  • 'D'
  • 'M'
  • 'HH:MM:SS'
  • 'yyyy-mm-dd HH:MM:SS'
 Specify the units of time on the x-axis as
  • 'us' - microseconds
  • 'ms' - milliseconds
  • 's' - seconds
  • 'm' - minutes
  • 'h' - hours
  • 'D' - days
  • 'M' - months
  • 'HH:MM:SS' - using a date/time format
TIME FORMAT 'yyyy-mm-dd HH:MM:SS.FFF' none Specify the format used to display the time origin which prefixes the x-axis label. See help time/format.

Example
plist('FIGURE', [[]], 'ARRANGEMENT', 'stacked', 'FUNCTION', 'plot', 'LINECOLORS', '', 'LINESTYLES', '', 'MARKERS', '', 'MARKERSIZES', '', 'LINEWIDTHS', '', 'LEGENDS', '', 'LEGENDLOCATION', 'NorthEast', 'LEGENDFONTSIZE', [20], 'FIGURENAMES', '', 'SHOW PROVENANCE', [true], 'XERRL', [[]], 'XERRU', [[]], 'YERRL', [[]], 'YERRU', [[]], 'XSCALES', '', 'YSCALES', '', 'XRANGES', '', 'YRANGES', '', 'TITLES', '', 'LATEXLABELS', [false], 'AUTOERRORS', [false], 'ERRORBARTYPE', 'bar', 'XLABELS', 'Time', 'YLABELS', 'Amplitude', 'XUNITS', 's', 'TIME FORMAT', 'yyyy-mm-dd HH:MM:SS.FFF')

back to top back to top

Frequency-series Plot
no description
Key Default Value Options Description
iplot
FIGURE [] none The handle of the figure to plot in to. This will be ignored if the AOs to plot are inconsistent,
containing different class of data (such as tsdata and fsdata), or if the 'arrangement'
parameter is passed as 'single'.
ARRANGEMENT 'stacked'
  • 'stacked'
  • 'single'
  • 'subplots'
 Select the plot layout:
  • 'single' - plot all AOs on individual figures
  • 'stacked' - plot all AOs on the same axes
  • 'subplots' - plot all AOs on subplots
FUNCTION 'plot'
  • 'plot'
  • 'stairs'
  • 'stem'
 Specify the plot function:
  • 'plot'
  • 'stairs'
  • 'stem'
[*** doesn't work for xyzdata AOs]
LINECOLORS '' none A cell-array of color definitions, one for each trace.
Give an empty string to use the default color.
LINESTYLES '' none A cell-array of line styles, one for each trace.
Give an empty string to use the default style.
MARKERS '' none A cell-array of markers, one for each trace.
MARKERSIZES '' none A cell-array of marker sizes, one for each trace.
LINEWIDTHS '' none A cell-array of line widths, one for each trace.
Give an empty string to use the default line width.
LEGENDS '' none Give a cell-array of strings to be used for
the plot legends. If a cell contains an empty
string, the default legend string is built.
If a single string 'off' is given instead of a
cell-array, then the legends are all switched off.
LEGENDLOCATION 'NorthEast'
  • 'North'
  • 'South'
  • 'East'
  • 'West'
  • 'NorthEast'
  • 'NorthWest'
  • 'SouthEast'
  • 'SouthWest'
  • 'NorthOutside'
  • 'SouthOutside'
  • 'EastOutside'
  • 'WestOutside'
  • 'NorthEastOutside'
  • 'NorthWestOutside'
  • 'SouthEastOutside'
  • 'SouthWestOutside'
  • 'Best'
  • 'BestOutside'
 Choose the legend location.
LEGENDFONTSIZE 20 none Choose the legend font size.
FIGURENAMES '' none Sets the figure name.
SHOW PROVENANCE 1
  • 1
  • 0
 A flag to enable/disable the provenance text patch.
XERRL [] none Lower bound error values for the X data points.
XERRU [] none Upper bound error values for the X data points.
YERRL [] none Lower bound error values for the Y data points.
YERRU [] none Upper bound error values for the Y data points.
XSCALES '' none A cell-array specifying the scale to be used on each x-axis.
For example, {'lin', 'log'}
YSCALES '' none A cell-array specifying the scale to be used on each y-axis.
For example, {'lin', 'log'}
XRANGES '' none A cell-array specifying the ranges to be displayed on each x-axis.
For example, {[0 1], [-4 4]}.
YRANGES '' none A cell-array specifying the ranges to be displayed on each y-axis.
For example, {[0 1], [-4 4]}.
TITLES '' none A cell-array specifying the titles to be displayed above each set of axes.
LATEXLABELS 0
  • 0
  • 1
 Use latex interpreter for axis labels.
AUTOERRORS 0
  • 0
  • 1
 If the AO contains errors, they will be plotted. You can avoid plotting the
errors by setting this to false.
ERRORBARTYPE 'bar'
  • 'bar'
  • 'area'
 Choose the way the errors should be displayed.
COMPLEXPLOTTYPE 'absdeg'
  • 'absdeg'
  • 'realimag'
  • 'absrad'
 Specify how to plot complex data. Choose from:
  • 'realimag'
  • 'absdeg'
  • 'absrad'
XLABELS 'Frequency' none Specify the labels to be used on the x-axes. The units are added from
the data object 'xunits' property.
YLABELS '' none Specify the labels to be used on the y-axes. The units are added from
the data object 'yunits' property.

Example
plist('FIGURE', [[]], 'ARRANGEMENT', 'stacked', 'FUNCTION', 'plot', 'LINECOLORS', '', 'LINESTYLES', '', 'MARKERS', '', 'MARKERSIZES', '', 'LINEWIDTHS', '', 'LEGENDS', '', 'LEGENDLOCATION', 'NorthEast', 'LEGENDFONTSIZE', [20], 'FIGURENAMES', '', 'SHOW PROVENANCE', [true], 'XERRL', [[]], 'XERRU', [[]], 'YERRL', [[]], 'YERRU', [[]], 'XSCALES', '', 'YSCALES', '', 'XRANGES', '', 'YRANGES', '', 'TITLES', '', 'LATEXLABELS', [false], 'AUTOERRORS', [false], 'ERRORBARTYPE', 'bar', 'COMPLEXPLOTTYPE', 'absdeg', 'XLABELS', 'Frequency', 'YLABELS', '')

back to top back to top

Y Data Plot
no description
Key Default Value Options Description
iplot
FIGURE [] none The handle of the figure to plot in to. This will be ignored if the AOs to plot are inconsistent,
containing different class of data (such as tsdata and fsdata), or if the 'arrangement'
parameter is passed as 'single'.
ARRANGEMENT 'stacked'
  • 'stacked'
  • 'single'
  • 'subplots'
 Select the plot layout:
  • 'single' - plot all AOs on individual figures
  • 'stacked' - plot all AOs on the same axes
  • 'subplots' - plot all AOs on subplots
FUNCTION 'plot'
  • 'plot'
  • 'stairs'
  • 'stem'
 Specify the plot function:
  • 'plot'
  • 'stairs'
  • 'stem'
[*** doesn't work for xyzdata AOs]
LINECOLORS '' none A cell-array of color definitions, one for each trace.
Give an empty string to use the default color.
LINESTYLES '' none A cell-array of line styles, one for each trace.
Give an empty string to use the default style.
MARKERS '' none A cell-array of markers, one for each trace.
MARKERSIZES '' none A cell-array of marker sizes, one for each trace.
LINEWIDTHS '' none A cell-array of line widths, one for each trace.
Give an empty string to use the default line width.
LEGENDS '' none Give a cell-array of strings to be used for
the plot legends. If a cell contains an empty
string, the default legend string is built.
If a single string 'off' is given instead of a
cell-array, then the legends are all switched off.
LEGENDLOCATION 'NorthEast'
  • 'North'
  • 'South'
  • 'East'
  • 'West'
  • 'NorthEast'
  • 'NorthWest'
  • 'SouthEast'
  • 'SouthWest'
  • 'NorthOutside'
  • 'SouthOutside'
  • 'EastOutside'
  • 'WestOutside'
  • 'NorthEastOutside'
  • 'NorthWestOutside'
  • 'SouthEastOutside'
  • 'SouthWestOutside'
  • 'Best'
  • 'BestOutside'
 Choose the legend location.
LEGENDFONTSIZE 20 none Choose the legend font size.
FIGURENAMES '' none Sets the figure name.
SHOW PROVENANCE 1
  • 1
  • 0
 A flag to enable/disable the provenance text patch.
XERRL [] none Lower bound error values for the X data points.
XERRU [] none Upper bound error values for the X data points.
YERRL [] none Lower bound error values for the Y data points.
YERRU [] none Upper bound error values for the Y data points.
XSCALES '' none A cell-array specifying the scale to be used on each x-axis.
For example, {'lin', 'log'}
YSCALES '' none A cell-array specifying the scale to be used on each y-axis.
For example, {'lin', 'log'}
XRANGES '' none A cell-array specifying the ranges to be displayed on each x-axis.
For example, {[0 1], [-4 4]}.
YRANGES '' none A cell-array specifying the ranges to be displayed on each y-axis.
For example, {[0 1], [-4 4]}.
TITLES '' none A cell-array specifying the titles to be displayed above each set of axes.
LATEXLABELS 0
  • 0
  • 1
 Use latex interpreter for axis labels.
AUTOERRORS 0
  • 0
  • 1
 If the AO contains errors, they will be plotted. You can avoid plotting the
errors by setting this to false.
ERRORBARTYPE 'bar'
  • 'bar'
  • 'area'
 Choose the way the errors should be displayed.
XLABELS 'Sample' none Specify the labels to be used on the x-axes. The units are added from
the data object 'xunits' property.
YLABELS 'Value' none Specify the labels to be used on the y-axes. The units are added from
the data object 'yunits' property.

Example
plist('FIGURE', [[]], 'ARRANGEMENT', 'stacked', 'FUNCTION', 'plot', 'LINECOLORS', '', 'LINESTYLES', '', 'MARKERS', '', 'MARKERSIZES', '', 'LINEWIDTHS', '', 'LEGENDS', '', 'LEGENDLOCATION', 'NorthEast', 'LEGENDFONTSIZE', [20], 'FIGURENAMES', '', 'SHOW PROVENANCE', [true], 'XERRL', [[]], 'XERRU', [[]], 'YERRL', [[]], 'YERRU', [[]], 'XSCALES', '', 'YSCALES', '', 'XRANGES', '', 'YRANGES', '', 'TITLES', '', 'LATEXLABELS', [false], 'AUTOERRORS', [false], 'ERRORBARTYPE', 'bar', 'XLABELS', 'Sample', 'YLABELS', 'Value')

back to top back to top

X-Y Data Plot
no description
Key Default Value Options Description
iplot
FIGURE [] none The handle of the figure to plot in to. This will be ignored if the AOs to plot are inconsistent,
containing different class of data (such as tsdata and fsdata), or if the 'arrangement'
parameter is passed as 'single'.
ARRANGEMENT 'stacked'
  • 'stacked'
  • 'single'
  • 'subplots'
 Select the plot layout:
  • 'single' - plot all AOs on individual figures
  • 'stacked' - plot all AOs on the same axes
  • 'subplots' - plot all AOs on subplots
FUNCTION 'plot'
  • 'plot'
  • 'stairs'
  • 'stem'
 Specify the plot function:
  • 'plot'
  • 'stairs'
  • 'stem'
[*** doesn't work for xyzdata AOs]
LINECOLORS '' none A cell-array of color definitions, one for each trace.
Give an empty string to use the default color.
LINESTYLES '' none A cell-array of line styles, one for each trace.
Give an empty string to use the default style.
MARKERS '' none A cell-array of markers, one for each trace.
MARKERSIZES '' none A cell-array of marker sizes, one for each trace.
LINEWIDTHS '' none A cell-array of line widths, one for each trace.
Give an empty string to use the default line width.
LEGENDS '' none Give a cell-array of strings to be used for
the plot legends. If a cell contains an empty
string, the default legend string is built.
If a single string 'off' is given instead of a
cell-array, then the legends are all switched off.
LEGENDLOCATION 'NorthEast'
  • 'North'
  • 'South'
  • 'East'
  • 'West'
  • 'NorthEast'
  • 'NorthWest'
  • 'SouthEast'
  • 'SouthWest'
  • 'NorthOutside'
  • 'SouthOutside'
  • 'EastOutside'
  • 'WestOutside'
  • 'NorthEastOutside'
  • 'NorthWestOutside'
  • 'SouthEastOutside'
  • 'SouthWestOutside'
  • 'Best'
  • 'BestOutside'
 Choose the legend location.
LEGENDFONTSIZE 20 none Choose the legend font size.
FIGURENAMES '' none Sets the figure name.
SHOW PROVENANCE 1
  • 1
  • 0
 A flag to enable/disable the provenance text patch.
XERRL [] none Lower bound error values for the X data points.
XERRU [] none Upper bound error values for the X data points.
YERRL [] none Lower bound error values for the Y data points.
YERRU [] none Upper bound error values for the Y data points.
XSCALES '' none A cell-array specifying the scale to be used on each x-axis.
For example, {'lin', 'log'}
YSCALES '' none A cell-array specifying the scale to be used on each y-axis.
For example, {'lin', 'log'}
XRANGES '' none A cell-array specifying the ranges to be displayed on each x-axis.
For example, {[0 1], [-4 4]}.
YRANGES '' none A cell-array specifying the ranges to be displayed on each y-axis.
For example, {[0 1], [-4 4]}.
TITLES '' none A cell-array specifying the titles to be displayed above each set of axes.
LATEXLABELS 0
  • 0
  • 1
 Use latex interpreter for axis labels.
AUTOERRORS 0
  • 0
  • 1
 If the AO contains errors, they will be plotted. You can avoid plotting the
errors by setting this to false.
ERRORBARTYPE 'bar'
  • 'bar'
  • 'area'
 Choose the way the errors should be displayed.
XLABELS 'X-data' none Specify the labels to be used on the x-axes. The units are added from
the data object 'xunits' property.
YLABELS 'Y-data' none Specify the labels to be used on the y-axes. The units are added from
the data object 'yunits' property.

Example
plist('FIGURE', [[]], 'ARRANGEMENT', 'stacked', 'FUNCTION', 'plot', 'LINECOLORS', '', 'LINESTYLES', '', 'MARKERS', '', 'MARKERSIZES', '', 'LINEWIDTHS', '', 'LEGENDS', '', 'LEGENDLOCATION', 'NorthEast', 'LEGENDFONTSIZE', [20], 'FIGURENAMES', '', 'SHOW PROVENANCE', [true], 'XERRL', [[]], 'XERRU', [[]], 'YERRL', [[]], 'YERRU', [[]], 'XSCALES', '', 'YSCALES', '', 'XRANGES', '', 'YRANGES', '', 'TITLES', '', 'LATEXLABELS', [false], 'AUTOERRORS', [false], 'ERRORBARTYPE', 'bar', 'XLABELS', 'X-data', 'YLABELS', 'Y-data')

back to top back to top

3D Plot
no description
Key Default Value Options Description
iplot
FIGURE [] none The handle of the figure to plot in to. This will be ignored if the AOs to plot are inconsistent,
containing different class of data (such as tsdata and fsdata), or if the 'arrangement'
parameter is passed as 'single'.
ARRANGEMENT 'single' none Select the plot layout:
  • 'single' - plot all AOs on individual figures
  • 'stacked' - plot all AOs on the same axes
  • 'subplots' - plot all AOs on subplots
FUNCTION 'plot'
  • 'plot'
  • 'stairs'
  • 'stem'
 Specify the plot function:
  • 'plot'
  • 'stairs'
  • 'stem'
[*** doesn't work for xyzdata AOs]
LEGENDS '' none Give a cell-array of strings to be used for
the plot legends. If a cell contains an empty
string, the default legend string is built.
If a single string 'off' is given instead of a
cell-array, then the legends are all switched off.
LEGENDLOCATION 'NorthEast'
  • 'North'
  • 'South'
  • 'East'
  • 'West'
  • 'NorthEast'
  • 'NorthWest'
  • 'SouthEast'
  • 'SouthWest'
  • 'NorthOutside'
  • 'SouthOutside'
  • 'EastOutside'
  • 'WestOutside'
  • 'NorthEastOutside'
  • 'NorthWestOutside'
  • 'SouthEastOutside'
  • 'SouthWestOutside'
  • 'Best'
  • 'BestOutside'
 Choose the legend location.
LEGENDFONTSIZE 20 none Choose the legend font size.
FIGURENAMES '' none Sets the figure name.
SHOW PROVENANCE 1
  • 1
  • 0
 A flag to enable/disable the provenance text patch.
XERRL [] none Lower bound error values for the X data points.
XERRU [] none Upper bound error values for the X data points.
YERRL [] none Lower bound error values for the Y data points.
YERRU [] none Upper bound error values for the Y data points.
XSCALES '' none A cell-array specifying the scale to be used on each x-axis.
For example, {'lin', 'log'}
YSCALES '' none A cell-array specifying the scale to be used on each y-axis.
For example, {'lin', 'log'}
XRANGES '' none A cell-array specifying the ranges to be displayed on each x-axis.
For example, {[0 1], [-4 4]}.
YRANGES '' none A cell-array specifying the ranges to be displayed on each y-axis.
For example, {[0 1], [-4 4]}.
TITLES '' none A cell-array specifying the titles to be displayed above each set of axes.
LATEXLABELS 0
  • 0
  • 1
 Use latex interpreter for axis labels.
AUTOERRORS 0
  • 0
  • 1
 If the AO contains errors, they will be plotted. You can avoid plotting the
errors by setting this to false.
ERRORBARTYPE 'bar'
  • 'bar'
  • 'area'
 Choose the way the errors should be displayed.
XLABELS 'Time' none Specify the labels to be used on the x-axes. The units are added from
the data object 'xunits' property.
YLABELS 'Frequency' none Specify the labels to be used on the y-axes. The units are added from
the data object 'yunits' property.
ZLABELS 'Amplitude' none Specify the labels to be used on the z-axes. The units are added from
the data object 'zunits' property.
ZSCALES '' none A cell-array specifying the scale to be used on each z-axis.
For example, {'lin', 'log'}
ZRANGES '' none A cell-array specifying the ranges to be displayed on each z-axis.
For example, {[0 1], [-4 4]}.
INVERTY 1
  • 1
  • 0
 Invert the y-axis or not.

Example
plist('FIGURE', [[]], 'ARRANGEMENT', 'single', 'FUNCTION', 'plot', 'LEGENDS', '', 'LEGENDLOCATION', 'NorthEast', 'LEGENDFONTSIZE', [20], 'FIGURENAMES', '', 'SHOW PROVENANCE', [true], 'XERRL', [[]], 'XERRU', [[]], 'YERRL', [[]], 'YERRU', [[]], 'XSCALES', '', 'YSCALES', '', 'XRANGES', '', 'YRANGES', '', 'TITLES', '', 'LATEXLABELS', [false], 'AUTOERRORS', [false], 'ERRORBARTYPE', 'bar', 'XLABELS', 'Time', 'YLABELS', 'Frequency', 'ZLABELS', 'Amplitude', 'ZSCALES', '', 'ZRANGES', '', 'INVERTY', [true])

back to top back to top

Some information of the method matrix/iplot are listed below:
Class name matrix
Method name iplot
Category Output
Package name ltpda
VCS Version 967b0eec0dece803a81af8ef54ad2f8c784b20b2
Min input args 1
Max input args -1
Min output args 1
Max output args -1
Can be used as modifier 1
Supported numeric types {'double'}



Method: matrix/display  Method: matrix/display   Method: matrix/report Method: matrix/report

©LTP Team