colour.plotting.plot_image

colour.plotting.plot_image(image, imshow_kwargs=None, text_kwargs=None, **kwargs)[source]

Plots given image.

Parameters
  • image (array_like) – Image to plot.

  • imshow_kwargs (dict, optional) – Keyword arguments for the plt.imshow() definition.

  • text_kwargs (dict, optional) –

    Keyword arguments for the plt.text() definition. The following special keyword arguments can also be used:

    • offset : array_like, sets the text offset.

Other Parameters

**kwargs (dict, optional) – {colour.plotting.artist(), colour.plotting.render()}, Please refer to the documentation of the previously listed definitions.

Returns

Current figure and axes.

Return type

tuple

Examples

>>> import os
>>> import colour
>>> from colour import read_image
>>> path = os.path.join(
...     colour.__path__[0], '..', 'docs', '_static', 'Logo_Medium_001.png')
>>> plot_image(read_image(path))  
(<Figure size ... with 1 Axes>, <...AxesSubplot...>)
plot_image