cedalion.data package

Module contents

Cedalion datasets and utility functions.

cedalion.data.get(fname: str | Path) → Path

Returns the absolute path to a file under cedalion/data/.

cedalion.data.get_ninja_cap_probe()

Load the fullhead Ninja NIRS cap probe.

cedalion.data.get_ninja_uhd_cap_probe()

Load the fullhead Ninja NIRS ultra HD cap probe.

cedalion.data.get_snirf_test_data()

cedalion.data.get_colin27_segmentation(downsampled=False)

Retrieves the Colin27 segmentation dataset, based on Holmes et al. [HHC+98].

cedalion.data.get_colin27_parcel_file()

Retrieves the Colin27 headmodel, based on Holmes et al. [HHC+98].

cedalion.data.get_icbm152_segmentation()

cedalion.data.get_icbm152_parcel_file()

Retrieves the Colin27 headmodel, based on Holmes et al. [HHC+98].

cedalion.data.get_fingertapping() → Recording

Retrieves a finger tapping recording in BIDS format.

Data is from Luke and McAlpine [LM21a]

cedalion.data.get_fingertappingDOT() → Recording

Retrieves a finger tapping DOT example dataset from the IBS Lab.

cedalion.data.get_fingertapping_snirf_path() → Path

cedalion.data.get_multisubject_fingertapping_snirf_paths()

cedalion.data.get_multisubject_fingertapping_path() → Path

cedalion.data.get_photogrammetry_example_scan()

cedalion.data.get_precomputed_fluence(dataset: str, head_model: str) → Path

Precomputed forward model results for examples and documentation.

Parameters:

• dataset – “fingertapping” or “fingertappingDOT”

• head_model – “colin27” or “icbm152”

Returns:

A Path object pointing to the fluence file.

cedalion.data.get_precomputed_sensitivity(

dataset: str,

head_model: str,

) → DataArray

Precomputed sensitivities for examples and documentation.

Parameters:

• dataset – “fingertapping”, “fingertappingDOT”, “nn22_resting”, “ninja_cap_56x144”, “ninja_uhd_cap_164x496”

• head_model – “colin27” or “icbm152”

Returns:

The precomputed sensitivity (Adot) matrix

cedalion.data.get_nn22_resting_state() → Recording

cedalion.data.get_snirf2bids_example_dataset() → tuple[Path, Path]

A dataset for demonstrating the snirf2bids notebook.

Returns:

The path to the downloaded dataset directory and the path to the mapping file with changes that the user would do manually.

cedalion.data.get_fieldtrip_colin27_landmarks() → Annotated[DataArray, DataArraySchema(dims='label', coords='label', 'label', 'type')]