circle#

circle stimulus example

You can find an interactive version of this example here

stimupy.components.lines.circle(visual_size=None, ppd=None, shape=None, radius=None, line_width=0, intensity_line=1.0, intensity_background=0.0)#

Draw a circle given the input parameters

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) – radius of circle in degrees visual angle

  • line_width (Number) – width of the line, in degrees visual angle; if line_width=0 (default), line will be one pixel wide

  • intensity_line (Number) – intensity value of the line (default: 1)

  • intensity_background (Number) – intensity value of the background (default: 0)

Returns:

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

Return type:

dict[str, Any]