stimupy.components.frames#

Demos#

Functions#

frames

Draw sequential set of square frames with specified radii
frames(visual_size=None, ppd=None, shape=None, radii=None, rotation=0.0, intensity_frames=(0.0, 1.0), intensity_background=0.5, origin='mean')[source]#

Draw sequential set of square frames with specified radii

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]) – radii of each frame, in degrees visual angle

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

  • intensity_frames (Sequence[float, ...], optional) – intensity value for each frame, by default (1.0, 0.0). Can specify as many intensities as number of frame_widths; If fewer intensities are passed than frame_widhts, cycles through intensities

  • intensity_background (float, optional) – intensity 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 frame (key: “frame_mask”), and additional keys containing stimulus parameters

Return type:

dict[str, Any]