Obsolete IDL Features: Obsolete Routines

HDF_DFSD_DIMSET

This routine is obsolete and should not be used in new IDL code.

The HDF_DFSD_DIMSET procedure sets the label, unit, format, or scale of dimensions in an HDF. Note that the label, unit, and format of a dataset must be set simultaneously.

Syntax

HDF_DFSD_DIMSET, Dimension [, FORMAT=string] [, LABEL=string] [, SCALE=vector] [, UNIT=string]

Arguments

Dimension

The dimension number that the label, unit, format or scale apply to.

Keywords

FORMAT

A string for the dimension format. This string should be a standard IDL formatting string.

LABEL

A string for the dimension label.

SCALE

A vector of values used to set the dimension scale.

UNIT

A string for the dimension units.

Example

Suppose that a stored dataset is a 20 by 100 by 50 element floating-point array of values representing water content within the volume of a cloud. Assume further that each element in the 100-element dimension (the "Y" dimension) was sampled at 1/10 mile increments. Appropriate labeling, formatting, unit, and scaling information for the Y dimension can be set with the following command:

HDF_DFSD_DIMSET, 1, LABEL = 'Y Position', FORMAT = 'F8.2', $  
   UNIT = 'Miles', SCALE = 0.1*FINDGEN(100)