iblrig.transfer_experiments.NeurophotometricsCopier

class iblrig.transfer_experiments.NeurophotometricsCopier

__init__(*args, **kwargs)

initialize_experiment(acquisition_description=None, **kwargs)

static neurophotometrics_description(rois, locations, sync_channel, start_time=None, sync_label=None, collection='raw_photometry_data')

Create the neurophotometrics description part for the specified parameters.

Parameters:

• rois (list of strings) – List of ROIs

• locations (list of strings) – List of brain regions

• sync_channel (int) – Channel number for sync

• start_time (datetime.datetime, optional) – Date and time of the recording

• sync_label (str, optional) – Label for the sync channel

Returns:

Description of the neurophotometrics data {neurophotometrics’: …}, see below for the yaml rendition of dictionaries

Return type:

dict

Parameters:

• rois (Iterable[str])

• locations (Iterable[str])

• sync_channel (int)

• start_time (datetime | None)

• sync_label (str | None)

• collection (str)

Example where bpod sends sync to the neurophotometrics:

neurophotometrics:

fibers: - roi: G0

location: VTA

• roi: G1 location: DR

collection: raw_photometry_data sync_label: bnc1out sync_channel: 1 datetime: 2024-09-19T14:13:18.749259

sync:

bpod

Here MAIN_SYNC=True on behaviour

Example where a DAQ records frame times and sync:

neurophotometrics:

fibers: - roi: G0

location: VTA

• roi: G1 location: DR

collection: raw_photometry_data sync_channel: 5 datetime: 2024-09-19T14:13:18.749259

sync:

daqami:

acquisition_software: daqami collection: raw_sync_data extension: bin

assert_connect_on_init = True

Raise error if unable to write stub file to remote server.

Type:

bool

tag = 'neurophotometrics'

The device name (adds this to the experiment description stub file on the remote server).

Type:

str