"""
Created on Sunday July 15 2018
@author: marinag
"""
from typing import Dict, Optional, List, Union
from allensdk.brain_observatory.sync_dataset import \
Dataset as SyncDataset
import numpy as np
[docs]def get_raw_stimulus_frames(
dataset: SyncDataset,
permissive: bool = False
) -> np.ndarray:
""" Report the raw timestamps of each stimulus frame. This corresponds to
the time at which the psychopy window's flip method returned, but not
necessarily to the time at which the stimulus frame was displayed.
Parameters
----------
dataset : describes experiment timing
permissive : If True, None will be returned if timestamps are not found.
If False, a KeyError will be raised
Returns
-------
array of timestamps (floating point; seconds; relative to experiment
start).
"""
try:
return dataset.get_edges(kind="falling",
keys=["vsync_stim", "stim_vsync"],
units="seconds")
except KeyError:
if not permissive:
raise
return
[docs]def get_ophys_frames(
dataset: SyncDataset,
permissive: bool = False
) -> np.ndarray:
""" Report the timestamps of each optical physiology video frame
Parameters
----------
dataset : describes experiment timing
permissive : If True, None will be returned if timestamps are not found.
If False, a KeyError will be raised
Returns
-------
array of timestamps (floating point; seconds; relative to experiment
start).
Notes
-----
use rising edge for Scientifica, falling edge for Nikon
http://confluence.corp.alleninstitute.org/display/IT/Ophys+Time+Sync
This function uses rising edges
"""
try:
return dataset.get_edges(kind="rising",
keys=["vsync_2p", "2p_vsync"],
units="seconds")
except KeyError:
if not permissive:
raise
return
[docs]def get_lick_times(
dataset: SyncDataset,
permissive: bool = False
) -> Optional[np.ndarray]:
""" Report the timestamps of each detected lick
Parameters
----------
dataset : describes experiment timing
permissive : If True, None will be returned if timestamps are not found.
If False, a KeyError will be raised
Returns
-------
array of timestamps (floating point; seconds; relative to experiment
start)
or None. If None, no lick timestamps were found in this sync
dataset.
"""
return dataset.get_edges(
"rising", ["lick_times", "lick_sensor"], "seconds", permissive)
[docs]def get_stim_photodiode(
dataset: SyncDataset,
permissive: bool = False
) -> Optional[List[float]]:
""" Report the timestamps of each detected sync square transition (both
black -> white and white -> black) in this experiment.
Parameters
----------
dataset : describes experiment timing
permissive : If True, None will be returned if timestamps are not found.
If False, a KeyError will be raised
Returns
-------
array of timestamps (floating point; seconds; relative to experiment
start) or None. If None, no photodiode timestamps were found in this sync
dataset.
"""
return dataset.get_edges(
"all", ["stim_photodiode", "photodiode"], "seconds", permissive)
[docs]def get_trigger(
dataset: SyncDataset,
permissive: bool = False
) -> Optional[np.ndarray]:
""" Returns (as a 1-element array) the time at which optical physiology
acquisition was started.
Parameters
----------
dataset : describes experiment timing
permissive : If True, None will be returned if timestamps are not found.
If False, a KeyError will be raised
Returns
-------
timestamps (floating point; seconds; relative to experiment start)
or None. If None, no timestamps were found in this sync dataset.
Notes
-----
Ophys frame timestamps can be recorded before acquisition start when
experimenters are setting up the recording session. These do not
correspond to acquired ophys frames.
"""
keys = ["2p_trigger", "acq_trigger", "2p_acq_trigger", "2p_acquiring",
"stim_running"]
return dataset.get_edges(kind="rising",
keys=keys,
units="seconds",
permissive=permissive)
[docs]def get_eye_tracking(
dataset: SyncDataset,
permissive: bool = False
) -> Optional[np.ndarray]:
""" Report the timestamps of each frame of the eye tracking video
Parameters
----------
dataset : describes experiment timing
permissive : If True, None will be returned if timestamps are not found.
If False, a KeyError will be raised
Returns
-------
array of timestamps (floating point; seconds; relative to experiment
start) or None. If None, no eye tracking timestamps were found in this
sync dataset.
"""
keys = ["cam2_exposure", "eye_tracking", "eye_frame_received"]
return dataset.get_edges(kind="rising",
keys=keys,
units="seconds",
permissive=permissive)
[docs]def get_behavior_monitoring(
dataset: SyncDataset,
permissive: bool = False
) -> Optional[np.ndarray]:
""" Report the timestamps of each frame of the behavior
monitoring video
Parameters
----------
dataset : describes experiment timing
permissive : If True, None will be returned if timestamps are not found.
If False, a KeyError will be raised
Returns
-------
array of timestamps (floating point; seconds; relative to experiment
start) or None. If None, no behavior monitoring timestamps were found in
this sync dataset.
"""
keys = ["cam1_exposure", "behavior_monitoring", "beh_frame_received"]
return dataset.get_edges(kind="rising",
keys=keys,
units="seconds",
permissive=permissive)
[docs]def get_sync_data(
sync_path: str,
permissive: bool = False
) -> Dict[str, Union[List, np.ndarray, None]]:
""" Convenience function for extracting several timestamp arrays from a
sync file.
Parameters
----------
sync_path : The hdf5 file here ought to be a Visual Behavior sync output
file. See allensdk.brain_observatory.sync_dataset for more details of
this format.
permissive : If True, None will be returned if timestamps are not found.
If False, a KeyError will be raised
Returns
-------
A dictionary with the following keys. All timestamps in seconds:
ophys_frames : timestamps of each optical physiology frame
lick_times : timestamps of each detected lick
ophys_trigger : The time at which ophys acquisition was started
eye_tracking : timestamps of each eye tracking video frame
behavior_monitoring : timestamps of behavior monitoring video frame
stim_photodiode : timestamps of each photodiode transition
stimulus_times_no_delay : raw stimulus frame timestamps
Some values may be None. This indicates that the corresponding timestamps
were not located in this sync file.
"""
sync_dataset = SyncDataset(sync_path)
return {
'ophys_frames': get_ophys_frames(sync_dataset, permissive),
'lick_times': get_lick_times(sync_dataset, permissive),
'ophys_trigger': get_trigger(sync_dataset, permissive),
'eye_tracking': get_eye_tracking(sync_dataset, permissive),
'behavior_monitoring': get_behavior_monitoring(sync_dataset,
permissive),
'stim_photodiode': get_stim_photodiode(sync_dataset, permissive),
'stimulus_times_no_delay': get_raw_stimulus_frames(sync_dataset,
permissive)
}