HDFSETNT Function

Computes and sets the HDF number type (i.e., data type) and descriptive number type string for the specified data array.

Restriction: See "Supported Platforms Guide" on the PV-WAVE Documentation website to check if this function is available on your operating system.

Usage

status = HDFSETNT (data)

Input Parameters

data—An array containing data for a Scientific Data Set. Must be a numeric PV‑WAVE data type.

Return Value

status—The status of the function call, where:

SUCCEED (0)—Indicates success.
FAIL (–1)—Indicates failure.

Keywords

Help—If present and nonzero, lists the usage for this routine.

Name—HDF SDS numeric data type as a string, e.g., “DFNT_FLOAT32”. This keyword is more for human use than programmatic use.

Type—HDF Scientific Data Set numeric data type. The range of possible values are defined in HDF_COMMON:

DFNT_FLOAT32
DFNT_FLOAT64
DFNT_INT8
DFNT_UINT8
DFNT_INT16
DFNT_UINT16
DFNT_INT32
DFNT_UINT32

Usage—If present and nonzero, lists the usage for this routine. (Same as the Help keyword.)

Discussion

HDFSETNT gets the current HDF Scientific Data Set numeric type (data type) for the specified data array (data). Additionally, the SDS numeric type is set using DFSDSETNT. Keywords are optionally set if you want to explicitly know the HDF SDS numeric type set as an INTEGER (type) or a string (name).

Example

hdf_init
@hdf_common
data = INDGEN (6, 8, 7)
status = HDFSETNT(data)
IF (status EQ FAIL) THEN  $
   MESSAGE, 'Failed HDFSETNT for SDS set annotation test.'