#include "H5public.h"

Data Structures
struct	H5Z_cb_t

struct	H5Z_class2_t

struct	H5Z_class1_t

Macros
#define	H5Z_FILTER_ERROR (-1) /no filter /

#define	H5Z_FILTER_NONE 0 /reserved indefinitely /

#define	H5Z_FILTER_DEFLATE 1 /deflation like gzip /

#define	H5Z_FILTER_SHUFFLE 2 /shuffle the data /

#define	H5Z_FILTER_FLETCHER32 3 /fletcher32 checksum of EDC /

#define	H5Z_FILTER_SZIP 4 /szip compression /

#define	H5Z_FILTER_NBIT 5 /nbit compression /

#define	H5Z_FILTER_SCALEOFFSET 6 /scale+offset compression /

#define	H5Z_FILTER_RESERVED 256 /filter ids below this value are reserved for library use /

#define	H5Z_FILTER_MAX 65535 /maximum filter id /

#define	H5Z_FILTER_ALL 0 /* Symbol to remove all filters in H5Premove_filter */

#define	H5Z_MAX_NFILTERS 32 /* Maximum number of filters allowed in a pipeline */

#define	H5Z_FLAG_DEFMASK 0x00ff /definition flag mask /

#define	H5Z_FLAG_MANDATORY 0x0000 /filter is mandatory /

#define	H5Z_FLAG_OPTIONAL 0x0001 /filter is optional /

#define	H5Z_FLAG_INVMASK 0xff00 /invocation flag mask /

#define	H5Z_FLAG_REVERSE 0x0100 /reverse direction; read /

#define	H5Z_FLAG_SKIP_EDC 0x0200 /skip EDC filters for read /

#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_NN_OPTION_MASK 32

#define	H5_SZIP_MAX_PIXELS_PER_BLOCK 32

#define	H5Z_SHUFFLE_USER_NPARMS 0 /* Number of parameters that users can set */

#define	H5Z_SHUFFLE_TOTAL_NPARMS 1 /* Total number of parameters for filter */

#define	H5Z_SZIP_USER_NPARMS 2 /* Number of parameters that users can set */

#define	H5Z_SZIP_TOTAL_NPARMS 4 /* Total number of parameters for filter */

#define	H5Z_SZIP_PARM_MASK 0 /* "User" parameter for option mask */

#define	H5Z_SZIP_PARM_PPB 1 /* "User" parameter for pixels-per-block */

#define	H5Z_SZIP_PARM_BPP 2 /* "Local" parameter for bits-per-pixel */

#define	H5Z_SZIP_PARM_PPS 3 /* "Local" parameter for pixels-per-scanline */

#define	H5Z_NBIT_USER_NPARMS 0 /* Number of parameters that users can set */

#define	H5Z_SCALEOFFSET_USER_NPARMS 2 /* Number of parameters that users can set */

#define	H5Z_SO_INT_MINBITS_DEFAULT 0

#define	H5Z_CLASS_T_VERS (1)

#define	H5Z_FILTER_CONFIG_ENCODE_ENABLED (0x0001)

#define	H5Z_FILTER_CONFIG_DECODE_ENABLED (0x0002)

Typedefs
typedef int	H5Z_filter_t

typedef enum H5Z_SO_scale_type_t	H5Z_SO_scale_type_t

typedef enum H5Z_EDC_t	H5Z_EDC_t

typedef enum H5Z_cb_return_t	H5Z_cb_return_t

typedef H5Z_cb_return_t(*	H5Z_filter_func_t) (H5Z_filter_t filter, void buf, size_t buf_size, void op_data)

typedef struct H5Z_cb_t	H5Z_cb_t

typedef htri_t(*	H5Z_can_apply_func_t) (hid_t dcpl_id, hid_t type_id, hid_t space_id)

typedef herr_t(*	H5Z_set_local_func_t) (hid_t dcpl_id, hid_t type_id, hid_t space_id)

typedef size_t(*	H5Z_func_t) (unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[], size_t nbytes, size_t buf_size, void *buf)

typedef struct H5Z_class2_t	H5Z_class2_t

typedef struct H5Z_class1_t	H5Z_class1_t

Enumerations
enum	H5Z_SO_scale_type_t { H5Z_SO_FLOAT_DSCALE = 0, H5Z_SO_FLOAT_ESCALE = 1, H5Z_SO_INT = 2 }

enum	H5Z_EDC_t { H5Z_ERROR_EDC = -1, H5Z_DISABLE_EDC = 0, H5Z_ENABLE_EDC = 1, H5Z_NO_EDC = 2 }

enum	H5Z_cb_return_t { H5Z_CB_ERROR = -1, H5Z_CB_FAIL = 0, H5Z_CB_CONT = 1, H5Z_CB_NO = 2 }

Functions
H5_DLL herr_t	H5Zregister (const void *cls)

H5_DLL herr_t	H5Zunregister (H5Z_filter_t id)

H5_DLL htri_t	H5Zfilter_avail (H5Z_filter_t id)

H5_DLL herr_t	H5Zget_filter_info (H5Z_filter_t filter, unsigned int *filter_config_flags)

Macro Definition Documentation

◆ H5_SZIP_ALLOW_K13_OPTION_MASK

#define H5_SZIP_ALLOW_K13_OPTION_MASK 1

Definition at line 70 of file H5Zpublic.h.

◆ H5_SZIP_CHIP_OPTION_MASK

#define H5_SZIP_CHIP_OPTION_MASK 2

Definition at line 71 of file H5Zpublic.h.

◆ H5_SZIP_EC_OPTION_MASK

#define H5_SZIP_EC_OPTION_MASK 4

Definition at line 72 of file H5Zpublic.h.

◆ H5_SZIP_MAX_PIXELS_PER_BLOCK

#define H5_SZIP_MAX_PIXELS_PER_BLOCK 32

Definition at line 74 of file H5Zpublic.h.

◆ H5_SZIP_NN_OPTION_MASK

#define H5_SZIP_NN_OPTION_MASK 32

Definition at line 73 of file H5Zpublic.h.

◆ H5Z_CLASS_T_VERS

#define H5Z_CLASS_T_VERS (1)

Definition at line 104 of file H5Zpublic.h.

◆ H5Z_FILTER_ALL

#define H5Z_FILTER_ALL 0 /* Symbol to remove all filters in H5Premove_filter */

Definition at line 47 of file H5Zpublic.h.

◆ H5Z_FILTER_CONFIG_DECODE_ENABLED

#define H5Z_FILTER_CONFIG_DECODE_ENABLED (0x0002)

Definition at line 116 of file H5Zpublic.h.

◆ H5Z_FILTER_CONFIG_ENCODE_ENABLED

#define H5Z_FILTER_CONFIG_ENCODE_ENABLED (0x0001)

Definition at line 115 of file H5Zpublic.h.

◆ H5Z_FILTER_DEFLATE

#define H5Z_FILTER_DEFLATE 1 /*deflation like gzip */

Definition at line 36 of file H5Zpublic.h.

◆ H5Z_FILTER_ERROR

#define H5Z_FILTER_ERROR (-1) /*no filter */

Definition at line 34 of file H5Zpublic.h.

◆ H5Z_FILTER_FLETCHER32

#define H5Z_FILTER_FLETCHER32 3 /*fletcher32 checksum of EDC */

Definition at line 38 of file H5Zpublic.h.

◆ H5Z_FILTER_MAX

#define H5Z_FILTER_MAX 65535 /*maximum filter id */

Definition at line 44 of file H5Zpublic.h.

◆ H5Z_FILTER_NBIT

#define H5Z_FILTER_NBIT 5 /*nbit compression */

Definition at line 40 of file H5Zpublic.h.

◆ H5Z_FILTER_NONE

#define H5Z_FILTER_NONE 0 /*reserved indefinitely */

Definition at line 35 of file H5Zpublic.h.

◆ H5Z_FILTER_RESERVED

#define H5Z_FILTER_RESERVED 256 /*filter ids below this value are reserved for library use */

Definition at line 42 of file H5Zpublic.h.

◆ H5Z_FILTER_SCALEOFFSET

#define H5Z_FILTER_SCALEOFFSET 6 /*scale+offset compression */

Definition at line 41 of file H5Zpublic.h.

◆ H5Z_FILTER_SHUFFLE

#define H5Z_FILTER_SHUFFLE 2 /*shuffle the data */

Definition at line 37 of file H5Zpublic.h.

◆ H5Z_FILTER_SZIP

#define H5Z_FILTER_SZIP 4 /*szip compression */

Definition at line 39 of file H5Zpublic.h.

◆ H5Z_FLAG_DEFMASK

#define H5Z_FLAG_DEFMASK 0x00ff /*definition flag mask */

Definition at line 57 of file H5Zpublic.h.

◆ H5Z_FLAG_INVMASK

#define H5Z_FLAG_INVMASK 0xff00 /*invocation flag mask */

Definition at line 62 of file H5Zpublic.h.

◆ H5Z_FLAG_MANDATORY

#define H5Z_FLAG_MANDATORY 0x0000 /*filter is mandatory */

Definition at line 58 of file H5Zpublic.h.

◆ H5Z_FLAG_OPTIONAL

#define H5Z_FLAG_OPTIONAL 0x0001 /*filter is optional */

Definition at line 59 of file H5Zpublic.h.

◆ H5Z_FLAG_REVERSE

#define H5Z_FLAG_REVERSE 0x0100 /*reverse direction; read */

Definition at line 63 of file H5Zpublic.h.

◆ H5Z_FLAG_SKIP_EDC

#define H5Z_FLAG_SKIP_EDC 0x0200 /*skip EDC filters for read */

Definition at line 64 of file H5Zpublic.h.

◆ H5Z_MAX_NFILTERS

#define H5Z_MAX_NFILTERS 32 /* Maximum number of filters allowed in a pipeline */

Definition at line 48 of file H5Zpublic.h.

◆ H5Z_NBIT_USER_NPARMS

#define H5Z_NBIT_USER_NPARMS 0 /* Number of parameters that users can set */

Definition at line 89 of file H5Zpublic.h.

◆ H5Z_SCALEOFFSET_USER_NPARMS

#define H5Z_SCALEOFFSET_USER_NPARMS 2 /* Number of parameters that users can set */

Definition at line 92 of file H5Zpublic.h.

◆ H5Z_SHUFFLE_TOTAL_NPARMS

#define H5Z_SHUFFLE_TOTAL_NPARMS 1 /* Total number of parameters for filter */

Definition at line 78 of file H5Zpublic.h.

◆ H5Z_SHUFFLE_USER_NPARMS

#define H5Z_SHUFFLE_USER_NPARMS 0 /* Number of parameters that users can set */

Definition at line 77 of file H5Zpublic.h.

◆ H5Z_SO_INT_MINBITS_DEFAULT

#define H5Z_SO_INT_MINBITS_DEFAULT 0

Definition at line 96 of file H5Zpublic.h.

◆ H5Z_SZIP_PARM_BPP

#define H5Z_SZIP_PARM_BPP 2 /* "Local" parameter for bits-per-pixel */

Definition at line 85 of file H5Zpublic.h.

◆ H5Z_SZIP_PARM_MASK

#define H5Z_SZIP_PARM_MASK 0 /* "User" parameter for option mask */

Definition at line 83 of file H5Zpublic.h.

◆ H5Z_SZIP_PARM_PPB

#define H5Z_SZIP_PARM_PPB 1 /* "User" parameter for pixels-per-block */

Definition at line 84 of file H5Zpublic.h.

◆ H5Z_SZIP_PARM_PPS

#define H5Z_SZIP_PARM_PPS 3 /* "Local" parameter for pixels-per-scanline */

Definition at line 86 of file H5Zpublic.h.

◆ H5Z_SZIP_TOTAL_NPARMS

#define H5Z_SZIP_TOTAL_NPARMS 4 /* Total number of parameters for filter */

Definition at line 82 of file H5Zpublic.h.

◆ H5Z_SZIP_USER_NPARMS

#define H5Z_SZIP_USER_NPARMS 2 /* Number of parameters that users can set */

Definition at line 81 of file H5Zpublic.h.

Typedef Documentation

◆ H5Z_can_apply_func_t

typedef htri_t(* H5Z_can_apply_func_t) (hid_t dcpl_id, hid_t type_id, hid_t space_id)

Definition at line 160 of file H5Zpublic.h.

◆ H5Z_cb_return_t

typedef enum H5Z_cb_return_t H5Z_cb_return_t

◆ H5Z_cb_t

typedef struct H5Z_cb_t H5Z_cb_t

◆ H5Z_class1_t

typedef struct H5Z_class1_t H5Z_class1_t

◆ H5Z_class2_t

typedef struct H5Z_class2_t H5Z_class2_t

◆ H5Z_EDC_t

typedef enum H5Z_EDC_t H5Z_EDC_t

◆ H5Z_filter_func_t

typedef H5Z_cb_return_t(* H5Z_filter_func_t) (H5Z_filter_t filter, void *buf, size_t buf_size, void *op_data)

Definition at line 127 of file H5Zpublic.h.

◆ H5Z_filter_t

typedef int H5Z_filter_t

Definition at line 31 of file H5Zpublic.h.

◆ H5Z_func_t

typedef size_t(* H5Z_func_t) (unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[], size_t nbytes, size_t *buf_size, void **buf)

Definition at line 200 of file H5Zpublic.h.

◆ H5Z_set_local_func_t

typedef herr_t(* H5Z_set_local_func_t) (hid_t dcpl_id, hid_t type_id, hid_t space_id)

Definition at line 183 of file H5Zpublic.h.

◆ H5Z_SO_scale_type_t

typedef enum H5Z_SO_scale_type_t H5Z_SO_scale_type_t

Enumeration Type Documentation

◆ H5Z_cb_return_t

enum H5Z_cb_return_t

Enumerator
H5Z_CB_ERROR
H5Z_CB_FAIL
H5Z_CB_CONT
H5Z_CB_NO

Definition at line 119 of file H5Zpublic.h.

◆ H5Z_EDC_t

enum H5Z_EDC_t

Enumerator
H5Z_ERROR_EDC
H5Z_DISABLE_EDC
H5Z_ENABLE_EDC
H5Z_NO_EDC

Definition at line 107 of file H5Zpublic.h.

◆ H5Z_SO_scale_type_t

enum H5Z_SO_scale_type_t

Enumerator
H5Z_SO_FLOAT_DSCALE
H5Z_SO_FLOAT_ESCALE
H5Z_SO_INT

Definition at line 97 of file H5Zpublic.h.

Function Documentation

◆ H5Zfilter_avail()

H5_DLL htri_t H5Zfilter_avail ( H5Z_filter_t id )

◆ H5Zget_filter_info()

H5_DLL herr_t H5Zget_filter_info	(	H5Z_filter_t	filter,
		unsigned int *	filter_config_flags
	)

◆ H5Zregister()

H5_DLL herr_t H5Zregister ( const void * cls )

◆ H5Zunregister()

H5_DLL herr_t H5Zunregister ( H5Z_filter_t id )

Data Structures

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ H5_SZIP_ALLOW_K13_OPTION_MASK

◆ H5_SZIP_CHIP_OPTION_MASK

◆ H5_SZIP_EC_OPTION_MASK

◆ H5_SZIP_MAX_PIXELS_PER_BLOCK

◆ H5_SZIP_NN_OPTION_MASK

◆ H5Z_CLASS_T_VERS

◆ H5Z_FILTER_ALL

◆ H5Z_FILTER_CONFIG_DECODE_ENABLED

◆ H5Z_FILTER_CONFIG_ENCODE_ENABLED

◆ H5Z_FILTER_DEFLATE

◆ H5Z_FILTER_ERROR

◆ H5Z_FILTER_FLETCHER32

◆ H5Z_FILTER_MAX

◆ H5Z_FILTER_NBIT

◆ H5Z_FILTER_NONE

◆ H5Z_FILTER_RESERVED

◆ H5Z_FILTER_SCALEOFFSET

◆ H5Z_FILTER_SHUFFLE

◆ H5Z_FILTER_SZIP

◆ H5Z_FLAG_DEFMASK

◆ H5Z_FLAG_INVMASK

◆ H5Z_FLAG_MANDATORY

◆ H5Z_FLAG_OPTIONAL

◆ H5Z_FLAG_REVERSE

◆ H5Z_FLAG_SKIP_EDC

◆ H5Z_MAX_NFILTERS

◆ H5Z_NBIT_USER_NPARMS

◆ H5Z_SCALEOFFSET_USER_NPARMS

◆ H5Z_SHUFFLE_TOTAL_NPARMS

◆ H5Z_SHUFFLE_USER_NPARMS

◆ H5Z_SO_INT_MINBITS_DEFAULT

◆ H5Z_SZIP_PARM_BPP

◆ H5Z_SZIP_PARM_MASK

◆ H5Z_SZIP_PARM_PPB

◆ H5Z_SZIP_PARM_PPS

◆ H5Z_SZIP_TOTAL_NPARMS

◆ H5Z_SZIP_USER_NPARMS

Typedef Documentation

◆ H5Z_can_apply_func_t

◆ H5Z_cb_return_t

◆ H5Z_cb_t

◆ H5Z_class1_t

◆ H5Z_class2_t

◆ H5Z_EDC_t

◆ H5Z_filter_func_t

◆ H5Z_filter_t

◆ H5Z_func_t

◆ H5Z_set_local_func_t

◆ H5Z_SO_scale_type_t

Enumeration Type Documentation

◆ H5Z_cb_return_t

◆ H5Z_EDC_t

◆ H5Z_SO_scale_type_t

Function Documentation

◆ H5Zfilter_avail()

◆ H5Zget_filter_info()

◆ H5Zregister()

◆ H5Zunregister()