allensdk.brain_observatory.behavior.data_objects.rewards module

class allensdk.brain_observatory.behavior.data_objects.rewards.Rewards(rewards: DataFrame)

Bases: DataObject, StimulusFileReadableInterface, NwbReadableInterface, NwbWritableInterface

classmethod from_nwb(nwbfile: NWBFile) → Rewards | None

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, stimulus_timestamps: StimulusTimestamps) → Rewards

Get reward data from pkl file, based on timestamps (not sync file).

to_nwb(nwbfile: NWBFile) → NWBFile

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.