ring

ring#

ring stimulus example

You can find an interactive version of this example here

stimupy.components.shapes.ring(visual_size=None, ppd=None, shape=None, radii=None, intensity_ring=1.0, intensity_background=0.0, origin='mean')#

Draw a ring (annulus)

Parameters:

  • visual_size (Sequence[Number, Number], Number, or None (default)) – visual size [height, width] of image, in degrees

  • ppd (Sequence[Number, Number], Number, or None (default)) – pixels per degree [vertical, horizontal]

  • shape (Sequence[Number, Number], Number, or None (default)) – shape [height, width] of image, in pixels

  • radii (Sequence[Number, Number]) – inner and outer radius of ring in degree visual angle

  • intensity_ring (Number, optional) – intensity value of ring, by default 1.0

  • intensity_background (float, optional) – intensity value of background, by default 0.0

  • origin ("corner", "mean" or "center", optional) – if “corner”: set origin to upper left corner if “mean”: set origin to hypothetical image center (default) if “center”: set origin to real center (closest existing value to mean)

Returns:

dict with the stimulus (key: “img”), mask with integer index for each ring (key: “ring_mask”), and additional keys containing stimulus parameters

Return type:

dict[str, Any]

Raises:

  • ValueError – if passed in less/more than 2 radii (inner, outer)

  • ValueError – if passed in less/more than 1 intensity

Contents