Skip to main content

HDF5Group

Represents an HDF5 group.

Use groups to organize datasets and attributes hierarchically.

Example

var f = HDF5File("data.h5", "w")
var g = f.create_group("/runs")
g.write("run1/energy", -1.23)

Constructors

HDF5Group(const HDF5Group group) -> HDF5Group

Copies a group handle.

Parameters

  • group: Group to copy.

Members

NameDescription
create_groupCreates a subgroup.
delete_attributeDeletes an attribute at a relative object path.
delete_datasetDeletes a dataset relative to the group.
delete_groupDeletes a subgroup.
existsChecks whether an object exists relative to the group.
groupOpens or creates a subgroup.
has_attributeChecks whether an attribute exists on the group.
is_datasetChecks whether a relative path is a dataset.
is_groupChecks whether a relative path is a group.
list_attributesLists attribute names on the group.
list_datasetsLists datasets in the group.
list_groupsLists subgroups in the group.
list_objectsLists objects in the group.
moveMoves or renames a group entry relative to the group.
object_typeReturns the object type at a relative path.
open_groupOpens an existing subgroup.
pathReturns the full path of the group.
rankReturns dataset rank for a relative dataset path.
readReads a string scalar dataset relative to the group.
read_attributeReads a string scalar attribute from a relative object path.
shapeReturns dataset dimensions for a relative dataset path.
sizeReturns dataset element count for a relative dataset path.
writeWrites a sparse matrix dataset relative to the group and returns the group for chaining.
write_attributeWrites an attribute on a dataset or subgroup relative to the group.