rectangular_generalized

rectangular_generalized#

rectangular_generalized stimulus example

You can find an interactive version of this example here

stimupy.stimuli.rings.rectangular_generalized(visual_size=None, ppd=None, shape=None, radii=None, intensity_frames=(0.0, 1.0), intensity_background=0.5, target_indices=(), intensity_target=0.5, origin='mean', rotation=0.0)#

Draw sequential set of square frames with specified radii and targets

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

  • intensity_frames (Sequence[float, float]) – min and max intensity of square-wave, by default (0.0, 1.0)

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

  • target_indices (int, or Sequence[int, ...]) – indices frames where targets will be placed

  • intensity_target (float, or Sequence[float, ...], optional) – intensity value for each target, by default 0.5. Can specify as many intensities as number of target_indices; If fewer intensities are passed than target_indices, cycles through intensities

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

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

Returns:

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

Return type:

dict[str, Any]