IGETDATA

The IGETDATA procedure retrieves data from a specified iTools object. It can also return the object itself.

This routine is written in the IDL language. Its source code can be found in the file igetdata.pro in the lib/itools subdirectory of the IDL distribution.

Syntax

IGETDATA, ID, Arg1, Arg2, ... [, OBJECT=Value] [, TOOL=iToolID]

Arguments

ID

A string containing the identifier of the iTools object from which to retrieve data. If you pass a partial identifier, the IGETID function is called to retrieve the full identifier string.

Args

Named variables that will contain the returned data.

Keywords

All other keywords are passed to the iTools object.

OBJECT

Set this keyword to a named variable that will contain an object reference to the iTool visualization object specified by Id.

TOOL

Set this keyword to a string specifying one or more iTools in which to search for Id. If this keyword is not set, only the current iTool is searched.

iTool Visualizations Compatible with IGETDATA

IGETDATA can retrieve data from the following iTool visualizations:

Table 11-2: iTool Visualizations Compatible with IGETDATA
Item	Arguments	Data Returned
Colorbar	RED GREEN BLUE	Returns the color vectors from the contained palette. If only one argument is supplied, a 3xm array is returned.
Contour	Z, X, Y	Returns the Z, X, and Y arrays of data.
Image	DATA	Returns the image data.
Plot	[X], Y [, Z]	Returns Y (if one argument is supplied); X, Y (if two arguments are supplied); X, Y, Z (if three arguments are supplied and it is a 3D plot).
Plot3D	X [, Y] [, Z]	If Y and Z are not supplied, a 3xm array is returned in X.
Polygon	VERTICES	Returns a 3xm array of vertices in device coordinates.
Polyline	VERTICES	Returns a 3xm array of vertices in device coordinates.
Region of Interest (ROI)	VERTICES	Returns a 3xm array of vertices in device coordinates.
Surface	Z	Returns the surface as an mxn array.
Text	STRING	Returns a string containing the text displayed.
Vector	U, V, X, Y	Returns the U and V arrays, and the X and Y vectors.
Volume	VOL0 VOL1 VOL2 VOL3	Returns the 3D volume arrays.

Examples

See the example for IPUTDATA.

Version History


7.1	Introduced