Parameters

ax : `~.axes.Axes`

The axes the image will belong to.

cmap : str or `~matplotlib.colors.Colormap`, default: :rc:`image.cmap`

The Colormap instance or registered colormap name used to map scalar data to colors.

norm : `~matplotlib.colors.Normalize`

Maps luminance to 0-1.

interpolation : str, default: :rc:`image.interpolation`

Supported values are 'none', 'antialiased', 'nearest', 'bilinear', 'bicubic', 'spline16', 'spline36', 'hanning', 'hamming', 'hermite', 'kaiser', 'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell', 'sinc', 'lanczos', 'blackman'.

interpolation_stage : {'data', 'rgba'}, default: 'data'

If 'data', interpolation is carried out on the data provided by the user. If 'rgba', the interpolation is carried out after the colormapping has been applied (visual interpolation).

origin : {'upper', 'lower'}, default: :rc:`image.origin`

Place the [0, 0] index of the array in the upper left or lower left corner of the axes. The convention 'upper' is typically used for matrices and images.

extent : tuple, optional

The data axes (left, right, bottom, top) for making image plots registered with data plots. Default is to label the pixel centers with the zero-based row and column indices.

filternorm : bool, default: True

A parameter for the antigrain image resize filter (see the antigrain documentation). If filternorm is set, the filter normalizes integer values and corrects the rounding errors. It doesn't do anything with the source floating point values, it corrects only integers according to the rule of 1.0 which means that any sum of pixel weights must be equal to 1.0. So, the filter function must produce a graph of the proper shape.

filterrad : float > 0, default: 4

The filter radius for filters that have a radius parameter, i.e. when interpolation is one of: 'sinc', 'lanczos' or 'blackman'.

resample : bool, default: False

When True, use a full resampling method. When False, only resample when the output image is larger than the input image.

**kwargs : `.Artist` properties

An image attached to an Axes.

Examples

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

matplotlib.artist.Artist.get_cursor_data matplotlib.colorbar.Colorbar matplotlib matplotlib.axes._base._AxesBase.get_images matplotlib.pyplot.colorbar matplotlib.figure.FigureBase.colorbar matplotlib.image.NonUniformImage.__init__ matplotlib.axes._axes.Axes.spy matplotlib.pyplot.spy matplotlib.axes._base._AxesBase.add_image matplotlib.axes._axes.Axes.pcolorfast matplotlib.axes._axes.Axes.imshow matplotlib.pyplot.imshow

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them

---

File: /matplotlib/image.py#863
type: <class 'type'>
Commit: