Module H5Z

Filter API and constants.

h5py.h5z.filter_avail(INT filter_code) → BOOL

Determine if the given filter is available to the library. The filter code should be one of:

h5py.h5z.get_filter_info(INT filter_code) → INT filter_flags

Retrieve a bitfield with information about the given filter. The filter code should be one of:

Valid bitmasks for use with the returned bitfield are:

h5py.h5z.register_filter(INT cls_pointer_address) → BOOL

Register a new filter from the memory address of a buffer containing a H5Z_class1_t or H5Z_class2_t data structure describing the filter.

cls_pointer_address can be retrieved from a HDF5 filter plugin dynamic library:

import ctypes

filter_clib = ctypes.CDLL("/path/to/my_hdf5_filter_plugin.so")
filter_clib.H5PLget_plugin_info.restype = ctypes.c_void_p

h5py.h5z.register_filter(filter_clib.H5PLget_plugin_info())
h5py.h5z.unregister_filter(INT filter_code) → BOOL

Unregister a filter

Module constants

Predefined filters

h5py.h5z.FILTER_NONE
h5py.h5z.FILTER_ALL
h5py.h5z.FILTER_DEFLATE
h5py.h5z.FILTER_SHUFFLE
h5py.h5z.FILTER_FLETCHER32
h5py.h5z.FILTER_SZIP
h5py.h5z.FILTER_SCALEOFFSET
h5py.h5z.FILTER_LZF

Filter flags

h5py.h5z.FLAG_DEFMASK
h5py.h5z.FLAG_MANDATORY
h5py.h5z.FLAG_OPTIONAL
h5py.h5z.FLAG_INVMASK
h5py.h5z.FLAG_REVERSE
h5py.h5z.FLAG_SKIP_EDC

SZIP-specific options

h5py.h5z.SZIP_ALLOW_K13_OPTION_MASK
h5py.h5z.SZIP_CHIP_OPTION_MASK
h5py.h5z.SZIP_EC_OPTION_MASK
h5py.h5z.SZIP_NN_OPTION_MASK
h5py.h5z.SZIP_MAX_PIXELS_PER_BLOCK

Scale/offset-specific options

h5py.h5z.SO_FLOAT_DSCALE
h5py.h5z.SO_FLOAT_ESCALE
h5py.h5z.SO_INT
h5py.h5z.SO_INT_MINBITS_DEFAULT

Other flags

h5py.h5z.FILTER_CONFIG_ENCODE_ENABLED
h5py.h5z.FILTER_CONFIG_DECODE_ENABLED
h5py.h5z.DISABLE_EDC
h5py.h5z.ENABLE_EDC
h5py.h5z.NO_EDC