ImageBox
Bases: ColorBoxBase
axes
The ~.axes.Axes instance the artist resides in, or None.
colorbar
The last colorbar associated with this object.
figure
The (Sub)Figure that the artist is on.
mouseover
Return whether this artist is queried for custom context information when the mouse cursor moves over it.
stale
Whether the artist is ‘stale’ and needs to be re-drawn for the output to match the internal state of the artist.
sticky_edges
x and y sticky edge lists for autoscaling.
Methods
add_callback(func)
Add a callback function that will be called whenever one of the .Artist's properties changes.
autoscale()
Autoscale the scalar limits on the norm instance using the current array
autoscale_None()
Autoscale the scalar limits on the norm instance using the current array, changing only limits that are None
can_composite()
Return whether the image can be composited with its neighbors.
changed()
Call this whenever the mappable is changed so observers can update.
contains(mouseevent)
Test whether the mouse event occurred within the image.
convert_xunits(x)
Convert x using the unit type of the xaxis.
convert_yunits(y)
Convert y using the unit type of the yaxis.
draw(renderer)
Draw the Artist (and its children) using the given renderer.
findobj([match, include_self])
Find artist objects.
format_cursor_data(data)
Return a string representation of data.
get_agg_filter()
Return filter function to be used for agg filter.
get_animated()
Return whether the artist is animated.
get_array()
Return the array of values, that are mapped to colors.
get_children()
Return a list of the child .Artists of this .Artist.
get_clim()
Return the values (min, max) that are mapped to the colormap limits.
get_clip_box()
Return the clipbox.
get_clip_on()
Return whether the artist uses clipping.
get_clip_path()
Return the clip path.
get_cmap()
Return the .Colormap instance.
get_cursor_data(event)
Return the cursor data for a given event.
get_figure([root])
Return the .Figure or .SubFigure instance the artist belongs to.
get_filternorm()
Return whether the resize filter normalizes the weights.
get_filterrad()
Return the filterrad setting.
get_gid()
Return the group id.
get_in_layout()
Return boolean flag, True if artist is included in layout calculations.
get_interpolation()
Return the interpolation method the image uses when resizing.
get_interpolation_stage()
Return when interpolation happens during the transform to RGBA.
get_label()
Return the label used for this artist in the legend.
get_mouseover()
Return whether this artist is queried for custom context information when the mouse cursor moves over it.
get_picker()
Return the picking behavior of the artist.
get_rasterized()
Return whether the artist is to be rasterized.
get_resample()
Return whether image resampling is used.
get_shape()
Return the shape of the image as tuple (numrows, numcols, channels).
get_size()
Return the size of the image as tuple (numrows, numcols).
get_sketch_params()
Return the sketch parameters for the artist.
get_snap()
Return the snap setting.
get_tightbbox([renderer])
Like .Artist.get_window_extent, but includes any clipping.
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()
Return the url.
get_visible()
Return the visibility.
get_window_extent([renderer])
Get the artist's bounding box in display space.
get_zorder()
Return the artist's zorder.
have_units()
Return whether units are set on any axis.
is_transform_set()
Return whether the Artist has an explicitly set transform.
make_image(renderer[, magnification, unsampled])
Normalize, rescale, and colormap this image's data for rendering using renderer, with the given magnification.
pchanged()
Call all of the registered callbacks.
pick(mouseevent)
Process a pick event.
pick_color_from_image(renderer, xy)
xy in display coordinate.
pickable()
Return whether the artist is pickable.
properties()
Return a dictionary of all the properties of the artist.
remove()
Remove the artist from the figure if possible.
remove_callback(oid)
Remove a callback based on its observer id.
set(*[, agg_filter, alpha, animated, array, ...])
Set multiple properties at once.
set_agg_filter(filter_func)
Set the agg filter.
set_alpha(alpha)
Set the alpha value used for blending - not supported on all backends.
set_animated(b)
Set whether the artist is intended to be used in an animation.
set_array(A)
Retained for backwards compatibility - use set_data instead.
set_bbox(bbox)
bbox or a callable which take a renderer as an arguemnt
set_clim([vmin, vmax])
Set the norm limits for image scaling.
set_clip_box(clipbox)
Set the artist's clip .Bbox.
set_clip_on(b)
Set whether the artist uses clipping.
set_clip_path(path[, transform])
Set the artist's clip path.
set_cmap(cmap)
Set the colormap for luminance data.
set_data(A)
Set the image array.
set_figure(fig)
Set the .Figure or .SubFigure instance the artist belongs to.
set_filternorm(filternorm)
Set whether the resize filter normalizes the weights.
set_filterrad(filterrad)
Set the resize filter radius only applicable to some interpolation schemes -- see help for imshow
set_gid(gid)
Set the (group) id for the artist.
set_in_layout(in_layout)
Set if artist is to be included in layout calculations, E.g.
set_interpolation(s)
Set the interpolation method the image uses when resizing.
set_interpolation_stage(s)
Set when interpolation happens during the transform to RGBA.
set_label(s)
Set a label that will be displayed in the legend.
set_mouseover(mouseover)
Set whether this artist is queried for custom context information when the mouse cursor moves over it.
set_norm(norm)
Set the normalization instance.
set_path_effects(path_effects)
Set the path effects.
set_picker(picker)
Define the picking behavior of the artist.
set_rasterized(rasterized)
Force rasterized (bitmap) drawing for vector graphics output.
set_resample(v)
Set whether image resampling is used.
set_sketch_params([scale, length, randomness])
Set the sketch parameters.
set_snap(snap)
Set the snapping behavior.
set_transform(t)
Set the artist transform.
set_url(url)
Set the url for the artist.
set_visible(b)
Set the artist's visibility.
set_zorder(level)
Set the zorder for the artist.
to_rgba(x[, alpha, bytes, norm])
Return a normalized RGBA array corresponding to x.
update(props)
Update this artist's properties from the dict props.
update_A()
the array need to be explicitly updated if color or alpha is changed after initialiation
update_from(other)
Copy properties from other to self.
write_png(fname)
Write the image to png file fname.
get_alpha
get_color
get_path_effects
init_data_n_alpha
set_color
set_coords
set_extent
Set multiple properties at once.
Supported properties are
agg_filter: a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image alpha: float or 2D array-like or None animated: bool array: array-like bbox: unknown clim: (vmin: float, vmax: float) clip_box: ~matplotlib.transforms.BboxBase or None clip_on: bool clip_path: Patch or (Path, Transform) or None cmap: .Colormap or str or None color: unknown coords: unknown data: array-like or PIL.Image.Image extent: unknown figure: ~matplotlib.figure.Figure or ~matplotlib.figure.SubFigure filternorm: bool filterrad: positive float gid: str in_layout: bool interpolation: {‘auto’, ‘nearest’, ‘bilinear’, ‘bicubic’, ‘spline16’, ‘spline36’, ‘hanning’, ‘hamming’, ‘hermite’, ‘kaiser’, ‘quadric’, ‘catrom’, ‘gaussian’, ‘bessel’, ‘mitchell’, ‘sinc’, ‘lanczos’, ‘none’} or None interpolation_stage: {‘data’, ‘rgba’, ‘auto’} or None label: object mouseover: bool norm: .Normalize or str or None path_effects: list of .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: ~matplotlib.transforms.Transform url: str visible: bool zorder: float
Bases: ColorBoxBase
axes
The ~.axes.Axes instance the artist resides in, or None.
colorbar
The last colorbar associated with this object.
figure
The (Sub)Figure that the artist is on.
mouseover
Return whether this artist is queried for custom context information when the mouse cursor moves over it.
stale
Whether the artist is ‘stale’ and needs to be re-drawn for the output to match the internal state of the artist.
sticky_edges
x and y sticky edge lists for autoscaling.
Methods
add_callback(func)
Add a callback function that will be called whenever one of the .Artist's properties changes.
autoscale()
Autoscale the scalar limits on the norm instance using the current array
autoscale_None()
Autoscale the scalar limits on the norm instance using the current array, changing only limits that are None
can_composite()
Return whether the image can be composited with its neighbors.
changed()
Call this whenever the mappable is changed so observers can update.
contains(mouseevent)
Test whether the mouse event occurred within the image.
convert_xunits(x)
Convert x using the unit type of the xaxis.
convert_yunits(y)
Convert y using the unit type of the yaxis.
draw(renderer)
Draw the Artist (and its children) using the given renderer.
findobj([match, include_self])
Find artist objects.
format_cursor_data(data)
Return a string representation of data.
get_agg_filter()
Return filter function to be used for agg filter.
Return the alpha value used for blending - not supported on all backends.
get_animated()
Return whether the artist is animated.
get_array()
Return the array of values, that are mapped to colors.
get_children()
Return a list of the child .Artists of this .Artist.
get_clim()
Return the values (min, max) that are mapped to the colormap limits.
get_clip_box()
Return the clipbox.
get_clip_on()
Return whether the artist uses clipping.
get_clip_path()
Return the clip path.
get_cmap()
Return the .Colormap instance.
get_cursor_data(event)
Return the cursor data for a given event.
get_figure([root])
Return the .Figure or .SubFigure instance the artist belongs to.
get_filternorm()
Return whether the resize filter normalizes the weights.
get_filterrad()
Return the filterrad setting.
get_gid()
Return the group id.
get_in_layout()
Return boolean flag, True if artist is included in layout calculations.
get_interpolation()
Return the interpolation method the image uses when resizing.
get_interpolation_stage()
Return when interpolation happens during the transform to RGBA.
get_label()
Return the label used for this artist in the legend.
get_mouseover()
Return whether this artist is queried for custom context information when the mouse cursor moves over it.
get_picker()
Return the picking behavior of the artist.
get_rasterized()
Return whether the artist is to be rasterized.
get_resample()
Return whether image resampling is used.
get_shape()
Return the shape of the image as tuple (numrows, numcols, channels).
get_size()
Return the size of the image as tuple (numrows, numcols).
get_sketch_params()
Return the sketch parameters for the artist.
get_snap()
Return the snap setting.
get_tightbbox([renderer])
Like .Artist.get_window_extent, but includes any clipping.
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()
Return the url.
get_visible()
Return the visibility.
get_window_extent([renderer])
Get the artist's bounding box in display space.
get_zorder()
Return the artist's zorder.
have_units()
Return whether units are set on any axis.
is_transform_set()
Return whether the Artist has an explicitly set transform.
make_image(renderer[, magnification, unsampled])
Normalize, rescale, and colormap this image's data for rendering using renderer, with the given magnification.
pchanged()
Call all of the registered callbacks.
pick(mouseevent)
Process a pick event.
pick_color_from_image(renderer, xy)
xy in display coordinate.
pickable()
Return whether the artist is pickable.
properties()
Return a dictionary of all the properties of the artist.
remove()
Remove the artist from the figure if possible.
remove_callback(oid)
Remove a callback based on its observer id.
set(*[, agg_filter, alpha, animated, array, ...])
Set multiple properties at once.
set_agg_filter(filter_func)
Set the agg filter.
set_alpha(alpha)
Set the alpha value used for blending - not supported on all backends.
set_animated(b)
Set whether the artist is intended to be used in an animation.
set_array(A)
Retained for backwards compatibility - use set_data instead.
set_bbox(bbox)
bbox or a callable which take a renderer as an arguemnt
set_clim([vmin, vmax])
Set the norm limits for image scaling.
set_clip_box(clipbox)
Set the artist's clip .Bbox.
set_clip_on(b)
Set whether the artist uses clipping.
set_clip_path(path[, transform])
Set the artist's clip path.
set_cmap(cmap)
Set the colormap for luminance data.
set_data(A)
Set the image array.
set_figure(fig)
Set the .Figure or .SubFigure instance the artist belongs to.
set_filternorm(filternorm)
Set whether the resize filter normalizes the weights.
set_filterrad(filterrad)
Set the resize filter radius only applicable to some interpolation schemes -- see help for imshow
set_gid(gid)
Set the (group) id for the artist.
set_in_layout(in_layout)
Set if artist is to be included in layout calculations, E.g.
set_interpolation(s)
Set the interpolation method the image uses when resizing.
set_interpolation_stage(s)
Set when interpolation happens during the transform to RGBA.
set_label(s)
Set a label that will be displayed in the legend.
set_mouseover(mouseover)
Set whether this artist is queried for custom context information when the mouse cursor moves over it.
set_norm(norm)
Set the normalization instance.
set_path_effects(path_effects)
Set the path effects.
set_picker(picker)
Define the picking behavior of the artist.
set_rasterized(rasterized)
Force rasterized (bitmap) drawing for vector graphics output.
set_resample(v)
Set whether image resampling is used.
set_sketch_params([scale, length, randomness])
Set the sketch parameters.
set_snap(snap)
Set the snapping behavior.
set_transform(t)
Set the artist transform.
set_url(url)
Set the url for the artist.
set_visible(b)
Set the artist's visibility.
set_zorder(level)
Set the zorder for the artist.
to_rgba(x[, alpha, bytes, norm])
Return a normalized RGBA array corresponding to x.
update(props)
Update this artist's properties from the dict props.
update_A()
the array need to be explicitly updated if color or alpha is changed after initialiation
update_from(other)
Copy properties from other to self.
write_png(fname)
Write the image to png file fname.
get_color
get_path_effects
init_data_n_alpha
set_color
set_coords
set_extent
Draw the Artist (and its children) using the given renderer.
This has no effect if the artist is not visible (.Artist.get_visible returns False).
renderer (~matplotlib.backend_bases.RendererBase subclass.)
Notes
This method is overridden in the Artist subclasses.
Return the alpha value used for blending - not supported on all backends.
Set multiple properties at once.
Supported properties are
agg_filter: a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image alpha: float or 2D array-like or None animated: bool array: array-like bbox: unknown clim: (vmin: float, vmax: float) clip_box: ~matplotlib.transforms.BboxBase or None clip_on: bool clip_path: Patch or (Path, Transform) or None cmap: .Colormap or str or None color: unknown coords: unknown data: array-like or PIL.Image.Image extent: unknown figure: ~matplotlib.figure.Figure or ~matplotlib.figure.SubFigure filternorm: bool filterrad: positive float gid: str in_layout: bool interpolation: {‘auto’, ‘nearest’, ‘bilinear’, ‘bicubic’, ‘spline16’, ‘spline36’, ‘hanning’, ‘hamming’, ‘hermite’, ‘kaiser’, ‘quadric’, ‘catrom’, ‘gaussian’, ‘bessel’, ‘mitchell’, ‘sinc’, ‘lanczos’, ‘none’} or None interpolation_stage: {‘data’, ‘rgba’, ‘auto’} or None label: object mouseover: bool norm: .Normalize or str or None path_effects: list of .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: ~matplotlib.transforms.Transform url: str visible: bool zorder: float
Bases: TransformedBboxBase
axes
The ~.axes.Axes instance the artist resides in, or None.
colorbar
The last colorbar associated with this object.
figure
The (Sub)Figure that the artist is on.
mouseover
Return whether this artist is queried for custom context information when the mouse cursor moves over it.
stale
Whether the artist is ‘stale’ and needs to be re-drawn for the output to match the internal state of the artist.
sticky_edges
x and y sticky edge lists for autoscaling.
Methods
add_callback(func)
Add a callback function that will be called whenever one of the .Artist's properties changes.
autoscale()
Autoscale the scalar limits on the norm instance using the current array
autoscale_None()
Autoscale the scalar limits on the norm instance using the current array, changing only limits that are None
can_composite()
Return whether the image can be composited with its neighbors.
changed()
Call this whenever the mappable is changed so observers can update.
contains(mouseevent)
Test whether the mouse event occurred within the image.
convert_xunits(x)
Convert x using the unit type of the xaxis.
convert_yunits(y)
Convert y using the unit type of the yaxis.
draw(renderer)
Draw the Artist (and its children) using the given renderer.
findobj([match, include_self])
Find artist objects.
format_cursor_data(data)
Return a string representation of data.
get_agg_filter()
Return filter function to be used for agg filter.
get_animated()
Return whether the artist is animated.
get_array()
Return the array of values, that are mapped to colors.
get_children()
Return a list of the child .Artists of this .Artist.
get_clim()
Return the values (min, max) that are mapped to the colormap limits.
get_clip_box()
Return the clipbox.
get_clip_on()
Return whether the artist uses clipping.
get_clip_path()
Return the clip path.
get_cmap()
Return the .Colormap instance.
get_cursor_data(event)
Return the cursor data for a given event.
get_figure([root])
Return the .Figure or .SubFigure instance the artist belongs to.
get_filternorm()
Return whether the resize filter normalizes the weights.
get_filterrad()
Return the filterrad setting.
get_gid()
Return the group id.
get_in_layout()
Return boolean flag, True if artist is included in layout calculations.
get_interpolation()
Return the interpolation method the image uses when resizing.
get_interpolation_stage()
Return when interpolation happens during the transform to RGBA.
get_label()
Return the label used for this artist in the legend.
get_mouseover()
Return whether this artist is queried for custom context information when the mouse cursor moves over it.
get_picker()
Return the picking behavior of the artist.
get_rasterized()
Return whether the artist is to be rasterized.
get_resample()
Return whether image resampling is used.
get_shape()
Return the shape of the image as tuple (numrows, numcols, channels).
get_size()
Return the size of the image as tuple (numrows, numcols).
get_sketch_params()
Return the sketch parameters for the artist.
get_snap()
Return the snap setting.
get_tightbbox([renderer])
Like .Artist.get_window_extent, but includes any clipping.
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()
Return the url.
get_visible()
Return the visibility.
get_window_extent([renderer])
Get the artist's bounding box in display space.
get_zorder()
Return the artist's zorder.
have_units()
Return whether units are set on any axis.
is_transform_set()
Return whether the Artist has an explicitly set transform.
make_image(renderer[, magnification, unsampled])
Normalize, rescale, and colormap this image's data for rendering using renderer, with the given magnification.
pchanged()
Call all of the registered callbacks.
pick(mouseevent)
Process a pick event.
pick_color_from_image(renderer, xy)
xy in display coordinate.
pickable()
Return whether the artist is pickable.
properties()
Return a dictionary of all the properties of the artist.
remove()
Remove the artist from the figure if possible.
remove_callback(oid)
Remove a callback based on its observer id.
set(*[, agg_filter, alpha, animated, array, ...])
Set multiple properties at once.
set_agg_filter(filter_func)
Set the agg filter.
set_alpha(alpha)
Set the alpha value used for blending - not supported on all backends.
set_animated(b)
Set whether the artist is intended to be used in an animation.
set_array(A)
Retained for backwards compatibility - use set_data instead.
set_bbox(bbox)
bbox or a callable which take a renderer as an arguemnt
set_clim([vmin, vmax])
Set the norm limits for image scaling.
set_clip_box(clipbox)
Set the artist's clip .Bbox.
set_clip_on(b)
Set whether the artist uses clipping.
set_clip_path(path[, transform])
Set the artist's clip path.
set_cmap(cmap)
Set the colormap for luminance data.
set_data(A)
Set the image array.
set_figure(fig)
Set the .Figure or .SubFigure instance the artist belongs to.
set_filternorm(filternorm)
Set whether the resize filter normalizes the weights.
set_filterrad(filterrad)
Set the resize filter radius only applicable to some interpolation schemes -- see help for imshow
set_gid(gid)
Set the (group) id for the artist.
set_in_layout(in_layout)
Set if artist is to be included in layout calculations, E.g.
set_interpolation(s)
Set the interpolation method the image uses when resizing.
set_interpolation_stage(s)
Set when interpolation happens during the transform to RGBA.
set_label(s)
Set a label that will be displayed in the legend.
set_mouseover(mouseover)
Set whether this artist is queried for custom context information when the mouse cursor moves over it.
set_norm(norm)
Set the normalization instance.
set_path_effects(path_effects)
Set the path effects.
set_picker(picker)
Define the picking behavior of the artist.
set_rasterized(rasterized)
Force rasterized (bitmap) drawing for vector graphics output.
set_resample(v)
Set whether image resampling is used.
set_sketch_params([scale, length, randomness])
Set the sketch parameters.
set_snap(snap)
Set the snapping behavior.
set_transform(t)
Set the artist transform.
set_url(url)
Set the url for the artist.
set_visible(b)
Set the artist's visibility.
set_zorder(level)
Set the zorder for the artist.
to_rgba(x[, alpha, bytes, norm])
Return a normalized RGBA array corresponding to x.
update(props)
Update this artist's properties from the dict props.
update_from(other)
Copy properties from other to self.
write_png(fname)
Write the image to png file fname.
get_alpha
get_path_effects
init_data_n_alpha
set_coords
set_extent
Set multiple properties at once.
Supported properties are
agg_filter: a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image alpha: float or 2D array-like or None animated: bool array: array-like bbox: unknown clim: (vmin: float, vmax: float) clip_box: ~matplotlib.transforms.BboxBase or None clip_on: bool clip_path: Patch or (Path, Transform) or None cmap: .Colormap or str or None coords: unknown data: array-like or PIL.Image.Image extent: unknown figure: ~matplotlib.figure.Figure or ~matplotlib.figure.SubFigure filternorm: bool filterrad: positive float gid: str in_layout: bool interpolation: {‘auto’, ‘nearest’, ‘bilinear’, ‘bicubic’, ‘spline16’, ‘spline36’, ‘hanning’, ‘hamming’, ‘hermite’, ‘kaiser’, ‘quadric’, ‘catrom’, ‘gaussian’, ‘bessel’, ‘mitchell’, ‘sinc’, ‘lanczos’, ‘none’} or None interpolation_stage: {‘data’, ‘rgba’, ‘auto’} or None label: object mouseover: bool norm: .Normalize or str or None path_effects: list of .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: ~matplotlib.transforms.Transform url: str visible: bool zorder: float
Return a normalized RGBA array corresponding to x.
In the normal case, x is a 1D or 2D sequence of scalars, and the corresponding ~numpy.ndarray of RGBA values will be returned, based on the norm and colormap set for this Colorizer.
There is one special case, for handling images that are already RGB or RGBA, such as might have been read from an image file. If x is an ~numpy.ndarray with 3 dimensions, and the last dimension is either 3 or 4, then it will be treated as an RGB or RGBA array, and no mapping will be done. The array can be ~numpy.uint8, or it can be floats with values in the 0-1 range; otherwise a ValueError will be raised. Any NaNs or masked elements will be set to 0 alpha. If the last dimension is 3, the alpha kwarg (defaulting to 1) will be used to fill in the transparency. If the last dimension is 4, the alpha kwarg is ignored; it does not replace the preexisting alpha. A ValueError will be raised if the third dimension is other than 3 or 4.
In either case, if bytes is False (default), the RGBA array will be floats in the 0-1 range; if it is True, the returned RGBA array will be ~numpy.uint8 in the 0 to 255 range.
If norm is False, no normalization of the input data is performed, and it is assumed to be in the range (0-1).
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4