geo3d.io.database¶

Classes¶

`HDF5Dataset`	Class for a dataset (inside of a group) in an HDF5 database.
`HDF5Group`	Class for a group in an HDF5 database.
`HDF5Database`	Class for creating an HDF5 database.

Module Contents¶

class geo3d.io.database.HDF5Dataset(dataset: h5py._hl.dataset.Dataset)¶

Class for a dataset (inside of a group) in an HDF5 database.

_dataset¶

property name: str¶: Return the name of the dataset.

property data: numpy.typing.NDArray¶: Return the data of the dataset.

property attrs: Dict[str, Any]¶: Return the attributes of the dataset.

__repr__() → str¶: Special method for representing the dataset.

class geo3d.io.database.HDF5Group(group: h5py._hl.group.Group)¶

Class for a group in an HDF5 database.

_group¶

property name: str¶: Return the name of the group.

property attrs: Dict[str, Any]¶: Return the attributes of the group.

list_datasets() → List[str]¶: Return the list of datasets in a group.

get_dataset(name: str) → h5py._hl.dataset.Dataset¶

Return a dataset contained in a group.

Parameters:: name (str) – The name of the dataset.
Returns:: The dataset.
Return type:: (Dataset)

__iter__() → Any¶: Iterate over datasets as HDF5Dataset objects.

__repr__() → str¶: Special method for representing the dataset.

class geo3d.io.database.HDF5Database(filepath: str, mode: str = 'r')¶

Class for creating an HDF5 database.

file¶

list_groups() → List[str]¶: Return all top-level groups in the database.

get_group(name: str) → HDF5Group¶

Return a group as an HDF5Group object.

Parameters:: name (str) – The name of the group.
Returns:: The group in the database.
Return type:: HDF5Group

__iter__() → Any¶: Iterate over groups as HDF5Group objects.

close() → None¶: Close the database.

__enter__() → Any¶: Special method to open the database as a context manager.

__exit__(exc_type, exc_value, exc_traceback) → None¶: Special method to close the database as a context manager.

__repr__() → str¶: Special method for representing the database.