Help us improve by taking our short survey: https://www.hdfgroup.org/website-survey/

| HDF5 Last Updated on 2026-03-23 The HDF5 Field Guide

Loading...
Searching...
No Matches
Szip Filter
Filters (H5Z) » Predefined Filters

## Detailed Description

## Macros
#define | H5_SZIP_ALLOW_K13_OPTION_MASK 1
#define | H5_SZIP_CHIP_OPTION_MASK 2
#define | H5_SZIP_EC_OPTION_MASK 4
#define | H5_SZIP_MAX_PIXELS_PER_BLOCK 32
#define | H5_SZIP_NN_OPTION_MASK 32
#define | H5Z_SZIP_PARM_BPP 2
#define | H5Z_SZIP_PARM_MASK 0
#define | H5Z_SZIP_PARM_PPB 1
#define | H5Z_SZIP_PARM_PPS 3
#define | H5Z_SZIP_TOTAL_NPARMS 4
#define | H5Z_SZIP_USER_NPARMS 2

## Macro Definition Documentation

## ◆ H5_SZIP_ALLOW_K13_OPTION_MASK

#define H5_SZIP_ALLOW_K13_OPTION_MASK 1

Used internally. Always added to the `options_mask` parameter of H5Pset_szip().

## ◆ H5_SZIP_CHIP_OPTION_MASK

#define H5_SZIP_CHIP_OPTION_MASK 2

Used internally. Always removed from the `options_mask` parameter of H5Pset_szip().

## ◆ H5_SZIP_EC_OPTION_MASK

#define H5_SZIP_EC_OPTION_MASK 4

Use the entropy coding method

## ◆ H5_SZIP_MAX_PIXELS_PER_BLOCK

#define H5_SZIP_MAX_PIXELS_PER_BLOCK 32

The maximum number of pixels per block (see H5Pset_szip())

## ◆ H5_SZIP_NN_OPTION_MASK

#define H5_SZIP_NN_OPTION_MASK 32

Use nearest neighbor preprocessing and then the entropy coding method

## ◆ H5Z_SZIP_PARM_BPP

#define H5Z_SZIP_PARM_BPP 2

"Local" parameter for bits-per-pixel

Since
  1.6.8

## ◆ H5Z_SZIP_PARM_MASK

#define H5Z_SZIP_PARM_MASK 0

"User" parameter for option mask

Since
  1.6.8

## ◆ H5Z_SZIP_PARM_PPB

#define H5Z_SZIP_PARM_PPB 1

"User" parameter for pixels-per-block

Since
  1.6.8

## ◆ H5Z_SZIP_PARM_PPS

#define H5Z_SZIP_PARM_PPS 3

"Local" parameter for pixels-per-scanline

Since
  1.6.8

## ◆ H5Z_SZIP_TOTAL_NPARMS

#define H5Z_SZIP_TOTAL_NPARMS 4

Total number of parameters for SZIP filter

Since
  1.6.8

## ◆ H5Z_SZIP_USER_NPARMS

#define H5Z_SZIP_USER_NPARMS 2

Number of parameters that users can set for SZIP

Since
  1.6.8