Predefined iTool Data Classes

The iTool system distributed with IDL includes a number of predefined data classes. The predefined classes are subclasses of the IDLitData class; each performs initialization steps that are commonly used when creating data objects that contain data of specific composite data types. Some of the predefined data classes create data sub-containers to hold associated data objects, and some register properties associated with the data.

Note
The predefined iTool data subclasses are provided as a convenience. You can always create a generic IDLitData object rather than using one of the predefined classes.

You can create objects of these data classes in the same way you create a generic data object: by calling the OBJ_NEW function and specifying the appropriate class name. You can also create new specialized data classes based on one of the predefined classes. Data classes are located in the lib/itools/components subdirectory of the IDL directory.

IDLitDataIDLArray2D

Creates an IDLitData object of whose TYPE property is set to IDLARRAY2D. Used to store a two-dimensional array of any IDL data type.

Registered Properties

None

Data Sub-containers

None

IDLitDataIDLArray3D

Creates an IDLitData object of whose TYPE property is set to IDLARRAY3D. Used to store a three-dimensional array of any IDL data type.

Registered Properties

None

Data Sub-containers

None

IDLitDataIDLImage

Creates an IDLitData object of whose TYPE property is set to IDLIMAGE. Used to store two-dimensional image data. Images can be constructed from multiple image planes.

Registered Properties

INTERLEAVE

Data Sub-containers

An IDLitDataIDLPalette object named "Palette" that contains palette information provided as an argument to the Init method.

An IDLitDataIDLImagePixels object named "Image Planes" that contains the image data provided as an argument to the Init method.

IDLitDataIDLImagePixels

Creates an IDLitData object of whose TYPE property is set to IDLIMAGEPIXELS. Used to store the raw image data (pixels).

Registered Properties

INTERLEAVE

Data Sub-containers

None

IDLitDataIDLPalette

Creates an IDLitData object of whose TYPE property is set to IDLPALETTE. Used to store palette data.

Registered Properties

None

Data Sub-containers

None

IDLitDataIDLPolyvertex

Creates an IDLitData object of whose TYPE property is set to IDLPOLYVERTEX. Used to store vertex and connectivity lists suitable for use with the IDLgrPolygon and IDLgrPolyline objects.

Registered Properties

None

Data Sub-containers

An IDLitData object named "Vertices" (IDLVERTEX) that contains the vertex list.

An IDLitData object named "Connectivity" (IDLCONNECTIVITY) that contains the connectivity list.

IDLitDataIDLVector

Creates an IDLitData object of whose TYPE property is set to IDLVECTOR. Used to store a one-dimensional array of any IDL data type.

Registered Properties

None

Data Sub-containers

None