Method ao/iplotyy


  IPLOTYY provides an intelligent plotting tool for LTPDA.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: IPLOTYY provides an intelligent plotting tool for LTPDA.
 
  CALL:               hfig = iplotyy (a1,a2,pl)
               [hfig, hax] = iplotyy (a1,a2,pl)
          [hfig, hax, hli] = iplotyy (a1,a2,pl)
 
  INPUTS:      pl  - a parameter list
               a1  - input analysis object for left y-axis
               a2  - input analysis object for right y-axis
 
  NOTE: the two input AOs must be the same data type.
 
  OUTPUTS:     hfig - handles to figures
               hax  - handles to axes
               hli  - handles to lines
 
  Parameters Description
 
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ao
Sealed 0
Static 0

Parameter Description

Time-series Plot

no description
Key Default Value Options Description
plot
SHOW PROVENANCE 1
  • 1
  • 0
A flag to enable/disable the provenance text patch.
ADDITIONAL REQUIREMENTS {} [0x0] none Specify any additional requirements needed to produce the data in the plot.
iplotyy
FCN 'plot'
  • 'plot'
  • 'stairs'
  • 'stem'
The plot function to use. Note: if errors are plotted, then this value is ignored.
XRANGE '' none A 2-element array specifying the ranges to be displayed on the x-axis.
LEFTYRANGE '' none A 2-element array specifying the range to be displayed on the left y-axis.
RIGHTYRANGE '' none A 2-element array specifying the range to be displayed on the right y-axis.
FIGURENAMES '' none Sets the figure name.
LEFTYSCALE 'lin' none
RIGHTYSCALE 'lin' none
XSCALE 'lin' none

Example

plist('SHOW PROVENANCE', [true], 'ADDITIONAL REQUIREMENTS', cell(0,0), 'FCN', 'plot', 'XRANGE', '', 'LEFTYRANGE', '', 'RIGHTYRANGE', '', 'FIGURENAMES', '', 'LEFTYSCALE', 'lin', 'RIGHTYSCALE', 'lin', 'XSCALE', 'lin')

back to top back to top

Frequency-series Plot

no description
Key Default Value Options Description
plot
SHOW PROVENANCE 1
  • 1
  • 0
A flag to enable/disable the provenance text patch.
ADDITIONAL REQUIREMENTS {} [0x0] none Specify any additional requirements needed to produce the data in the plot.
iplotyy
FCN 'plot'
  • 'plot'
  • 'stairs'
  • 'stem'
The plot function to use. Note: if errors are plotted, then this value is ignored.
XRANGE '' none A 2-element array specifying the ranges to be displayed on the x-axis.
LEFTYRANGE '' none A 2-element array specifying the range to be displayed on the left y-axis.
RIGHTYRANGE '' none A 2-element array specifying the range to be displayed on the right y-axis.
FIGURENAMES '' none Sets the figure name.
LEFTYSCALE 'log' none
RIGHTYSCALE 'log' none
XSCALE 'log' none

Example

plist('SHOW PROVENANCE', [true], 'ADDITIONAL REQUIREMENTS', cell(0,0), 'FCN', 'plot', 'XRANGE', '', 'LEFTYRANGE', '', 'RIGHTYRANGE', '', 'FIGURENAMES', '', 'LEFTYSCALE', 'log', 'RIGHTYSCALE', 'log', 'XSCALE', 'log')

back to top back to top

Y Plot

no description
Key Default Value Options Description
plot
SHOW PROVENANCE 1
  • 1
  • 0
A flag to enable/disable the provenance text patch.
ADDITIONAL REQUIREMENTS {} [0x0] none Specify any additional requirements needed to produce the data in the plot.
iplotyy
FCN 'plot'
  • 'plot'
  • 'stairs'
  • 'stem'
The plot function to use. Note: if errors are plotted, then this value is ignored.
XRANGE '' none A 2-element array specifying the ranges to be displayed on the x-axis.
LEFTYRANGE '' none A 2-element array specifying the range to be displayed on the left y-axis.
RIGHTYRANGE '' none A 2-element array specifying the range to be displayed on the right y-axis.
FIGURENAMES '' none Sets the figure name.

Example

plist('SHOW PROVENANCE', [true], 'ADDITIONAL REQUIREMENTS', cell(0,0), 'FCN', 'plot', 'XRANGE', '', 'LEFTYRANGE', '', 'RIGHTYRANGE', '', 'FIGURENAMES', '')

back to top back to top

X-Y Plot

no description
Key Default Value Options Description
plot
SHOW PROVENANCE 1
  • 1
  • 0
A flag to enable/disable the provenance text patch.
ADDITIONAL REQUIREMENTS {} [0x0] none Specify any additional requirements needed to produce the data in the plot.
iplotyy
FCN 'plot'
  • 'plot'
  • 'stairs'
  • 'stem'
The plot function to use. Note: if errors are plotted, then this value is ignored.
XRANGE '' none A 2-element array specifying the ranges to be displayed on the x-axis.
LEFTYRANGE '' none A 2-element array specifying the range to be displayed on the left y-axis.
RIGHTYRANGE '' none A 2-element array specifying the range to be displayed on the right y-axis.
FIGURENAMES '' none Sets the figure name.
LEFTYSCALE 'lin' none
RIGHTYSCALE 'lin' none
XSCALE 'lin' none

Example

plist('SHOW PROVENANCE', [true], 'ADDITIONAL REQUIREMENTS', cell(0,0), 'FCN', 'plot', 'XRANGE', '', 'LEFTYRANGE', '', 'RIGHTYRANGE', '', 'FIGURENAMES', '', 'LEFTYSCALE', 'lin', 'RIGHTYSCALE', 'lin', 'XSCALE', 'lin')

back to top back to top

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




©LTP Team