Class HDF5

An object representing an HDF5 file.

Inheritance

System.Object

HDF5

Implements

System.IDisposable

Namespace: Tensor

Assembly: Tensor.dll

Syntax

type HDF5
    interface IDisposable

Remarks

HDF5 is an open, cross-plattform, industry-standard file format for data exchange. More information is available at https://www.hdfgroup.org.

This object represents an HDF5 file. Use static member OpenRead: string -> HDF5 and static member OpenWrite: string -> HDF5 to open an HDF5 file for reading or writing.

This object does not aim to expose all functions provided by the HDF5 standard. Instead, it focuses on providing a simple interface for reading and writing arrays as well as attributes.

Methods

Name	Description
member CreateGroups: string -> unit	Creates the given group path.
member Dispose: unit -> unit	Closes the HDF5 file.
member Exists: string -> bool	Checks whether an object (array or group) with the given name exists.
override member Finalize: unit -> unit	Closes the HDF5 file.
member GetAttribute: string * string -> 'T	Get attribute value on an HDF5 object.
member GetDataType: string -> Type	Get data type of array in HDF5 file.
member GetRecord: string -> 'R	Get attribute values on an HDF5 object and returns them as a record.
static member OpenRead: string -> HDF5	Opens the specified HDF5 file for reading.
static member OpenWrite: string -> HDF5	Opens the specified HDF5 file for writing.
member Read: string -> array<'T> * int64 list	Read data array from HDF5 file.
member SetAttribute: string * string * 'T -> unit	Set attribute value on an HDF5 object.
member SetRecord: string * 'R -> unit	Set attribute values on an HDF5 object using the provided record.
member Write: string * array<'T> * int64 list -> unit	Write data array to HDF5 file.

Explicit Interface Implementations

Name	Description
interface IDisposable with member Dispose: unit -> unit	Closes the HDF5 file.