stimpyp.base.AbstractStimulusPattern#

class stimpyp.base.AbstractStimulusPattern#

Bases: Generic[ST]

Abstract Stimulus Pattern

Dimension parameters:

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

__init__(time, contrast, *, duration=None)#
Parameters:
  • time (ndarray) – stim on-off in sec. Array[float, [N, 2]]

  • contrast (ndarray) – stimulus contrast. Array[float, N]

  • duration (ndarray | None) – theoretical duration in prot file, not actual detected using diode. Array[float, N]

Methods

__init__(time, contrast, *[, duration])

foreach_stimulus([name])

of(rig)

init from Baselog children class

Attributes

time

stim on-off in sec.

contrast

stimulus contrast.

duration

theoretical duration in prot file, not actual detected using diode.

__init__(time, contrast, *, duration=None)#
Parameters:
  • time (ndarray) – stim on-off in sec. Array[float, [N, 2]]

  • contrast (ndarray) – stimulus contrast. Array[float, N]

  • duration (ndarray | None) – theoretical duration in prot file, not actual detected using diode. Array[float, N]

time: ndarray#

stim on-off in sec. Array[float, [N, 2]]

contrast: ndarray#

stimulus contrast. Array[float, N]

duration: ndarray#

theoretical duration in prot file, not actual detected using diode. Array[float, N]

classmethod of(rig)#

init from Baselog children class

Parameters:

rig (R) – AbstractLog

Returns:

StimPattern

Return type:

Self

abstract foreach_stimulus(name=False)#
Parameters:

name (bool)

Return type:

Iterable[tuple[Any, …] | ST]