stimupy.components.radials#

Demos#

Functions#

disc

Draw a central disc

ring

Draw a ring (annulus)

annulus

Draw a ring (annulus)

rings

Draw a central solid disc with zero or more solid rings (annuli)
disc(visual_size=None, ppd=None, shape=None, radius=None, intensity_disc=1.0, intensity_background=0.0, origin='mean')[source]#

Draw a central disc

Essentially, dics(radius) is an alias for ring(radii=[0, radius])

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

  • radius (Number) – outer radius of disc in degree visual angle

  • intensity_disc (Number, optional) – intensity value of disc, 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]

ring(visual_size=None, ppd=None, shape=None, radii=None, intensity_ring=1.0, intensity_background=0.0, origin='mean')[source]#

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

annulus(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

rings(visual_size=None, ppd=None, shape=None, radii=None, intensity_rings=(0.0, 1.0), intensity_background=0.5, origin='mean')[source]#

Draw a central solid disc with zero or more solid rings (annuli)

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]) – outer radii of rings (& disc) in degree visual angle

  • intensity_rings (Sequence[Number, ...], optional) – intensity value for each ring, from inside to out, by default (0.0, 1.0) If fewer intensities are passed than number of radii, cycles through intensities

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

  • 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]