| LTPDA Toolbox™ | contents | ![]() |
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 |
| Sets for this method … |
|---|
| Time-series Plot |
| Frequency-series Plot |
| Y Plot |
| X-Y Plot |
Time-series Plot |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| plot | |||
| SHOW PROVENANCE | 1 |
|
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' |
|
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. |
| FIGURE | [] | none | The handle of the figure to plot in to. |
| TITLE | '' | none | A string specifying the title. |
| LEFTYLABELS | 'Amplitude' | none | Specify the labels to be used on the left y-axes. The units are added from the data object 'yunits' property. |
| RIGHTYLABELS | 'Amplitude' | none | Specify the labels to be used on the right y-axes. The units are added from the data object 'yunits' property. |
| LATEXLABELS | 0 |
|
Use latex interpreter for axis labels. |
| 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', '', 'FIGURE', [[]], 'TITLE', '', 'LEFTYLABELS', 'Amplitude', 'RIGHTYLABELS', 'Amplitude', 'LATEXLABELS', [false], 'LEFTYSCALE', 'lin', 'RIGHTYSCALE', 'lin', 'XSCALE', 'lin') |
back to top
Frequency-series Plot |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| plot | |||
| SHOW PROVENANCE | 1 |
|
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' |
|
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. |
| FIGURE | [] | none | The handle of the figure to plot in to. |
| TITLE | '' | none | A string specifying the title. |
| LEFTYLABELS | 'Amplitude' | none | Specify the labels to be used on the left y-axes. The units are added from the data object 'yunits' property. |
| RIGHTYLABELS | 'Amplitude' | none | Specify the labels to be used on the right y-axes. The units are added from the data object 'yunits' property. |
| LATEXLABELS | 0 |
|
Use latex interpreter for axis labels. |
| 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', '', 'FIGURE', [[]], 'TITLE', '', 'LEFTYLABELS', 'Amplitude', 'RIGHTYLABELS', 'Amplitude', 'LATEXLABELS', [false], 'LEFTYSCALE', 'log', 'RIGHTYSCALE', 'log', 'XSCALE', 'log') |
back to top
Y Plot |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| plot | |||
| SHOW PROVENANCE | 1 |
|
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' |
|
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. |
| FIGURE | [] | none | The handle of the figure to plot in to. |
| TITLE | '' | none | A string specifying the title. |
| LEFTYLABELS | 'Amplitude' | none | Specify the labels to be used on the left y-axes. The units are added from the data object 'yunits' property. |
| RIGHTYLABELS | 'Amplitude' | none | Specify the labels to be used on the right y-axes. The units are added from the data object 'yunits' property. |
| LATEXLABELS | 0 |
|
Use latex interpreter for axis labels. |
Example |
|---|
| plist('SHOW PROVENANCE', [true], 'ADDITIONAL REQUIREMENTS', cell(0,0), 'FCN', 'plot', 'XRANGE', '', 'LEFTYRANGE', '', 'RIGHTYRANGE', '', 'FIGURENAMES', '', 'FIGURE', [[]], 'TITLE', '', 'LEFTYLABELS', 'Amplitude', 'RIGHTYLABELS', 'Amplitude', 'LATEXLABELS', [false]) |
back to top
X-Y Plot |
|||
|---|---|---|---|
| no description | |||
| Key | Default Value | Options | Description |
| plot | |||
| SHOW PROVENANCE | 1 |
|
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' |
|
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. |
| FIGURE | [] | none | The handle of the figure to plot in to. |
| TITLE | '' | none | A string specifying the title. |
| LEFTYLABELS | 'Amplitude' | none | Specify the labels to be used on the left y-axes. The units are added from the data object 'yunits' property. |
| RIGHTYLABELS | 'Amplitude' | none | Specify the labels to be used on the right y-axes. The units are added from the data object 'yunits' property. |
| LATEXLABELS | 0 |
|
Use latex interpreter for axis labels. |
| 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', '', 'FIGURE', [[]], 'TITLE', '', 'LEFTYLABELS', 'Amplitude', 'RIGHTYLABELS', 'Amplitude', 'LATEXLABELS', [false], 'LEFTYSCALE', 'lin', 'RIGHTYSCALE', 'lin', 'XSCALE', 'lin') |
back to top
| Some information of the method ao/iplotyy are listed below: | |
|---|---|
| Class name | ao |
| Method name | iplotyy |
| Category | Output |
| Package name | ltpda |
| Can be used as modifier | 0 |
| Supported numeric types | {'double'} |
|
Method: ao/iplot | Method: ao/report | ![]() |
©LTP Team