iblrig.neurophotometrics.neurophotometrics_description

iblrig.neurophotometrics.neurophotometrics_description(rois, locations, sync_channel, start_time=None, sync_label=None, sync_mode='bpod', collection='raw_photometry_data', validate=True)[source]

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

  • sync_mode, str, opional – defines the sync mode (e.g. using the FP3002 inputs as sync inputs, or as outputs to sync the DAQ)

Returns:

Description of the neurophotometrics data

Return type:

dict

Parameters:

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_mode: bpod

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: 1 datetime: 2024-09-19T14:13:18.749259 sync_mode: daqami sync_metadata:

acquisition_software: daqami collection: raw_photometry_data frameclock_channel: 0