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_GETCHUNKINFO

HDF_GR_GETCHUNKINFO

HDF_GR_GETCHUNKINFO

This function retrieves chunking information about the HDF GR raster image identified by the parameter ri_id into the parameters dim_length and flag. Note that only chunk dimensions are retrieved; compression information is not available with this function.

Syntax


Result = HDF_GR_GETCHUNKINFO(ri_id, dim_length, flag)

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.

dim_length

A named variable that will contain the array of chunk dimensions.

flag

A named variable that will contain the compression/chunk flag.

The value returned in the parameter flag indicates if the raster image is not chunked, chunked, or chunked and compressed. The following table shows the possible values of the parameter flag and the corresponding characteristics of the raster image.

Values of flag = Raster Image Characteristics

  • -1 = Not chunked
  •  0 = Chunked and not compressed
  •  1 = Chunked and compressed with either the run-length encoding (RLE), Skipping Huffman or GZIP compression algorithms

Keywords


None

Version History


5.2

Introduced



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