stimpyp.base.AbstractStimProtocol

class stimpyp.base.AbstractStimProtocol

Bases: object

ABC class for the stimpy protocol file (.prot)

Dimension parameters:

N = numbers of visual stimulation (on-off pairs) = (T * S)

T = number of trials

S = Number of Stim Type

C = Numbers of Cycle

__init__(name, options, visual_stimuli, version)

Parameters:

• name (str)

• options (dict[str, Any])

• visual_stimuli (DataFrame)

• version (Literal['pyvstim', 'stimpy-bit', 'stimpy-git', 'debug'])

Methods

__init__(name, options, visual_stimuli, version)
load(file)	Load *.prot file

Attributes

background	background for non-stimulation epoch.
blank_duration	blank duration between each visual stimulus (in sec)
end_blank_duration	blank duration after the visual stimulation epoch
is_shuffle	if shuffle stimulation
n_stimuli	number of stimuli (S)
n_trials	(T,)
start_blank_duration	blank duration before starting the visual stimulation epoch (in sec)
stim_params
stimulus_type	stimulus type
total_duration	total protocol duration
trial_blank_duration	blank duration between trials (in sec) TODO check stimpy source code
trial_duration	trial duration
visual_duration	total visual duration
name	protocol name.
options	protocol options
visual_stimuli_dataframe	visual stimuli dataframe.
version	date of major changes

__init__(name, options, visual_stimuli, version)

Parameters:

• name (str)

• options (dict[str, Any])

• visual_stimuli (DataFrame)

• version (Literal['pyvstim', 'stimpy-bit', 'stimpy-git', 'debug'])

name: str

protocol name. related to filename

options: dict[str, Any]

protocol options

visual_stimuli_dataframe: DataFrame

visual stimuli dataframe. row number: S

version: Literal['pyvstim', 'stimpy-bit', 'stimpy-git', 'debug']

date of major changes

property n_stimuli: int

number of stimuli (S)

property stim_params: tuple[str, ...]

abstract classmethod load(file)

Load *.prot file

Parameters:

file (Path | str) – file path

Return type:

Self

abstract property is_shuffle: bool

if shuffle stimulation

abstract property background: float

background for non-stimulation epoch. Note the default value need to check in user-specific stimpy version

abstract property start_blank_duration: int

blank duration before starting the visual stimulation epoch (in sec)

abstract property blank_duration: int

blank duration between each visual stimulus (in sec)

abstract property trial_blank_duration: int

blank duration between trials (in sec) TODO check stimpy source code

abstract property end_blank_duration: int

blank duration after the visual stimulation epoch

abstract property trial_duration: int

trial duration

property visual_duration: int

total visual duration

property total_duration: int

total protocol duration

property stimulus_type: str

stimulus type

property n_trials: int

(T,)