H5Base

H5Base

Base class for HDF5 objects.

Constructor

new H5Base(file, name)

Source:
Parameters:
Name Type Description
file string

Path to the HDF5 file.
name string

Name of the object inside the file.

Classes

H5Base

Members

attributes :Array

Source:

Array containing the names of all attributes of this object.

Type:
  • Array

file :string

Source:

Path to the HDF5 file.

Type:
  • string

name :string

Source:

Name of the object inside the file.

Type:
  • string

Methods

readAttribute(attr) → {object}

Source:

Read an attribute of the object.

Parameters:
Name Type Description
attr string

Name of the attribute.
Returns:

Object containing the attribute values and the shape of the attribute. For HDF5 enums, an additional level property is present, containing the levels indexed by the integer values.

Type
object

writeAttribute(attr, type, shapenullable, x, optionsopt)

Source:

Write an attribute for the object.

Parameters:
Name Type Attributes Default Description
attr string

Name of the attribute.
type string

Type of dataset to create. This can be "IntX" or "UintX" for X of 8, 16, 32, or 64; or "FloatX" for X of 32 or 64; or "String"; or "Enum".
shape Array <nullable>

Array containing the dimensions of the dataset to create. If set to an empty array, this will create a scalar dataset. If set to null, this is determined from x.
x TypedArray | Array | string | number

Values to be written to the new dataset, see write. This should be of length equal to the product of shape; unless shape is empty, in which case it should either be of length 1, or a single number or string.
options object <optional>
 {}

Optional parameters.

Properties
Name Type Attributes Default Description
maxStringLength number <optional>
<nullable>
 null

Maximum length of the strings to be saved. Only used when type = "String". If null, this is inferred from the maximum length of strings in x.
levels Array <optional>
<nullable>
 null

Array of strings containing enum levels when type = "Enum". If supplied, x should be an array of integers that index into levels. Alternatively, levels may be null, in which case x should be an array of strings that is used to infer levels.