zea

zea: A Toolbox for Cognitive Ultrasound Imaging.

Classes

Config([dictionary, __parent__])	Config object for managing configuration settings.
Dataloader(file_paths[, key, batch_size, ...])	High-performance HDF5 dataloader built on Grain.
Dataset(file_paths[, validate, ...])	Dataset class managing multiple File objects.
File(name[, mode])	File handler for zea formatted ultrasound files.
Parameters(**kwargs)	Contains and computes all parameters relevant to an ultrasound acquisition.
Pipeline(operations[, with_batch_dim, ...])	Pipeline class for processing ultrasound data through a series of Operation objects.
Probe([name, type, probe_center_frequency, ...])	Probe class which is a container for ultrasound transducer parameters.

Functions

init_device([device, backend, hide_devices, ...])	Automatically selects a GPU or CPU device.
device(device)	Context manager to run operations on a specific device, regardless of backend.
set_data_paths([user_config, local, verify])	Get data paths (absolute paths to location of data).
setup([config_path, user_config, verbose, ...])	General setup function for zea.
setup_config([config_path, verbose, ...])	Setup function for config.

Modules

agent	Agent subpackage for closing action-perception loop in ultrasound imaging.
backend	Backend utilities for zea.
beamform	Beamforming subpackage for ultrasound imaging.
config	Config module for managing configuration settings.
data	Data subpackage for working with the zea data format.
datapaths	Utility functions for handling local data paths.
display	Display functionality, including scan conversion frustrum conversion, etc.
doppler	Doppler functions for processing I/Q ultrasound data.
func	Functional API of zea.
io_lib	Input / output functions for reading and writing files.
log	Custom zea python logging module.
metrics	Metrics for ultrasound images.
models	Collection of (generative) models for ultrasound imaging.
ops	Operations and Pipelines for ultrasound data processing.
probes	Ultrasound probe definitions and the base Probe class.
parameters	Structure containing the parameters defining an ultrasound acquisition.
simulator	Frequency domain ultrasound simulator.
tools	Tooling with external APIs.
tracking	Tracking module.
utils	General utility functions.
visualize	Visualization functions for 2D and 3D ultrasound data.