Compression properties. More...

#include <hlhdf_types.h>

Public Attributes
HL_CompressionType	type
	The wanted compression type.

int	level
	The compression level when using ZLIB compression, compression is indicated by values between 1-9, if set to 0 this will not be seen as compression.

unsigned int	szlib_mask
	Mask when using szlib compression, the mask can be set up from two different sets of options.

unsigned int	szlib_px_per_block
	The block size must be be even, with typical values being 8, 10, 16, and 32.

Detailed Description

Compression properties.

Member Data Documentation

◆ level

int HL_Compression::level

The compression level when using ZLIB compression, compression is indicated by values between 1-9, if set to 0 this will not be seen as compression.

◆ szlib_mask

unsigned int HL_Compression::szlib_mask

Mask when using szlib compression, the mask can be set up from two different sets of options.

H5_SZIP_CHIP_OPTION_MASK	Compresses exactly as in hardware.
H5_SZIP_ALLOW_K13_OPTION_MASK	Allows k split = 13 compression mode. (Default)

H5_SZIP_EC_OPTION_MASK	Selects entropy coding method. (Default)
H5_SZIP_NN_OPTION_MASK	Selects nearest neighbor coding method.

Where the paired options are mutual exclusive, i.e. it is possible to set the szlib_mask to H5_SZIP_CHIP_OPTION_MASK|H5_SZIP_EC_OPTION_MASK but not to H5_SZIP_CHIP_OPTION_MASK|H5_SZIP_ALLOW_K13_OPTION_MASK

◆ szlib_px_per_block

unsigned int HL_Compression::szlib_px_per_block

The block size must be be even, with typical values being 8, 10, 16, and 32.

The more pixel values vary, the smaller this number should be.

◆ type

HL_CompressionType HL_Compression::type

The wanted compression type.

If HL_CompressionType::CT_ZLIB is specified, then level needs to be set. if HL_CompressionType::CT_SZLIB is specified, then szlib_mask and szlib_px_per_block needs to be set.

The documentation for this struct was generated from the following file: