stimpyp.stimulus.GratingPattern

class stimpyp.stimulus.GratingPattern

Bases: AbstractStimulusPattern

Grating Stimulus Pattern

__init__(time, contrast, direction, sf, tf, *, duration=None)

Parameters:

• time (ndarray) – stim on-off in sec. Array[float, [N, 2]]

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

• direction (ndarray) – stimulus direction in deg. Array[int, N]

• sf (ndarray) – spatial frequency in cyc/deg. Array[float, N]

• tf (ndarray) – temporal frequency in hz Array[int, N]

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

Methods

__init__(time, contrast, direction, sf, tf, *)
dir_i()	deg:index dict
foreach_stimulus([name])	Generator for (index, stimulus_time, sf, tf, ori)
get_stim_time()	get approximate stim time if the same duration.
of(rig)	init from Baselog children class
sf_i()	sf:index dict
sftf_i()	sf, tf combination.
sftfdir_i()	sf, tf, ori combination.
tf_i()	sf:index dict

Attributes

n_dir	number of direction
n_sf	number of sf set
n_sftf	number of sftf combination
n_tf	number of tf set
sf_set	unique sf_set
tf_set	unique tf_set
direction	stimulus direction in deg.
sf	spatial frequency in cyc/deg.
tf	temporal frequency in hz Array[int, N]
time	stim on-off in sec.
contrast	stimulus contrast.
duration	theoretical duration in prot file, not actual detected using diode.

__init__(time, contrast, direction, sf, tf, *, duration=None)

Parameters:

• time (ndarray) – stim on-off in sec. Array[float, [N, 2]]

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

• direction (ndarray) – stimulus direction in deg. Array[int, N]

• sf (ndarray) – spatial frequency in cyc/deg. Array[float, N]

• tf (ndarray) – temporal frequency in hz Array[int, N]

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

direction: ndarray

stimulus direction in deg. Array[int, N]

sf: ndarray

spatial frequency in cyc/deg. Array[float, N]

tf: ndarray

temporal frequency in hz Array[int, 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

property sf_set: ndarray

unique sf_set

property tf_set: ndarray

unique tf_set

property n_sf: int

number of sf set

property n_tf: int

number of tf set

property n_sftf: int

number of sftf combination

property n_dir: int

number of direction

dir_i()

deg:index dict

Return type:

dict[int, int]

sf_i()

sf:index dict

Return type:

dict[float, int]

tf_i()

sf:index dict

Return type:

dict[int, int]

sftf_i()

sf, tf combination. (sf , tf):y

Return type:

dict[tuple[float, int], int]

sftfdir_i()

sf, tf, ori combination. (sf , tf , ori):y

Return type:

dict[tuple[float, int, int], int]

foreach_stimulus(name=False)

Generator for (index, stimulus_time, sf, tf, ori)

Parameters:

name (bool) – If True, return GratingStim, otherwise, return tuple

Returns:

Return type:

Iterable[tuple[int, ndarray, float, int, int] | GratingStim]

get_stim_time()

get approximate stim time if the same duration. i.e., for plotting purpose

Return type:

float