AQNWB::IO::HDF5::HDF5FilterConfig Class Reference

The configuration for an HDF5 filter. More...

#include <HDF5ArrayDataSetConfig.hpp>

Public Member Functions
	HDF5FilterConfig (H5Z_filter_t filter_id, const std::vector< unsigned int > &cd_values)
	Constructs an HDF5FilterConfig object with the specified filter ID and client data array.

Static Public Member Functions
static HDF5FilterConfig	createGzipFilter (unsigned int level=4)
	Creates a GZIP (DEFLATE) filter configuration.
static HDF5FilterConfig	createShuffleFilter ()
	Creates a Shuffle filter configuration.
static HDF5FilterConfig	createFletcher32Filter ()
	Creates a Fletcher32 checksum filter configuration.
static HDF5FilterConfig	createNbitFilter ()
	Creates an N-Bit filter configuration.

Public Attributes
H5Z_filter_t	filter_id
std::vector< unsigned int >	cd_values

Detailed Description

The configuration for an HDF5 filter.

This class defines the properties of an HDF5 filter, including the filter ID, the number of elements in the client data array, and the client data array itself.

Constructor & Destructor Documentation

HDF5FilterConfig()

HDF5FilterConfig::HDF5FilterConfig	(	H5Z_filter_t	filter_id,
		const std::vector< unsigned int > &	cd_values )

Constructs an HDF5FilterConfig object with the specified filter ID and client data array.

Parameters

filter_id	The ID of the filter.
cd_values	The client data array.

Here is the caller graph for this function:

Member Function Documentation

createFletcher32Filter()

HDF5FilterConfig HDF5FilterConfig::createFletcher32Filter ( )

static

Creates a Fletcher32 checksum filter configuration.

Returns

A HDF5FilterConfig object for the Fletcher32 filter.

Here is the call graph for this function:

createGzipFilter()

HDF5FilterConfig HDF5FilterConfig::createGzipFilter ( unsigned int level = 4 )

static

Creates a GZIP (DEFLATE) filter configuration.

Parameters

level

The compression level (0-9). Default is 4.

Returns

A HDF5FilterConfig object for the GZIP filter.

Here is the call graph for this function:

createNbitFilter()

HDF5FilterConfig HDF5FilterConfig::createNbitFilter ( )

static

Creates an N-Bit filter configuration.

Returns

A HDF5FilterConfig object for the N-Bit filter.

Here is the call graph for this function:

createShuffleFilter()

HDF5FilterConfig HDF5FilterConfig::createShuffleFilter ( )

static

Creates a Shuffle filter configuration.

Returns

A HDF5FilterConfig object for the Shuffle filter.

Here is the call graph for this function:

Member Data Documentation

cd_values

std::vector<unsigned int> AQNWB::IO::HDF5::HDF5FilterConfig::cd_values

filter_id

H5Z_filter_t AQNWB::IO::HDF5::HDF5FilterConfig::filter_id

---

The documentation for this class was generated from the following files:

• src/io/hdf5/HDF5ArrayDataSetConfig.hpp
• src/io/hdf5/HDF5ArrayDataSetConfig.cpp