SpikingDatasetMixin#

class torch_brain.dataset.SpikingDatasetMixin[source]#

Bases: object

Mixin class for torch_brain.dataset.Dataset subclasses containing spiking data.

Provides:

  • get_unit_ids() for retrieving IDs of all included units.

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

get_unit_ids()[source]#

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

Return type:

list[str]

compute_average_firing_rates()[source]#

Compute and return the average firing rates for all units in the dataset.

Returns:

DataFrame indexed by unit ID, containing a column ‘firing_rate’ (Hz)

with the average firing rate for each unit in the dataset.

Return type:

pd.DataFrame