zea.data¶

Data subpackage for working with the zea data format.

This subpackage provides core classes and utilities for working with the zea data format, including file and dataset access, validation, and data loading. For more information on the zea data format, see Data.

Main classes¶

zea.data.File – Open and access a single zea HDF5 data file.
zea.data.Dataset – Manage and iterate over a collection of zea data files.

See the data notebook for a more detailed example: Working with the zea data format

Examples usage¶

from zea import File, Dataset

# Open a single zea data file
with File("path/to/file.hdf5", mode="r") as file:
    file.summary()
    data = file.load_data("raw_data", indices=[0])
    scan = file.scan()
    probe = file.probe()

# Work with a dataset (folder or list of files)
dataset = Dataset("path/to/folder", key="raw_data")
for file in dataset:
    print(file)
dataset.close()

Subpackage layout¶

file.py: Implements zea.File and related file utilities.
datasets.py: Implements zea.Dataset and folder management.
dataloader.py: Data loading utilities for batching and shuffling.
data_format.py: Data validation and example dataset generation.
convert/: Data conversion tools (e.g., from external formats).

Modules

`augmentations`	Augmentation layers for ultrasound data.
`convert`	All functions in this module are used to convert different datasets to the zea format.
`data_format`	Functions to write and validate datasets in the zea format.
`dataloader`	H5 dataloader for loading images from zea datasets.
`datasets`	zea.data.datasets
`file`	zea H5 file functionality.
`layers`	Keras layers for data preprocessing.
`preset_utils`	Preset utils for zea datasets hosted on Hugging Face.
`utils`	Utility functions for zea datasets.