HDF_DF24_GETINFO

The HDF_DF24_GETINFO procedure retrieves information about the current 24-bit HDF image.

Syntax

HDF_DF24_GETINFO, Filename, Width, Height, Interlace

Arguments

Filename

A string containing the name of the file to be read.

Width

A named variable in which the width of the image is returned.

Height

A named variable in which the height of the image is returned.

Interlace

A named variable in which the interface method is returned. The returned value is 0 for pixel interlacing, 1 for scan-line interlacing, and 2 for scan-plane interlacing.

Keywords

None

Examples

; Open the file myhdf.hdf: 
h = HDF_OPEN('myhdf.hdf') 
; Return information about the 24-bit image: 
HDF_DF24_GETINFO, 'myhdf.hdf', width, height, interlace 
; Print information about the returned variables:  
HELP, width, height, interlace 
HDF_CLOSE('myhdf.hdf') ; Close the HDF file.

IDL Output

If the image were 536 by 412 pixels, and scan-line interlaced, IDL would print:

WIDTH LONG = 536 HEIGHT LONG = 412 INTERLACE LONG = 1

Example Code
For a more detailed example, see the file hdf_info.pro, located in the examples/doc/sdf subdirectory of the IDL distribution. Run the example procedure by entering hdf_info at the IDL command prompt or view the file in an IDL Editor window by entering .EDIT hdf_info.pro.

Version History


4.0	Introduced