allensdk.brain_observatory.behavior.data_objects.stimuli.fingerprint_stimulus module

class allensdk.brain_observatory.behavior.data_objects.stimuli.fingerprint_stimulus.FingerprintStimulus(table: DataFrame)[source]

Bases: object

The fingerprint stimulus is a movie used to trigger many neurons and is used to improve cell matching.

classmethod from_stimulus_file(stimulus_presentations: DataFrame, stimulus_file: BehaviorStimulusFile, stimulus_timestamps: StimulusTimestamps) FingerprintStimulus[source]

Instantiates FingerprintStimulus from stimulus file

Parameters:
stimulus_presentations:

Table containing previous stimuli

stimulus_file

BehaviorStimulusFile

stimulus_timestamps

StimulusTimestamps

Returns:
FingerprintStimulus

Instantiated FingerprintStimulus

property table: DataFrame

Returns the fingerprint stimulus table