HDF_GR_SETCHUNK

Syntax | Return Value | Arguments | Keywords | Version History

This function makes the HDF GR raster image specified by the parameter ri_id a chunked raster image according to the chunking and compression information provided in the parameters comp_type and comp_prm. Data can be compressed using run-length encoding (RLE), Skipping Huffman or GZIP compression algorithms.

Syntax

Result = HDF_GR_SETCHUNK(ri_id, dim_length, comp_type, comp_prm)

Return Value

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

Arguments

ri_id

Raster image identifier returned by HDF_GR_CREATE or HDF_GR_SELECT.

dim_length

Chunk dimensions array.

comp_type

Type of compression. Valid types are:

0 = uncompressed data

1 = data compressed using the RLE compression algorithm

3 = data compressed using the Skipping Huffman compression algorithm

4 = data compressed using the GZIP compression algorithm.

comp_prm

Compression parameters array. Specifies the compression parameters for the Skipping Huffman and GZIP compression methods. It contains only one element, which is set to the skipping size for Skipping Huffman compression or the deflate level for GZIP compression (1-9).

Keywords

None

Version History


5.2	Introduced