pymovements.utils.plotting.draw_image_stimulus#

pymovements.utils.plotting.draw_image_stimulus(image_stimulus: str | Path, origin: str = 'upper', show: bool = False, figsize: tuple[float, float] = (15, 10), extent: list[float] | None = None, fig: Figure | None = None, ax: Axes | None = None) → tuple[Figure, Axes][source]#

Draw stimulus.

Deprecated since version v0.22.0: Please use show() instead. This function will be removed in v0.27.0.

Parameters:

  • image_stimulus (str | Path) – Path to image stimulus.

  • origin (str) – Origin how to draw the image.

  • show (bool) – Boolean whether to show the image. (default: False)

  • figsize (tuple[float, float]) – Size of the figure. (default: (15, 10))

  • extent (list[float] | None) – Extent of image. (default: None)

  • fig (plt.Figure | None) – Matplotlib canvas. (default: None)

  • ax (plt.Axes | None) – Matplotlib axes. (default: None)

Returns:

  • fig (plt.Figure)

  • ax (plt.Axes)

  • .. deprecated:: v0.22.0 – Please use ImageStimulus.show() instead. This function will be removed in v0.27.0.