Interface IH5Dataset

Namespace

PureHDF

Assembly

PureHDF.dll

An HDF5 dataset.

public interface IH5Dataset : IH5Object

Inherited Members

IH5Object.Attributes()

IH5Object.AttributesAsync(CancellationToken)

IH5Object.Attribute(string)

IH5Object.AttributeAsync(string, CancellationToken)

IH5Object.AttributeExists(string)

IH5Object.AttributeExistsAsync(string, CancellationToken)

IH5Object.Name

Properties

FillValue

Gets the fill value.

IH5FillValue FillValue { get; }

Property Value

IH5FillValue

Layout

Gets the data layout.

IH5DataLayout Layout { get; }

Property Value

IH5DataLayout

Space

Gets the data space.

IH5Dataspace Space { get; }

Property Value

IH5Dataspace

Type

Gets the data type.

IH5DataType Type { get; }

Property Value

IH5DataType

Methods

ReadAsync<T>(Selection?, Selection?, ulong[]?, CancellationToken)

Reads the data asynchronously.

Task<T> ReadAsync<T>(Selection? fileSelection = null, Selection? memorySelection = null, ulong[]? memoryDims = null, CancellationToken cancellationToken = default)

Parameters

fileSelection Selection

The selection within the source HDF5 dataset.

memorySelection Selection

The selection within the target memory.

memoryDims ulong[]

The dimensions of the target memory buffer.

cancellationToken CancellationToken

A token to cancel the current operation.

Returns

Task<T>

A task which returns the read data as array of T.

Type Parameters

T

The type of the data to read.

ReadAsync<T>(T, Selection?, Selection?, ulong[]?, CancellationToken)

Reads the data asynchronously into the provided buffer.

Task ReadAsync<T>(T buffer, Selection? fileSelection = null, Selection? memorySelection = null, ulong[]? memoryDims = null, CancellationToken cancellationToken = default)

Parameters

buffer T

The buffer to read the data into.

fileSelection Selection

The selection within the source HDF5 dataset.

memorySelection Selection

The selection within the target memory.

memoryDims ulong[]

The dimensions of the target memory buffer.

cancellationToken CancellationToken

A token to cancel the current operation.

Returns

Task

Type Parameters

T

The type of the data to read.

Read<T>(Selection?, Selection?, ulong[]?)

Reads the data.

T Read<T>(Selection? fileSelection = null, Selection? memorySelection = null, ulong[]? memoryDims = null)

Parameters

fileSelection Selection

The selection within the source HDF5 dataset.

memorySelection Selection

The selection within the destination memory.

memoryDims ulong[]

The dimensions of the destination memory buffer.

Returns

T

The read data as array of T.

Type Parameters

T

The type of the data to read.

Read<T>(T, Selection?, Selection?, ulong[]?)

Reads the data into the provided buffer.

void Read<T>(T buffer, Selection? fileSelection = null, Selection? memorySelection = null, ulong[]? memoryDims = null)

Parameters

buffer T

The buffer to read the data into.

fileSelection Selection

The selection within the source HDF5 dataset.

memorySelection Selection

The selection within the destination memory.

memoryDims ulong[]

The dimensions of the destination memory buffer.

Type Parameters

T

The type of the data to read.