allensdk.brain_observatory.behavior.session_apis.abcs.data_extractor_base.behavior_data_extractor_base module

class allensdk.brain_observatory.behavior.session_apis.abcs.data_extractor_base.behavior_data_extractor_base.BehaviorDataExtractorBase

Bases: abc.ABC

Abstract base class implementing required methods for extracting data (from LIMS or from JSON) that will be transformed or passed on to fill behavior session data.

get_age(self) → str

Get the age code of the subject (ie P123)

get_behavior_session_id(self) → int

Get the ID of the behavior session

get_behavior_stimulus_file(self) → str

Get the filepath to the StimulusPickle file for the session

get_date_of_acquisition(self) → datetime.datetime

Get the acquisition date of an experiment in UTC

get_driver_line(self) → List[str]

Get the (gene) driver line(s) for the subject associated with a behavior or behavior + ophys experiment

get_equipment_name(self) → str

Get the name of the experiment rig (ex: CAM2P.3)

get_foraging_id(self) → int

Get the foraging ID for the behavior session

get_full_genotype(self) → str

Get the full genotype of the subject associated with a behavior or behavior + ophys experiment

get_mouse_id(self) → int

Get the mouse id (LabTracks ID) for the subject associated with a behavior experiment

get_reporter_line(self) → List[str]

Get the (gene) reporter line(s) for the subject associated with a behavior or behavior + ophys experiment

get_sex(self) → str

Get the sex of the subject (ex: ‘M’, ‘F’, or ‘unknown’)

get_stimulus_name(self) → str

Get the stimulus set used from the behavior session pkl file :rtype: str