colour.plotting.plot_image

colour.plotting.plot_image(image, text_parameters=None, interpolation='nearest', colour_map=<matplotlib.colors.LinearSegmentedColormap object>, **kwargs)[source]

Plots given image.

Parameters

  • image (array_like) – Image to plot.

  • text_parameters (dict, optional) – Parameters for the plt.text() definition, offset can be set to define the text offset.

  • interpolation (unicode, optional) – {‘nearest’, None, ‘none’, ‘bilinear’, ‘bicubic’, ‘spline16’, ‘spline36’, ‘hanning’, ‘hamming’, ‘hermite’, ‘kaiser’, ‘quadric’, ‘catrom’, ‘gaussian’, ‘bessel’, ‘mitchell’, ‘sinc’, ‘lanczos’} Image display interpolation.

  • colour_map (unicode, optional) – Colour map used to display single channel images.

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>, <matplotlib.axes._subplots.AxesSubplot object at 0x...>)
plot_image