Data structures and I/O

Cedalion builds on existing python packages for handling scientific data (such as numpy and xarray), but it also defines several data structures for working with fNIRS data in particular. It provides I/O functions for reading and writing data in various formats.

Data structures

cedalion.dataclasses	Data classes used throughout cedalion.
cedalion.typing	Type aliases for Cedalion dataclasses.
cedalion.validators	Validators for common data structures.
cedalion.physunits	Builds on pint_xarray's unit registry.

Utilities

cedalion.xrutils

Utility functions for xarray objects.

I/O

cedalion.io.snirf	Contains functionality for handling .snirf files.
cedalion.io.anatomy	Functions for reading and processing anatomical data.
cedalion.io.bids	Functions for reading BIDS data.
cedalion.io.forward_model	Module for saving and loading forward model computation results.
cedalion.io.photogrammetry	Module for reading photogrammetry output file formats.
cedalion.io.probe_geometry	Module for reading and writing probe geometry files.
cedalion.datasets	Cedalion datasets and utility functions.

Examples

Xarray Data Structures - an fNIRS example

The Recording Container: Cedalion’s main data structure and a guide to indexing

Data Structures and I/O

Storing estimated HRFs in snirf files