Class NbitFilter

Namespace

PureHDF.Filters

Assembly

PureHDF.dll

N-Bit filter.

public class NbitFilter : IH5Filter

Inheritance

object

NbitFilter

Implements

IH5Filter

Constructors

NbitFilter()

public NbitFilter()

Fields

Id

The N-Bit filter identifier.

public const ushort Id = 5

Field Value

ushort

Properties

FilterId

The filter identifier.

public ushort FilterId { get; }

Property Value

ushort

Name

The filter name.

public string Name { get; }

Property Value

string

Methods

Filter(FilterInfo)

The filter function.

public 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.

public 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.