Interface IH5Filter

Namespace

PureHDF.Filters

Assembly

PureHDF.dll

Represents an HDF5 filter.

public interface IH5Filter

Properties

FilterId

The filter identifier.

ushort FilterId { get; }

Property Value

ushort

Name

The filter name.

string Name { get; }

Property Value

string

Methods

Filter(FilterInfo)

The filter function.

Memory<byte> Filter(FilterInfo info)

Parameters

info FilterInfo

Additional information for the filter process.

Returns

Memory<byte>

The filtered data.

GetParameters(uint[], uint, Dictionary<string, object>?)

Returns the filter parameters being stored in the HDF5 file and which will be provided to the filter function. This method is only required for the PureHDF write API.

uint[] GetParameters(uint[] chunkDimensions, uint typeSize, Dictionary<string, object>? options)

Parameters

chunkDimensions uint[]

The chunk dimensions.

typeSize uint

The size of the data type.

options Dictionary<string, object>

The user defined map of filter options.

Returns

uint[]

The filter parameters.