The image module supports basic image loading, rescaling and display operations.
Bases: matplotlib.image._ImageBase
An image attached to an Axes.
Axes
The axes the image will belong to.
Colormap, default: rcParams["image.cmap"] (default: 'viridis')
The Colormap instance or registered colormap name used to map scalar data to colors.
Normalize
Maps luminance to 0-1.
rcParams["image.interpolation"] (default: 'antialiased')
Supported values are 'none', 'antialiased', 'nearest', 'bilinear', 'bicubic', 'spline16', 'spline36', 'hanning', 'hamming', 'hermite', 'kaiser', 'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell', 'sinc', 'lanczos', 'blackman'.
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).
rcParams["image.origin"] (default: 'upper')
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.
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.
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.
The filter radius for filters that have a radius parameter, i.e. when interpolation is one of: 'sinc', 'lanczos' or 'blackman'.
When True, use a full resampling method. When False, only resample when the output image is larger than the input image.
Artist properties
matplotlib.colors.Normalize (or subclass thereof)
The normalizing object which scales data, typically into the interval [0, 1]. If None, norm defaults to a colors.Normalize object which initializes its scaling based on the first data processed.
Colormap
The colormap used to map normalized data values to RGBA colors.
Return the image value at the event position or None if the event is outside the image.
Return the image extent as tuple (left, right, bottom, top).
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Normalize, rescale, and colormap this image's data for rendering using renderer, with the given magnification.
If unsampled is True, the image will not be scaled, but an appropriate affine transformation will be returned instead.
The RGBA image, resampled unless unsampled is True.
The upper left corner where the image should be drawn, in pixel space.
The affine transformation from image to pixel space.
Set multiple properties at once.
Supported properties are
Property | Description |
|---|---|
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array | |
| float or 2D array-like or None |
bool | |
| array-like |
(vmin: float, vmax: float) | |
bool | |
Patch or (Path, Transform) or None | |
| |
| array-like or |
4-tuple of float | |
| bool |
| positive float |
str | |
bool | |
| {'antialiased', 'nearest', 'bilinear', 'bicubic', 'spline16', 'spline36', 'hanning', 'hamming', 'hermite', 'kaiser', 'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell', 'sinc', 'lanczos', 'none'} or None |
| {'data', 'rgba'} or None |
object | |
| |
None or bool or float or callable | |
bool | |
| bool or None |
(scale: float, length: float, randomness: float) | |
bool or None | |
str | |
bool | |
float |
Set the image extent.
The position and size of the image as tuple (left, right, bottom, top) in data coordinates.
This updates ax.dataLim, and, if autoscaling, sets ax.viewLim to tightly fit the image, regardless of dataLim. Autoscaling state is not changed, so following this with ax.autoscale_view() will redo the autoscaling in accord with dataLim.
Bases: matplotlib.image._ImageBase
The Image class whose size is determined by the given bbox.
cmap is a colors.Colormap instance norm is a colors.Normalize instance to map luminance to 0-1
kwargs are an optional list of Artist keyword args
Test whether the mouse event occurred within the image.
Get the artist's bounding box in display space.
The bounding box' width and height are nonnegative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
Normalize, rescale, and colormap this image's data for rendering using renderer, with the given magnification.
If unsampled is True, the image will not be scaled, but an appropriate affine transformation will be returned instead.
The RGBA image, resampled unless unsampled is True.
The upper left corner where the image should be drawn, in pixel space.
The affine transformation from image to pixel space.
Set multiple properties at once.
Supported properties are
Property | Description |
|---|---|
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array | |
| float or 2D array-like or None |
bool | |
| array-like |
(vmin: float, vmax: float) | |
bool | |
Patch or (Path, Transform) or None | |
| |
| array-like or |
| bool |
| positive float |
str | |
bool | |
| {'antialiased', 'nearest', 'bilinear', 'bicubic', 'spline16', 'spline36', 'hanning', 'hamming', 'hermite', 'kaiser', 'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell', 'sinc', 'lanczos', 'none'} or None |
| {'data', 'rgba'} or None |
object | |
| |
None or bool or float or callable | |
bool | |
| bool or None |
(scale: float, length: float, randomness: float) | |
bool or None | |
str | |
bool | |
float |
Bases: matplotlib.image._ImageBase
An image attached to a figure.
cmap is a colors.Colormap instance norm is a colors.Normalize instance to map luminance to 0-1
kwargs are an optional list of Artist keyword args
Return the image extent as tuple (left, right, bottom, top).
Normalize, rescale, and colormap this image's data for rendering using renderer, with the given magnification.
If unsampled is True, the image will not be scaled, but an appropriate affine transformation will be returned instead.
The RGBA image, resampled unless unsampled is True.
The upper left corner where the image should be drawn, in pixel space.
The affine transformation from image to pixel space.
Set multiple properties at once.
Supported properties are
Property | Description |
|---|---|
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array | |
| float or 2D array-like or None |
bool | |
| array-like |
(vmin: float, vmax: float) | |
bool | |
Patch or (Path, Transform) or None | |
| |
unknown | |
| bool |
| positive float |
str | |
bool | |
| {'antialiased', 'nearest', 'bilinear', 'bicubic', 'spline16', 'spline36', 'hanning', 'hamming', 'hermite', 'kaiser', 'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell', 'sinc', 'lanczos', 'none'} or None |
| {'data', 'rgba'} or None |
object | |
| |
None or bool or float or callable | |
bool | |
| bool or None |
(scale: float, length: float, randomness: float) | |
bool or None | |
str | |
bool | |
float |
Set the image array.
Bases: matplotlib.image.AxesImage
All other keyword arguments are identical to those of AxesImage.
Return the image extent as tuple (left, right, bottom, top).
Normalize, rescale, and colormap this image's data for rendering using renderer, with the given magnification.
If unsampled is True, the image will not be scaled, but an appropriate affine transformation will be returned instead.
The RGBA image, resampled unless unsampled is True.
The upper left corner where the image should be drawn, in pixel space.
The affine transformation from image to pixel space.
Set multiple properties at once.
Supported properties are
Property | Description |
|---|---|
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array | |
| float or 2D array-like or None |
bool | |
| unknown |
(vmin: float, vmax: float) | |
bool | |
Patch or (Path, Transform) or None | |
unknown | |
unknown | |
4-tuple of float | |
| unknown |
| unknown |
str | |
bool | |
{'nearest', 'bilinear'} or None | |
| {'data', 'rgba'} or None |
object | |
unknown | |
None or bool or float or callable | |
bool | |
| bool or None |
(scale: float, length: float, randomness: float) | |
bool or None | |
str | |
bool | |
float |
Retained for backwards compatibility - use set_data instead.
Set the grid for the pixel centers, and the pixel values.
Monotonic arrays of shapes (N,) and (M,), respectively, specifying pixel centers.
(M, N) ndarray or masked array of values to be colormapped, or (M, N, 3) RGB array, or (M, N, 4) RGBA array.
Set whether the resize filter normalizes the weights.
See help for imshow.
Set the resize filter radius only applicable to some interpolation schemes -- see help for imshow
If None, use rcParams["image.interpolation"] (default: 'antialiased').
Bases: matplotlib.image.AxesImage
Make a pcolor-style plot with an irregular rectangular grid.
This uses a variation of the original irregular image code, and it is used by pcolorfast for the corresponding grid type.
Axes
The axes the image will belong to.
Monotonic arrays of length N+1 and M+1, respectively, specifying rectangle boundaries. If not given, will default to range(N + 1) and range(M + 1), respectively.
The data to be color-coded. The interpretation depends on the shape:
Colormap, default: rcParams["image.cmap"] (default: 'viridis')
The Colormap instance or registered colormap name used to map scalar data to colors.
Normalize
Maps luminance to 0-1.
Artist properties
Return the image value at the event position or None if the event is outside the image.
Normalize, rescale, and colormap this image's data for rendering using renderer, with the given magnification.
If unsampled is True, the image will not be scaled, but an appropriate affine transformation will be returned instead.
The RGBA image, resampled unless unsampled is True.
The upper left corner where the image should be drawn, in pixel space.
The affine transformation from image to pixel space.
Set multiple properties at once.
Supported properties are
Property | Description |
|---|---|
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array | |
| float or 2D array-like or None |
bool | |
| unknown |
(vmin: float, vmax: float) | |
bool | |
Patch or (Path, Transform) or None | |
| |
unknown | |
4-tuple of float | |
| bool |
| positive float |
str | |
bool | |
| {'antialiased', 'nearest', 'bilinear', 'bicubic', 'spline16', 'spline36', 'hanning', 'hamming', 'hermite', 'kaiser', 'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell', 'sinc', 'lanczos', 'none'} or None |
| {'data', 'rgba'} or None |
object | |
| |
None or bool or float or callable | |
bool | |
| bool or None |
(scale: float, length: float, randomness: float) | |
bool or None | |
str | |
bool | |
float |
Retained for backwards compatibility - use set_data instead.
Set the grid for the rectangle boundaries, and the data values.
Monotonic arrays of length N+1 and M+1, respectively, specifying rectangle boundaries. If not given, will default to range(N + 1) and range(M + 1), respectively.
The data to be color-coded. The interpretation depends on the shape:
Composite a number of RGBA images into one. The images are composited in the order in which they appear in the images list.
Each must have a make_image method. For each image, can_composite should return True, though this is not enforced by this function. Each image must have a purely affine transformation with no shear.
RendererBase
The additional magnification to apply for the renderer in use.
The composited RGBA image.
The (left, bottom) offset where the composited image should be placed in the output figure.
Read an image from a file into an array.
Note
This function exists for historical reasons. It is recommended to use PIL.Image.open instead for loading images.
The image file to read: a filename, a URL or a file-like object opened in read-binary mode.
Passing a URL is deprecated. Please open the URL for reading and pass the result to Pillow, e.g. with np.array(PIL.Image.open(urllib.request.urlopen(url))).
The image file format assumed for reading the data. The image is loaded as a PNG file if format is set to "png", if fname is a path or opened file with a ".png" extension, or if it is an URL. In all other cases, format is ignored and the format is auto-detected by PIL.Image.open.
numpy.arrayThe image data. The returned array has shape
PNG images are returned as float arrays (0-1). All other formats are returned as int arrays, with a bit depth determined by the file's contents.
Save an array as an image file.
A path or a file-like object to store the image in. If format is not set, then the output format is inferred from the extension of fname, if any, and from rcParams["savefig.format"] (default: 'png') otherwise. If format is set, it determines the output format.
The image data. The shape can be one of MxN (luminance), MxNx3 (RGB) or MxNx4 (RGBA).
vmin and vmax set the color scaling for the image by fixing the values that map to the colormap color limits. If either vmin or vmax is None, that limit is determined from the arr min/max value.
Colormap, default: rcParams["image.cmap"] (default: 'viridis')
A Colormap instance or registered colormap name. The colormap maps scalar data to colors. It is ignored for RGB(A) data.
The file format, e.g. 'png', 'pdf', 'svg', ... The behavior when this is unset is documented under fname.
rcParams["image.origin"] (default: 'upper')
Indicates whether the (0, 0) index of the array is in the upper left or lower left corner of the axes.
The DPI to store in the metadata of the file. This does not affect the resolution of the output image. Depending on file format, this may be rounded to the nearest integer.
Metadata in the image file. The supported keys depend on the output format, see the documentation of the respective backends for more information.
Keyword arguments passed to PIL.Image.Image.save. If the 'pnginfo' key is present, it completely overrides metadata, including the default 'Software' key.
Load a PIL image and return it as a numpy int array.
The array shape depends on the image type:
Make a thumbnail of image in infile with output filename thumbfile.
See Image Thumbnail.
The image file. Matplotlib relies on Pillow for image reading, and thus supports a wide range of file formats, including PNG, JPG, TIFF and others.
The thumbnail filename.
The scale factor for the thumbnail.
The interpolation scheme used in the resampling. See the interpolation parameter of imshow for possible values.
If True, the default backend (presumably a user interface backend) will be used which will cause a figure to be raised if show is called. If it is False, the figure is created using FigureCanvasBase and the drawing backend is selected as Figure.savefig would normally do.
FigureThe figure instance containing the thumbnail.
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.5.1/api/image_api.html