prfmodel.stimuli

Containers that contain stimuli information as model input.

This module contains stimuli classes that serve as input for models. Currently, only stimuli for population receptive field (pRF) models, connective field (CF), and contrast sensitivity function (CSF) models are implemented.

Each stimulus type has a user-facing class (i.e., :class:PRFStimulus, :class:CFStimulus, and CSFStimulus) that holds :class:numpy.array objects. Internally, these are converted to counterparts that hold backend tensor objects to enable backend-specific optimization (i.e., :class:PRFStimulusTensors, :class:CFStimulusTensors, and CSFStimulusTensors).

:class:Stimulus is an abstract base class that the user-facing stimulus classes inherit from. Subclasses must implement the abstract :meth:Stimulus.to_tensors method to determine how non-tensor objects are converted to tensors.

Submodules

base	Stimulus base classes.

Classes

CFStimulus	Container for a connective field stimulus distance matrix and source response.
CFStimulusTensors	Tensor-holding counterpart of a CFStimulus.
CSFStimulus	Container for a contrast sensitivity function stimulus.
CSFStimulusTensors	Tensor-holding counterpart of a CSFStimulus.
PRFStimulus	Container for a population receptive field stimulus design and its associated grid.
PRFStimulusTensors	Tensor-holding counterpart of a PRFStimulus.
Stimulus	Stimulus base class.
StimulusTensors	Base class for the tensor-side counterpart of a Stimulus.