HDFGET24 Function

Obtains an HDF Raster 24 image.

Usage

status = HDFGET24 (filename, image)

Input Parameters

filename

The name of the HDF file.

Output Parameters

image

A byte array into which the HDF Raster 24 image is placed.

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.

Interlace Set the HDF interlace scheme to use in reading the image. Possible values include:

DFIL_PIXEL

DFIL_LINE

DFIL_PLANE

The default will be the interlace scheme used when the image was written to the file.

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

Discussion

HDFGET24 obtains an HDF Raster 24 image from the named HDF file. HDFGET24 reads the current (or first) Raster 24 image in the file and positions the HDF active pointer to the next Raster 24 image. You can read all Raster 24 images in an HDF file using successive calls to HDFGET24. The return status is set to FAIL when the function reads beyond the last Raster 24 image.

Example

testfile = 'raster24.hdf'
status = DF24RESTART()
IF (status EQ FAIL) THEN $

MESSAGE, 'Failed at DF24restart for'+$ 'HDFGET24.'

status = HDFGET24(testfile, image, $ interlace=DFIL_PIXEL)
IF (status EQ FAIL) THEN $

MESSAGE, 'HDFGET24 failed.'

TV, image, True=1

See Also

HDFGETR8

HDFPUT24

Also refer to the following routines in the HDF Reference Manual:

DF24GETDIMS, DF24GETIMAGE, DF24READREF, DF24RESTART, HISHDF

For more information on using the HDF interface and the calling sequence for the entire suite of HDF base functions, refer to Appendix , The PV-WAVE HDF Interface.

For a complete list of the HDF convenience routines, refer to Chapter 1, Functional Summary of Routines.

doc@boulder.vni.com

Copyright © 1999, Visual Numerics, Inc. All rights reserved.