plotting

plotting#

Functions#

plot_stim(stim[, mask, stim_name, ax, vmin, ...])

Plot a stimulus

plot_stimuli(stims[, mask, vmin, vmax, ...])

Plot multiple stimuli

plot_comparison(original_img, new_img)

Plots visual comparison of two image-arrays
stimupy.utils.plotting.plot_stim(stim, mask=False, stim_name='stim', ax=None, vmin=0, vmax=1, save=None, units='deg', origin='mean')[source]#

Plot a stimulus

Plots the stimulus-array (key: “img”) directly from stim dict. Optionally also plots mask.

Parameters:

  • stim (dict) – stimulus dict 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

  • stim_name (str, optional) – Stimulus name used for plotting (default: “stim”)

  • ax (Axis object, optional) – If not None (default), plot in the specified Axis object

  • 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

Returns:

ax – If ax was passed and plotting is None, returns updated Axis object.

Return type:

Axis object

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

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)

stimupy.utils.plotting.plot_comparison(original_img, new_img)[source]#

Plots visual comparison of two image-arrays

Parameters:
Returns:

Figure containing plots of images, and their comparison(s)

Return type:

matplotlib.Figure

Contents