plot_stimuli

plot_stimuli#

stimupy.utils.plot_stimuli(stims, mask=False, vmin=0, vmax=1, save=None, units='deg', ncols=None, nrows=None)#

Plot multiple stimuli

Plots the stimulus-arrays (keys: “img”) directly from stim dicts. Arranges stimuli in a grid. Optionally also plots masks.

Parameters:

  • stims (dict of dicts) – dictionary composed of stimulus dicts containing stimulus-array (key: “img”)

  • mask (bool or str, optional) – If True, plot mask on top of stimulus image (default: False). If string is provided, plot this key from stimulus dictionary as mask

  • vmin (float, optional) – Minimal intensity value for plotting. The default is 0.

  • vmax (float, optional) – Minimal intensity value for plotting. The default is 1.

  • save (None or str, optional) – If None (default), do not save the plot. If string is provided, save plot under this name.

  • units ("px", "deg" (default), or str) – what units to put on the axes, by default degrees visual angle (“deg”). If a str other than “deg”(/”degrees”) or “px”(/”pix”/”pixels”) is passed, it must be the key to a tuple in stim

  • ncols (int or None, optional) – number of columns in gridspec, or figure it out (default)

  • nrows (int or None, optional) – number of rows in gridspec, or figure it out (default)

Contents