stimuli

Modules

benarys
bullseyes
checkerboards
cornsweets
cubes
delboeufs
dungeons
edges
gabors
gratings
hermanns
mondrians
mueller_lyers
pinwheels
plaids
ponzos
rings
sbcs
todorovics
waves
wedding_cakes
whites

benarys

cross_generalized

benarys/cross_generalized.html

cross_rectangles

benarys/cross_rectangles.html

cross_triangles

benarys/cross_triangles.html

todorovic_generalized

benarys/todorovic_generalized.html

todorovic_rectangles

benarys/todorovic_rectangles.html

todorovic_triangles

benarys/todorovic_triangles.html

bullseyes

circular

bullseyes/circular.html

circular_generalized

bullseyes/circular_generalized.html

rectangular

bullseyes/rectangular.html

rectangular_generalized

bullseyes/rectangular_generalized.html

checkerboards

checkerboard

checkerboards/checkerboard.html

contrast_contrast

checkerboards/contrast_contrast.html

cornsweets

cornsweet

cornsweets/cornsweet.html

cubes

varying_cells

cubes/varying_cells.html

cube

cubes/cube.html

delboeufs

delboeuf

delboeufs/delboeuf.html

dungeons

dungeon

dungeons/dungeon.html

edges

step

edges/step.html

gaussian

edges/gaussian.html

cornsweet

edges/cornsweet.html

gabors

gabor

gabors/gabor.html

hermanns

grid

hermanns/grid.html

mondrians

mondrian

mondrians/mondrian.html

corrugated_mondrian

mondrians/corrugated_mondrian.html

mueller_lyers

mueller_lyer

mueller_lyers/mueller_lyer.html

pinwheels

pinwheel

pinwheels/pinwheel.html

plaids

gabors

plaids/gabors.html

sine_waves

plaids/sine_waves.html

square_waves

plaids/square_waves.html

ponzos

ponzo

ponzos/ponzo.html

rings

circular

rings/circular.html

rectangular

rings/rectangular.html

circular_generalized

rings/circular_generalized.html

rectangular_generalized

rings/rectangular_generalized.html

sbcs

generalized

sbcs/generalized.html

basic

sbcs/basic.html

square

sbcs/square.html

circular

sbcs/circular.html

with_dots

sbcs/with_dots.html

dotted

sbcs/dotted.html

todorovics

rectangle_generalized

todorovics/rectangle_generalized.html

rectangle

todorovics/rectangle.html

cross_generalized

todorovics/cross_generalized.html

cross

todorovics/cross.html

equal

todorovics/equal.html

waves

sine_linear

waves/sine_linear.html

square_linear

waves/square_linear.html

staircase_linear

waves/staircase_linear.html

sine_radial

waves/sine_radial.html

square_radial

waves/square_radial.html

staircase_radial

waves/staircase_radial.html

sine_rectilinear

waves/sine_rectilinear.html

square_rectilinear

waves/square_rectilinear.html

staircase_rectilinear

waves/staircase_rectilinear.html

sine_angular

waves/sine_angular.html

square_angular

waves/square_angular.html

staircase_angular

waves/staircase_angular.html

wedding_cakes

wedding_cake

wedding_cakes/wedding_cake.html

whites

angular

whites/angular.html

radial

whites/radial.html

wedding_cake

whites/wedding_cake.html

generalized

whites/generalized.html

white

whites/white.html

white_two_rows

whites/white_two_rows.html

anderson

whites/anderson.html

howe

whites/howe.html

yazdanbakhsh

whites/yazdanbakhsh.html

Functions

mask_targets(element_mask, target_indices)	Indicate elements as targets
place_targets(stim, element_mask_key, ...[, ...])	Place targets in stimulus
overview([skip])	Generate example stimuli from this module
plot_overview([mask, save, units])	Plot overview of examples in this module (and submodules)

stimupy.stimuli.mask_targets(element_mask, target_indices)

Indicate elements as targets

Creates a new target_mask from a mask of elements (e.g., grating bars, rings, frames, etc.), by indexing these elements.

Parameters:

• element_mask (numpy.ndarray) – mask with integer values for different elements / regions in a stimulus

• target_indices (Sequence[int] or int) – index or indices of elements to be designated as targets. Index 0 should always refer to background region. Indices can be negative, which results in “counting backwards” from the highest index in element_mask.

Returns:

target mask, with integer values indicating target regions, in order that they appear in target_indices

Return type:

numpy.ndarray

Raises:

ValueError – if a target_idx is greater than any value in the element_mask

stimupy.stimuli.place_targets(stim, element_mask_key, target_indices, intensity_target=0.5)

Place targets in stimulus

Turns image regions/elements defined by element_mask_key and indicated by target_indices, into targets. Targets are defined in a new target_mask, and drawn into image with intensity_target.

Parameters:

• stim (dict[str, Any]) – stimulus dictionary, with at least an “img” key, and mask indicated by element_mask_key

• element_mask_key (str) – key of the mask in stim-dict indicating image “elements”/regions

• target_indices (Sequence[int] or int) – index or indices of elements to be designated as targets

• intensity_target (float, optional) – intensity value for target, by default 0.5

Returns:

dict with the stimulus (key: “img”) with targets placed, mask with integer index for the target (key: “target_mask”)

Return type:

dict[str, Any]

stimupy.stimuli.overview(skip=False)

Generate example stimuli from this module

Returns:

Dict mapping names to individual stimulus dicts

Return type:

dict[str, dict]

stimupy.stimuli.plot_overview(mask=False, save=None, units='deg')

Plot overview of examples in this module (and submodules)

Parameters:

• mask (bool or str, optional) – If True, plot mask on top of stimulus image (default: False). If string is provided, plot this key from stimulus dictionary as mask

• save (None or str, optional) – If None (default), do not save the plot. If string is provided, save plot under this name.

• units ("px", "deg" (default), or str) – what units to put on the axes, by default degrees visual angle (“deg”). If a str other than “deg”(/”degrees”) or “px”(/”pix”/”pixels”) is passed, it must be the key to a tuple in stim