CalciumImagingDatasetMixin#

class torch_brain.dataset.CalciumImagingDatasetMixin[source]#

Bases: object

Mixin class for torch_brain.dataset.Dataset subclasses containing calcium imaging data.

Provides:

  • get_roi_ids() for retrieving IDs of all included ROIs.

  • If the class attribute calcium_imaging_dataset_mixin_uniquify_roi_ids is set to True, ROI IDs will be made unique across recordings by prefixing each ROI ID with the corresponding session.id. This helps avoid collisions when combining data from multiple sessions. (default: False)

get_roi_ids()[source]#

Return a sorted list of all ROI IDs across all recordings in the dataset.

Return type:

list[str]