ellipse#

ellipse stimulus example

You can find an interactive version of this example here

stimupy.components.shapes.ellipse(visual_size=None, ppd=None, shape=None, radius=None, intensity_ellipse=1.0, intensity_background=0.0, rotation=0.0, origin='mean', restrict_size=True)#

Draw an ellipse

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

  • 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 (Sequence[Number, Number], Number or None (default)) – ellipse radius [ry, rx] in degrees visual angle

  • intensity_ellipse (float, optional) – intensity value for ellipse, by default 1.0

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

  • rotation (float, optional) – rotation (in degrees), counterclockwise, by default 0.0

  • origin ("corner", "mean" or "center") – 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)

  • restrict_size (Bool) – if False, allow ellipse to reach beyond image size (default: True)

Returns:

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

Return type:

dict[str, Any]