classmatplotlib.image.AxesImage(ax, cmap=None, norm=None, interpolation=None, origin=None, extent=None, filternorm=True, filterrad=4.0, resample=False, *, interpolation_stage=None, **kwargs)[source]
 
Bases: matplotlib.image._ImageBase An image attached to an Axes.  Parameters 
 
axAxes


The axes the image will belong to.  
cmapstr or Colormap, default: rcParams["image.cmap"] (default: 'viridis')


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


Maps luminance to 0-1.  
interpolationstr, default: 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'.  
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: 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.  
extenttuple, 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.  
filternormbool, 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.  
filterradfloat > 0, default: 4


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


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

    Parameters 
 
normmatplotlib.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.  
cmapstr or Colormap


The colormap used to map normalized data values to RGBA colors.       get_cursor_data(event)[source]
 
Return the image value at the event position or None if the event is outside the image.  See also  matplotlib.artist.Artist.get_cursor_data
  
   get_extent()[source]
 
Return the image extent as tuple (left, right, bottom, top). 
   get_window_extent(renderer=None)[source]
 
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. 
   make_image(renderer, magnification=1.0, unsampled=False)[source]
 
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.  Returns 
 
image(M, N, 4) uint8 array


The RGBA image, resampled unless unsampled is True.  
x, yfloat


The upper left corner where the image should be drawn, in pixel space.  
transAffine2D


The affine transformation from image to pixel space.     
   set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, array=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, data=<UNSET>, extent=<UNSET>, filternorm=<UNSET>, filterrad=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, interpolation=<UNSET>, interpolation_stage=<UNSET>, label=<UNSET>, norm=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, resample=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
 
Set multiple properties at once. Supported properties are   
Property Description   
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array  
alpha float or 2D array-like or None  
animated bool  
array array-like  
clim (vmin: float, vmax: float)  
clip_box Bbox  
clip_on bool  
clip_path Patch or (Path, Transform) or None  
cmap Colormap or str or None  
data array-like or PIL.Image.Image  
extent 4-tuple of float  
figure Figure  
filternorm bool  
filterrad positive float  
gid str  
in_layout bool  
interpolation {'antialiased', 'nearest', 'bilinear', 'bicubic', 'spline16', 'spline36', 'hanning', 'hamming', 'hermite', 'kaiser', 'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell', 'sinc', 'lanczos', 'none'} or None  
interpolation_stage {'data', 'rgba'} or None  
label object  
norm Normalize or None  
path_effects AbstractPathEffect  
picker None or bool or float or callable  
rasterized bool  
resample bool or None  
sketch_params (scale: float, length: float, randomness: float)  
snap bool or None  
transform Transform  
url str  
visible bool  
zorder float   
   set_extent(extent)[source]
 
Set the image extent.  Parameters 
 
extent4-tuple of float


The position and size of the image as tuple (left, right, bottom, top) in data coordinates.     Notes 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.