Previous Obsolete IDL Features: Obsolete Routines Next


This functionality is obsolete. It should not be used in new IDL code.

LIVE_OPLOT

The LIVE_OPLOT procedure allows the insertion of data into pre-existing plots.

Syntax

LIVE_OPLOT, Yvector1 [,... , Yvector25] [, ERROR=variable] [, INDEPENDENT=vector] [, NAME=structure] [, /NEW_AXES] [, /NO_DRAW] [, /NO_SELECTION] [, REFERENCE_OUT=variable] [, REPLACE={structure | {0 | 1 | 2 | 3 | 4}}] [, SUBTYPE={`LinePlot' | `ScatterPlot' | `Histogram' | `PolarPlot'}] [, VISUALIZATION_IN=string] [, WINDOW_IN=string] [, {X | Y}_TICKNAME=array] [, {X | Y}AXIS_IN=string]

Arguments

YVector

A vector argument of data. Up to 25 of these arguments may be specified.

Keywords

ERROR

Set this keyword to a named variable to contain the returned error message (string). An empty string is returned if no errors occurred during the operation. By default, errors are reported via a GUI.


Note
If a named variable is passed in this keyword and an error occurs, the error GUI will not be displayed.

INDEPENDENT

Set this keyword to an independent vector specifying the X-Values for LIVE_OPLOT.

NAME

Set this keyword to a structure containing suggested names for the data items to be created for this visualization. See the REPLACE keyword for details on how they will be used. The fields of the structure are as follows. (Any or all of the tags may be set.)

Table 2-19: Fields of the NAME keyword

Table 2-19: Fields of the NAME keyword
Tag
Description
DATA
Dependent Data Name(s)
I
Independent Data Name

The default for a field is to use the given variable name. If the variable does not have a name (i.e., is an expression), a default name is automatically generated. The dependent data names will be used in a round-robin fashion if more data than names are input.


Note
Only one independent vector is allowed; all dependent vectors will use the independent vector.

NEW_AXES

Set this keyword to generate a new set of axes for this plot line. If this keyword is specified, the [XY]AXIS_IN keywords will not be used.

NO_DRAW

Set this keyword to inhibit the visualization window from drawing. This is useful if multiple visualizations and/or annotations are being created via calls to other LIVE_Tools in order to reduce unwanted draws and help speed the display.

REFERENCE_OUT

Set this keyword to a variable to return a structure defining the names of the modified items. The fields of the structure are shown in the following table.

Table 2-20: Fields of the LIVE_OPLOT Reference Structure 

Table 2-20: Fields of the LIVE_OPLOT Reference Structure 
Tag
Description
WIN
Window Name
VIS
Visualization Name
XAXIS
X-Axis Name
YAXIS
Y-Axis Name
GRAPHIC
Graphic Name(s)
LEGEND
Legend Name
DATA
Dependent Data Name(s)
I
Independent Data Name

REPLACE

Set this keyword to a structure containing tags as listed for the NAME keyword, with scalar values corresponding to the replacement options listed below. (Any or all of the tags may be set.) The replacement settings are used to determine what action to take when an item (such as data) being input would have the same name as one already existing in the given window or buffer (WINDOW_IN).

Table 2-21: REPLACE keyword Settings and Action Taken

Table 2-21: REPLACE keyword Settings and Action Taken
Setting
Action Taken
0
New items will be given unique names.
1
Existing items will be replaced by new items (i.e., the old items will be deleted and new ones created).
2
User will be prompted for the action to take.
3
The values of existing items will be replaced. This will cause dynamic updating to occur for any current uses, e.g., a visualization would redraw to show the new value.
4
Default. Option 0 will be used for items that do not have names (e.g., data input as an expression rather than a named variable, with no name provided via the NAME keyword). Option 3 will be used for all named items.

SUBTYPE

Set this keyword to a string (case-insensitive) containing the desired type of plot. SUBTYPE defaults to whatever is being inserted into, if the [XY]AXIS_IN keyword is set. If the keywords are not set, then the default is line plot. Valid strings are:

VISUALIZATION_IN

Set this keyword equal to the name (string, case-insensitive) of a LIVE tool visualization. The VIS field from the REFERENCE_OUT keyword from the creation of the LIVE tool will provide the visualization name. If only one visualization is present in the window or buffer (WINDOW_IN), this keyword will default to it.

WINDOW_IN

Set this keyword equal to a name (string, case-sensitive) of a LIVE tool window or a LIVE tool buffer. The WIN tag of the REFERENCE_OUT structure from the creation of the LIVE tool will provide the window or buffer name. Window names are also visible in visualization window titlebars. If only one LIVE tool window (or buffer) is present in the IDL session, this keyword will default to it.

X_TICKNAME

Set this keyword equal to an array of strings to be used to label the tick mark for the X axis. The default equals the values computed from the data range.

Y_TICKNAME

Set this keyword equal to an array of strings to be used to label the tick mark for the Yaxis. The default equals the values computed from the data range.

XAXIS_IN

Set this keyword equal to the string name of an existing axis. The name can be obtained from the REFERENCE_OUT keyword, or visually from the GUI. The default is to use the first set of axes in the plot.


Note
If this keyword is set, you must also set the YAXIS_IN keyword, and both keywords must be set to a "pair" of axes. The X and Y axes given must be associated with the same plot line.

YAXIS_IN

Set this keyword equal to the string name of an existing axis. The name can be obtained from the REFERENCE_OUT keyword, or visually from the GUI. The default is to use the first set of axes in the plot.


Note
If this keyword is set, you must also set the XAXIS_IN keyword, and both keywords must be set to a "pair" of axes. The X and Y axes given must be associated with the same plot line.

Examples 

LIVE_OPLOT, tempData, pressureData

Version History

Introduced: 5.1

See Also

LIVE_PLOT, PLOT, OPLOT

  IDL Online Help (March 06, 2007)