| | |
Methods defined here:
- __init__(self, figsize=None, dpi=None, facecolor=None, edgecolor=None, frameon=True)
- paper size is a w,h tuple in inches
DPI is dots per inch
- add_axes(self, rect, axisbg=None, frameon=True)
- Add an a axes with axes rect [left, bottom, width, height]
where all quantities are in fractions of figure width and
height.
The Axes instance will be returned
- add_axis(self, *args, **kwargs)
- add_subplot(self, *args, **kwargs)
- Add an a subplot, eg
add_subplot(111) or add_subplot(212, axisbg='r')
The Axes instance will be returned
- clear(self)
- Clear the figure
- clf(self)
- Clear the figure
- draw(self, renderer)
- Render the figure using RendererGD instance renderer
- figimage(self, X, xo=0, yo=0, alpha=1.0, norm=None, cmap=None, vmin=None, vmax=None, origin=None)
- FIGIMAGE(X) # add non-resampled array to figure
FIGIMAGE(X, xo, yo) # with pixel offsets
FIGIMAGE(X, **kwargs) # control interpolation ,scaling, etc
Add a nonresampled figure to the figure from array X. xo and yo are
offsets in pixels
X must be a float array
If X is MxN, assume luminance (grayscale)
If X is MxNx3, assume RGB
If X is MxNx4, assume RGBA
The following kwargs are allowed:
* cmap is a cm colormap instance, eg cm.jet. If None, default to
the rc image.cmap valuex
* norm is a matplotlib.colors.normalize instance; default is
normalization(). This scales luminance -> 0-1
* vmin and vmax are used to scale a luminance image to 0-1. If
either is None, the min and max of the luminance values will be
used. Note if you pass a norm instance, the settings for vmin and
vmax will be ignored.
* alpha = 1.0 : the alpha blending value
* origin is either 'upper' or 'lower', which indicates where the [0,0]
index of the array is in the upper left or lower left corner of
the axes. Defaults to the rc image.origin value
This complements the axes image which will be resampled to fit the
current axes. If you want a resampled image to fill the entire
figure, you can define an Axes with size [0,1,0,1].
A image.FigureImage instance is returned.
- get_axes(self)
- get_edgecolor(self)
- Get the edge color of the Figure rectangle
- get_facecolor(self)
- Get the face color of the Figure rectangle
- get_size_inches(self)
- get_width_height(self)
- return the figure width and height in pixels
- hold(self, b=None)
- Set the hold state. If hold is None (default), toggle the
hold state. Else set the hold state to boolean value b.
Eg
hold() # toggle hold
hold(True) # hold is on
hold(False) # hold is off
- legend(self, handles, labels, loc)
- Place a legend in the figure. Labels are a sequence of
strings, handles is a sequence of line or patch instances, and
loc can be a string or an integer specifying the legend
location
USAGE:
legend( (line1, line2, line3),
('label1', 'label2', 'label3'),
'upper right')
The LOC location codes are
'best' : 0, (currently not supported, defaults to upper right)
'upper right' : 1, (default)
'upper left' : 2,
'lower left' : 3,
'lower right' : 4,
'right' : 5,
'center left' : 6,
'center right' : 7,
'lower center' : 8,
'upper center' : 9,
'center' : 10,
The legend instance is returned
- set_edgecolor(self, color)
- Set the edge color of the Figure rectangle
- set_facecolor(self, color)
- Set the face color of the Figure rectangle
- set_figsize_inches(self, w, h)
- set the figure size in inches
- text(self, x, y, s, *args, **kwargs)
- Add text to figure at location x,y (relative 0-1 coords) See
the help for Axis text for the meaning of the other arguments
Methods inherited from matplotlib.artist.Artist:
- get_alpha(self)
- Return the alpha value used for blending - not supported on
all backends
- get_clip_on(self)
- Return whether artist uses clipping
- get_transform(self)
- return the Transformation instance used by this artist
- get_visible(self)
- return the artist's visiblity
- is_figure_set(self)
- is_transform_set(self)
- Artist has transform explicity let
- set_alpha(self, alpha)
- Set the alpha value used for blending - not supported on
all backends
- set_clip_box(self, clipbox)
- Set the artist's clip Bbox
- set_clip_on(self, b)
- Set whether artist uses clipping
- set_figure(self, fig)
- Set the figure instance the artist belong to
- set_lod(self, on)
- Set Level of Detail on or off. If on, the artists may examine
things like the pixel width of the axes and draw a subset of
their contents accordingly
- set_transform(self, t)
- set the Transformation instance used by this artist
- set_visible(self, b)
- set the artist's visiblity
Data and other attributes inherited from matplotlib.artist.Artist:
- aname = 'Artist'
|