Deep.Net


HDF5

Namespace: Tensor

A HDF5 file.

Constructors

ConstructorDescription
new(path)
Signature: path:string -> HDF5

opens a HDF5 file for reading

CompiledName: .ctor

new(path, mode)
Signature: (path:string * mode:HDF5Mode) -> HDF5

CompiledName: .ctor

Instance members

Instance memberDescription
CreateGroups(path)
Signature: path:string -> unit

Creates the given group path. All necessary parent groups are created automatically. If the group with the given path already exists, nothing happens.

Dispose()
Signature: unit -> unit

closes the HDF5 file

Exists(name)
Signature: name:string -> bool

Checks whether an object (array or group) with the given name exists.

GetAttribute(name, atrName)
Signature: (name:string * atrName:string) -> 'T
Type parameters: 'T

Gets the HDF5 attribute with the specified name on object specified by path.

GetDataType(name)
Signature: name:string -> Type

Returns data type of data array using specified name.

GetRecord(name)
Signature: name:string -> 'R
Type parameters: 'R

Reads the record attached as attributes to the object with name.

Read(name)
Signature: name:string -> 'T array * int64 list
Type parameters: 'T

Read data array using specified name. Returns tuple of data and shape.

SetAttribute(name, atrName, value)
Signature: (name:string * atrName:string * value:'T) -> unit
Type parameters: 'T

Sets the HDF5 attribute with the specified atrName on object specified by name.

SetRecord(name, record)
Signature: (name:string * record:'R) -> unit
Type parameters: 'R

Attaches the specified record as attributes to the object with name.

Write(name, data, shape)
Signature: (name:string * data:'T array * shape:int64 list) -> unit
Type parameters: 'T

Write data array using specified name and shape.

Static members

Static memberDescription
OpenRead(path)
Signature: path:string -> HDF5

opens the specified HDF5 file for reading

OpenWrite(path)
Signature: path:string -> HDF5

Opens the specified HDF5 file for writing. If the file already exists it will be overwritten.

Fork me on GitHub