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

class allensdk.brain_observatory.behavior.data_objects.metadata.behavior_metadata.behavior_session_uuid.BehaviorSessionUUID(behavior_session_uuid: UUID | None)

Bases: DataObject, StimulusFileReadableInterface, NwbReadableInterface

the universally unique identifier (UUID)

classmethod from_nwb(nwbfile: NWBFile) → BehaviorSessionUUID

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) → BehaviorSessionUUID

Populate a DataObject from the stimulus file

Returns:

DataObject:

An instantiated DataObject which has name and value properties

validate(behavior_session_id: int, foraging_id: int, stimulus_file: BehaviorStimulusFile) → BehaviorSessionUUID

Sanity check to ensure that pkl file data matches up with the behavior session that the pkl file has been associated with.