Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


Harris Geospatial / Docs Center / IDL Reference / I/O - HDF / HDF_GR_GETIMINFO

HDF_GR_GETIMINFO

HDF_GR_GETIMINFO

This function retrieves general information about an HDF GR raster image. HDF_GR_GETIMINFO retrieves the name, number of components, data type, interlace mode, dimension sizes, and number of attributes of the raster image identified by the parameter ri_id. It also retrieves the number of attributes attached to the image into the parameter num_attrs.

Syntax


Result = HDF_GR_GETIMINFO(ri_id, gr_name, ncomp, data_type, interlace_mode, dim_sizes, num_attrs)

Return Value


Returns SUCCEED (0) if successful or FAIL (-1) otherwise.

Arguments


ri_id

Raster image identifier returned by HDF_GR_CREATE or HDF_GR_SELECT.

gr_name

A named variable that will contain the name of the raster image.

ncomp

A named variable that will contain the number of components in the raster image.

data_type

A named variable that will contain the data type of the raster image data.

interlace_mode

A named variable that will contain the interlace mode of the stored raster image data.

  • 0 = Pixel interlace
  • 1 = Line interlace
  • 2 = Component interlace

dim_sizes

A named variable that will contain the sizes of the raster image dimensions.

num_attrs

A named variable that will contain the number of attributes attached to the raster image.

Keywords


None

Version History


5.2

Introduced



© 2017 Exelis Visual Information Solutions, Inc. |  Legal
My Account    |    Buy    |    Contact Us