Skip to content

Lab submodules

Lab-specific conventions, available as session.<lab> (e.g. session.petersen from cicada-petersen, session.cossart from cicada-cossart), loaded from the installed packages through the entry-point group cicada_nwb.lab_submodules. A new lab declares its submodule in its own package (see the template).

cicada_nwb.lab_submodules.base.NWBLabSubmodule

Base class for all lab-specific NWB submodules.

name class-attribute instance-attribute

name = 'lab'

grouping_factors classmethod

grouping_factors()

Return a dict {GUI_label: attribute path} for session grouping, shown in the GUI "Group by" dropdown.

The values are attribute paths from the session (read by NWBSession.group_value; a method at the end is called): "." for a method of this submodule, or a standard value.

Example

return { "Session type": "petersen.session_type", "Session description": "metadata.session_description", }