allensdk.brain_observatory.behavior.data_objects.stimuli.templates module¶
- class allensdk.brain_observatory.behavior.data_objects.stimuli.templates.Templates(templates: Dict[str, StimulusTemplate])[source]¶
Bases:
DataObject,StimulusFileReadableInterface,NwbReadableInterface,NwbWritableInterface- property fingerprint_movie_template_key: str¶
Name of the fingerprint movie template in template dictionary.
- classmethod from_nwb(nwbfile: NWBFile) Templates[source]¶
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, limit_to_images: List | None = None, load_stimulus_movie: bool = False) Templates[source]¶
Get stimulus templates (movies, scenes) for behavior session.
- property image_template_key: str¶
Name of the image template in template dictionary.
- to_nwb(nwbfile: NWBFile, stimulus_presentations: Presentations) NWBFile[source]¶
Given an already populated DataObject, return an pyNWB file object that had had DataObject data added.
- Parameters:
- nwbfileNWBFile
An NWB file object
- Returns:
- NWBFile
An NWB file object that has had data from the DataObject added to it.