Filters

Many of the standard HDF5 filters are supported. Please see the Filters section for more details about the available filters.

Filters can be configured either for all datasets or for a specific dataset. If you like to configure them for all datasets, create an instance of the H5WriteOptions and add some filters to the pipeline:

using PureHDF.Filters;

var options = new H5WriteOptions(
    Filters:
    [
        ShuffleFilter.Id,
        DeflateFilter.Id
    ]
);

Then pass the options to the H5File.Write method:

file.Write("path/to/file.h5", options);

An alternative is to configure the filter pipeline for a single dataset:

var datasetCreation = new H5DatasetCreation(
    Filters:
    [
        ShuffleFilter.Id,
        DeflateFilter.Id
    ]
)

var dataset = new H5Dataset(..., datasetCreation: datasetCreation);

Parameters

Some filters can be configured to set the compression level or other parameters. The values for these parameters can be provided as a dictionary via the H5Filter class. The dictionary keys are usually constants in the respective filter class. For example, the Blosc2Filter offers the options Blosc2Filter.COMPRESSION_LEVEL and Blosc2Filter.COMPRESSOR_CODE, among others. You can use them like this:

var options = new H5WriteOptions(
    Filters:
    [
        new H5Filter(Id: ShuffleFilter.Id, Options: new() 
        { 
            [Blosc2Filter.COMPRESSION_LEVEL] = 9,
            [Blosc2Filter.COMPRESSOR_CODE] = "blosclz"
        })
    ]
);

file.Write("path/to/file.h5", options);