mpl.image.AxesImage

class mpl.image.AxesImage(ax, cmap=None, norm=None, interpolation=None, origin=None, extent=None, filternorm=1, filterrad=4.0, resample=False, **kwargs)[source]
__init__(ax, cmap=None, norm=None, interpolation=None, origin=None, extent=None, filternorm=1, filterrad=4.0, resample=False, **kwargs)[source]

interpolation and cmap default to their rc settings

cmap is a colors.Colormap instance norm is a colors.Normalize instance to map luminance to 0-1

extent is 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.

Additional kwargs are matplotlib.artist properties

Methods

__init__(ax[, cmap, norm, interpolation, ...]) interpolation and cmap default to their rc settings
add_callback(func) Adds a callback function that will be called whenever one of the Artist‘s properties changes.
add_checker(checker) Add an entry to a dictionary of boolean flags that are set to True when the mappable is changed.
autoscale() Autoscale the scalar limits on the norm instance using the
autoscale_None() Autoscale the scalar limits on the norm instance using the
changed() Call this whenever the mappable is changed so observers can
check_update(checker) If mappable has changed since the last check,
contains(mouseevent) Test whether the mouse event occured within the image.
convert_xunits(x) For artists in an axes, if the xaxis has units support,
convert_yunits(y) For artists in an axes, if the yaxis has units support,
draw(artist, renderer, *args, **kwargs)
findobj([match, include_self]) Find artist objects.
format_cursor_data(data) Return cursor data string formatted.
get_agg_filter() return filter function to be used for agg filter
get_alpha() Return the alpha value used for blending - not supported on all
get_animated() Return the artist’s animated state
get_array() Return the array
get_axes() Return the Axes instance the artist resides in, or None.
get_children() Return a list of the child Artist`s this :class:`Artist contains.
get_clim() return the min, max of the color limits for image scaling
get_clip_box() Return artist clipbox
get_clip_on() Return whether artist uses clipping
get_clip_path() Return artist clip path
get_cmap() return the colormap
get_contains() Return the _contains test used by the artist, or None for default.
get_cursor_data(event) Get the cursor data for a given event
get_extent() Get the image extent: left, right, bottom, top
get_figure() Return the Figure instance the artist belongs to.
get_filternorm() Return the filternorm setting
get_filterrad() return the filterrad setting
get_gid() Returns the group id
get_interpolation() Return the interpolation method the image uses when resizing.
get_label() Get the label used for this artist in the legend.
get_path_effects()
get_picker() Return the picker object used by this artist
get_rasterized() return True if the artist is to be rasterized
get_resample() Return the image resample boolean
get_size() Get the numrows, numcols of the input image
get_sketch_params() Returns the sketch parameters for the artist.
get_snap() Returns the snap setting which may be:
get_transform() Return the Transform instance used by this artist.
get_transformed_clip_path_and_affine() Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation.
get_url() Returns the url
get_visible() Return the artist’s visiblity
get_window_extent([renderer])
get_zorder() Return the Artist‘s zorder.
have_units() Return True if units are set on the x or y axes
hitlist(event) List the children of the artist which contain the mouse event event.
is_figure_set() Returns True if the artist is assigned to a Figure.
is_transform_set() Returns True if Artist has a transform explicitly set.
make_image([magnification])
pchanged() Fire an event when property changed, calling all of the registered callbacks.
pick(mouseevent) call signature:
pickable() Return True if Artist is pickable.
properties() return a dictionary mapping property name -> value for all Artist props
remove() Remove the artist from the figure if possible.
remove_callback(oid) Remove a callback based on its id.
set(**kwargs) A property batch setter.
set_agg_filter(filter_func) set agg_filter fuction.
set_alpha(alpha) Set the alpha value used for blending - not supported on
set_animated(b) Set the artist’s animation state.
set_array(A) Retained for backwards compatibility - use set_data instead
set_axes(axes) Set the Axes instance in which the artist resides, if any.
set_clim([vmin, vmax]) set the norm limits for image scaling; if vmin is a length2
set_clip_box(clipbox) Set the artist’s clip Bbox.
set_clip_on(b) Set whether artist uses clipping.
set_clip_path(path[, transform]) Set the artist’s clip path, which may be:
set_cmap(cmap)
set_contains(picker) Replace the contains test used by this artist.
set_data(A) Set the image array
set_extent(extent) extent is data axes (left, right, bottom, top) for making image plots
set_figure(fig) Set the Figure instance the artist belongs to.
set_filternorm(filternorm) Set whether the resize filter norms the weights – see
set_filterrad(filterrad) Set the resize filter radius only applicable to some
set_gid(gid) Sets the (group) id for the artist
set_interpolation(s) Set the interpolation method the image uses when resizing.
set_label(s) Set the label to s for auto legend.
set_norm(norm)
set_path_effects(path_effects) set path_effects, which should be a list of instances of
set_picker(picker) Set the epsilon for picking used by this artist
set_rasterized(rasterized) Force rasterized (bitmap) drawing in vector backend output.
set_resample(v) Set whether or not image resampling is used
set_sketch_params([scale, length, randomness]) Sets the sketch parameters.
set_snap(snap) Sets the snap setting which may be:
set_transform(t) Set the Transform instance used by this artist.
set_url(url) Sets the url for the artist
set_visible(b) Set the artist’s visiblity.
set_zorder(level) Set the zorder for the artist.
to_rgba(x[, alpha, bytes]) Return a normalized rgba array corresponding to x.
update(props) Update the properties of this Artist from the dictionary prop.
update_from(other) Copy properties from other to self.
write_png(fname[, noscale]) Write the image to png file with fname

Attributes

aname
axes The Axes instance the artist resides in, or None.
iterpnames
k
mouseover
stale If the artist is ‘stale’ and needs to be re-drawn for the output to match the internal state of the artist.
v
zorder