iblrig.neurophotometrics.init_neurophotometrics_subject

iblrig.neurophotometrics.init_neurophotometrics_subject(session_stub, rois, locations, sync_channel=1, **kwargs)[source]

Initialize a neurophotometrics behavior session. This should happen after the neurophotometrics recording has been started. - Creates a new folder for the session on the photometry computer. - Creates a new experiment description file in the session folder. - Copies the experiment description stub to the server

Parameters:

  • session_stub (str) – The name of the subject for this session.

  • rois (Iterable[str]) – List of ROIs to be recorded.

  • locations (Iterable[str]) – List of brain locations to be recorded.

  • sync_channel (int, optional) – Channel to use for syncing photometry and digital inputs, by default 1

  • kwargs (dict, optional) – Additional keyword arguments to be passed to the NeurophotometricsCopier.neurophotometrics_description method.

Returns:

An instance of the NeurophotometricsCopier class initialized with the provided session details.

Return type:

NeurophotometricsCopier

Parameters: