tiled.adapters.hdf5.HDF5Adapter

Read an HDF5 file or a group within one.

This map the structure of an HDF5 file onto a “Tree” of array structures.

Examples

From the root node of a file given a filepath

>>> import h5py
>>> HDF5Adapter.from_uri("file://localhost/path/to/file.h5")

From the root node of a file given an h5py.File object

>>> import h5py
>>> file = h5py.File("path/to/file.h5")
>>> HDF5Adapter.from_file(file)

From a group within a file

>>> import h5py
>>> file = h5py.File("path/to/file.h5")
>>> HDF5Adapter(file["some_group']["some_sub_group"])

__init__(file: Any, *, structure: ArrayStructure | None = None, metadata: Dict[str, str | int | float | bool | Dict[str, Dict[str, str | int | float | bool | Dict[str, JSON] | List[JSON]]] | List[Dict[str, str | int | float | bool | Dict[str, JSON] | List[JSON]]]] | None = None, specs: List[Spec] | None = None) → None[source]

Methods

`__init__`(file, *[, structure, metadata, specs])
`from_catalog`(data_source, node, /[, swmr, ...])
`from_uris`(data_uri, *[, swmr, libver])
`get`(k[,d])
`inlined_contents_enabled`(depth)
`items`()
`keys`()
`metadata`()
`read`([fields])
`search`(query)
`structure`()
`values`()

Attributes