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

class allensdk.brain_observatory.behavior.data_objects.metadata.behavior_metadata.stimulus_frame_rate.StimulusFrameRate(stimulus_frame_rate: float)[source]

Bases: DataObject, StimulusFileReadableInterface, NwbReadableInterface

Stimulus frame rate

classmethod from_nwb(nwbfile: NWBFile) StimulusFrameRate[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) StimulusFrameRate[source]

Populate a DataObject from the stimulus file

Returns:
DataObject:

An instantiated DataObject which has name and value properties