allensdk.brain_observatory.behavior.data_objects.metadata.behavior_metadata.date_of_acquisition module

class allensdk.brain_observatory.behavior.data_objects.metadata.behavior_metadata.date_of_acquisition.DateOfAcquisition(date_of_acquisition: datetime)

Bases: DataObject, LimsReadableInterface, JsonReadableInterface, NwbReadableInterface

timestamp for when experiment was started in UTC

classmethod from_json(dict_repr: dict) → DateOfAcquisition

Populates a DataFile from a JSON compatible dict (likely parsed by argschema)

Returns:

DataObject:

An instantiated DataObject which has name and value properties

classmethod from_lims(behavior_session_id: int, lims_db: PostgresQueryMixin) → DateOfAcquisition

Populate a DataObject from an internal database (likely LIMS)

Returns:

DataObject:

An instantiated DataObject which has name and value properties

classmethod from_nwb(nwbfile: NWBFile) → DateOfAcquisition

Populate a DataObject from a pyNWB file object.

Parameters:

nwbfile:

The file object (NWBFile) of a pynwb dataset file.

Returns:

DataObject:

An instantiated DataObject which has name and value properties

classmethod from_stimulus_file(stimulus_file: BehaviorStimulusFile) → DateOfAcquisition

validate(stimulus_file: BehaviorStimulusFile, behavior_session_id: int) → DateOfAcquisition

raise a warning if the date differs too much from the datetime obtained from the behavior stimulus (*.pkl) file.

class allensdk.brain_observatory.behavior.data_objects.metadata.behavior_metadata.date_of_acquisition.DateOfAcquisitionOphys(date_of_acquisition: datetime)

Bases: DateOfAcquisition

Ophys experiments read date of acquisition from the ophys_sessions table in LIMS instead of the behavior_sessions table

classmethod from_lims(ophys_experiment_id: int, lims_db: PostgresQueryMixin) → DateOfAcquisitionOphys

Populate a DataObject from an internal database (likely LIMS)

Returns:

DataObject:

An instantiated DataObject which has name and value properties