Menu
▾
▴
[r4812]: / trunk / htdocs / matplotlib.figure.html.template Maximize Restore History
791 lines (700 with data), 62.9 kB
@header@
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="matplotlib.html"><font color="#ffffff">matplotlib</font></a>.figure</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jdhunter/dev/lib/python2.5/site-packages/matplotlib/figure.py">/home/jdhunter/dev/lib/python2.5/site-packages/matplotlib/figure.py</a></font></td></tr></table>
<p><tt><a href="#Figure">Figure</a> class -- add docstring here!</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="matplotlib._image.html">matplotlib._image</a><br>
<a href="matplotlib.artist.html">matplotlib.artist</a><br>
</td><td width="25%" valign=top><a href="matplotlib.colorbar.html">matplotlib.colorbar</a><br>
<a href="numpy.html">numpy</a><br>
</td><td width="25%" valign=top><a href="os.html">os</a><br>
<a href="sys.html">sys</a><br>
</td><td width="25%" valign=top><a href="warnings.html">warnings</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.figure.html#Figure">Figure</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="matplotlib.figure.html#SubplotParams">SubplotParams</a>
</font></dt></dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="Figure">class <strong>Figure</strong></a>(<a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Figure-__init__"><strong>__init__</strong></a>(self, figsize<font color="#909090">=None</font>, dpi<font color="#909090">=None</font>, facecolor<font color="#909090">=None</font>, edgecolor<font color="#909090">=None</font>, linewidth<font color="#909090">=1.0</font>, frameon<font color="#909090">=True</font>, subplotpars<font color="#909090">=None</font>)</dt><dd><tt>figsize is a w,h tuple in inches<br>
dpi is dots per inch<br>
subplotpars is a <a href="#SubplotParams">SubplotParams</a> instance, defaults to rc</tt></dd></dl>
<dl><dt><a name="Figure-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="Figure-add_axes"><strong>add_axes</strong></a>(self, *args, **kwargs)</dt><dd><tt>Add an a axes with axes rect [left, bottom, width, height] where all<br>
quantities are in fractions of figure width and height. kwargs are<br>
legal Axes kwargs plus "polar" which sets whether to create a polar axes<br>
<br>
rect = l,b,w,h<br>
<a href="#Figure-add_axes">add_axes</a>(rect)<br>
<a href="#Figure-add_axes">add_axes</a>(rect, frameon=False, axisbg='g')<br>
<a href="#Figure-add_axes">add_axes</a>(rect, polar=True)<br>
<a href="#Figure-add_axes">add_axes</a>(ax) # add an Axes instance<br>
<br>
<br>
If the figure already has an axes with key *args, *kwargs then it will<br>
simply make that axes current and return it. If you do not want this<br>
behavior, eg you want to force the creation of a new axes, you must<br>
use a unique set of args and kwargs. The artist "label" attribute has<br>
been exposed for this purpose. Eg, if you want two axes that are<br>
otherwise identical to be added to the figure, make sure you give them<br>
unique labels:<br>
<br>
<a href="#Figure-add_axes">add_axes</a>(rect, label='axes1')<br>
<a href="#Figure-add_axes">add_axes</a>(rect, label='axes2')<br>
<br>
The Axes instance will be returned<br>
<br>
The following kwargs are supported:<br>
adjustable: ['box' | 'datalim']<br>
alpha: float<br>
anchor: ['C', 'SW', 'S', 'SE', 'E', 'NE', 'N', 'NW', 'W']<br>
animated: [True | False]<br>
aspect: ['auto' | 'equal' | aspect_ratio]<br>
autoscale_on: True|False<br>
axes: an axes instance<br>
axis_bgcolor: any matplotlib color - see help(colors)<br>
axis_off: void<br>
axis_on: void<br>
axisbelow: True|False<br>
clip_box: a matplotlib.transform.Bbox instance<br>
clip_on: [True | False]<br>
clip_path: an agg.path_storage instance<br>
contains: unknown<br>
cursor_props: a (float, color) tuple<br>
figure: a <a href="#Figure">Figure</a> instance<br>
frame_on: True|False<br>
label: any string<br>
lod: [True | False]<br>
navigate: True|False<br>
navigate_mode: unknown<br>
picker: [None|float|boolean|callable]<br>
position: len(4) sequence of floats<br>
title: unknown<br>
transform: a matplotlib.transform transformation instance<br>
visible: [True | False]<br>
xbound: unknown<br>
xlabel: unknown<br>
xlim: len(2) sequence of floats<br>
xscale: ['log' | 'linear' ]<br>
xticklabels: unknown<br>
xticks: sequence of floats<br>
ybound: unknown<br>
ylabel: unknown<br>
ylim: len(2) sequence of floats<br>
yscale: ['log' | 'linear']<br>
yticklabels: unknown<br>
yticks: sequence of floats<br>
zorder: any number</tt></dd></dl>
<dl><dt><a name="Figure-add_axobserver"><strong>add_axobserver</strong></a>(self, func)</dt><dd><tt>whenever the axes state change, func(self) will be called</tt></dd></dl>
<dl><dt><a name="Figure-add_subplot"><strong>add_subplot</strong></a>(self, *args, **kwargs)</dt><dd><tt>Add a subplot. Examples<br>
<br>
<a href="#Figure-add_subplot">add_subplot</a>(111)<br>
<a href="#Figure-add_subplot">add_subplot</a>(1,1,1) # equivalent but more general<br>
<a href="#Figure-add_subplot">add_subplot</a>(212, axisbg='r') # add subplot with red background<br>
<a href="#Figure-add_subplot">add_subplot</a>(111, polar=True) # add a polar subplot<br>
<a href="#Figure-add_subplot">add_subplot</a>(sub) # add Subplot instance sub<br>
<br>
kwargs are legal Axes kwargs plus"polar" which sets whether to create a<br>
polar axes. The Axes instance will be returned.<br>
<br>
If the figure already has a subplot with key *args, *kwargs then it will<br>
simply make that subplot current and return it<br>
<br>
The following kwargs are supported:<br>
adjustable: ['box' | 'datalim']<br>
alpha: float<br>
anchor: ['C', 'SW', 'S', 'SE', 'E', 'NE', 'N', 'NW', 'W']<br>
animated: [True | False]<br>
aspect: ['auto' | 'equal' | aspect_ratio]<br>
autoscale_on: True|False<br>
axes: an axes instance<br>
axis_bgcolor: any matplotlib color - see help(colors)<br>
axis_off: void<br>
axis_on: void<br>
axisbelow: True|False<br>
clip_box: a matplotlib.transform.Bbox instance<br>
clip_on: [True | False]<br>
clip_path: an agg.path_storage instance<br>
contains: unknown<br>
cursor_props: a (float, color) tuple<br>
figure: a <a href="#Figure">Figure</a> instance<br>
frame_on: True|False<br>
label: any string<br>
lod: [True | False]<br>
navigate: True|False<br>
navigate_mode: unknown<br>
picker: [None|float|boolean|callable]<br>
position: len(4) sequence of floats<br>
title: unknown<br>
transform: a matplotlib.transform transformation instance<br>
visible: [True | False]<br>
xbound: unknown<br>
xlabel: unknown<br>
xlim: len(2) sequence of floats<br>
xscale: ['log' | 'linear' ]<br>
xticklabels: unknown<br>
xticks: sequence of floats<br>
ybound: unknown<br>
ylabel: unknown<br>
ylim: len(2) sequence of floats<br>
yscale: ['log' | 'linear']<br>
yticklabels: unknown<br>
yticks: sequence of floats<br>
zorder: any number</tt></dd></dl>
<dl><dt><a name="Figure-autofmt_xdate"><strong>autofmt_xdate</strong></a>(self, bottom<font color="#909090">=0.20000000000000001</font>, rotation<font color="#909090">=30</font>, ha<font color="#909090">='right'</font>)</dt><dd><tt>Date ticklabels often overlap, so it is useful to rotate them<br>
and right align them. Also, a common use case is a number of<br>
subplots with shared xaxes where the x-axis is date data. The<br>
ticklabels are often long, and it helps to rotate them on the<br>
bottom subplot and turn them off on other subplots, as well as<br>
turn off xlabels.<br>
<br>
<br>
bottom : the bottom of the subplots for subplots_adjust<br>
rotation: the rotation of the xtick labels<br>
ha : the horizontal alignment of the xticklabels</tt></dd></dl>
<dl><dt><a name="Figure-clear"><strong>clear</strong></a>(self)</dt><dd><tt>Clear the figure</tt></dd></dl>
<dl><dt><a name="Figure-clf"><strong>clf</strong></a>(self)</dt><dd><tt>Clear the figure</tt></dd></dl>
<dl><dt><a name="Figure-colorbar"><strong>colorbar</strong></a>(self, mappable, cax<font color="#909090">=None</font>, ax<font color="#909090">=None</font>, **kw)</dt><dd><tt> Create a colorbar for a ScalarMappable instance.<br>
<br>
Documentation for the pylab thin wrapper: <br>
Add a colorbar to a plot.<br>
<br>
Function signatures for the pyplot interface; all but the first are<br>
also method signatures for the <a href="#Figure">Figure</a>.colorbar method:<br>
<br>
<a href="#Figure-colorbar">colorbar</a>(**kwargs)<br>
<a href="#Figure-colorbar">colorbar</a>(mappable, **kwargs)<br>
<a href="#Figure-colorbar">colorbar</a>(mappable, cax=cax, **kwargs)<br>
<a href="#Figure-colorbar">colorbar</a>(mappable, ax=ax, **kwargs)<br>
<br>
arguments:<br>
mappable: the image, ContourSet, etc. to which the colorbar applies;<br>
this argument is mandatory for the <a href="#Figure">Figure</a>.colorbar<br>
method but optional for the pyplot.colorbar function,<br>
which sets the default to the current image.<br>
<br>
keyword arguments:<br>
cax: None | axes object into which the colorbar will be drawn<br>
ax: None | parent axes object from which space for a new<br>
colorbar axes will be stolen<br>
<br>
<br>
**kwargs are in two groups:<br>
axes properties:<br>
<br>
fraction = 0.15; fraction of original axes to use for colorbar<br>
pad = 0.05 if vertical, 0.15 if horizontal; fraction<br>
of original axes between colorbar and<br>
new image axes<br>
shrink = 1.0; fraction by which to shrink the colorbar<br>
aspect = 20; ratio of long to short dimensions<br>
<br>
<br>
colorbar properties:<br>
<br>
extend='neither', 'both', 'min', 'max'<br>
If not 'neither', make pointed end(s) for out-of-range<br>
values. These are set for a given colormap using the<br>
colormap set_under and set_over methods.<br>
spacing='uniform', 'proportional'<br>
Uniform spacing gives each discrete color the same space;<br>
proportional makes the space proportional to the data interval.<br>
ticks=None, list of ticks, Locator object<br>
If None, ticks are determined automatically from the input.<br>
format=None, format string, Formatter object<br>
If none, the ScalarFormatter is used.<br>
If a format string is given, e.g. '%.3f', that is used.<br>
An alternative Formatter object may be given instead.<br>
drawedges=False, True<br>
If true, draw lines at color boundaries.<br>
<br>
The following will probably be useful only in the context of<br>
indexed colors (that is, when the mappable has norm=NoNorm()),<br>
or other unusual circumstances.<br>
<br>
boundaries=None or a sequence<br>
values=None or a sequence which must be of length 1 less than the<br>
sequence of boundaries.<br>
For each region delimited by adjacent entries in<br>
boundaries, the color mapped to the corresponding<br>
value in values will be used.<br>
<br>
<br>
<br>
If mappable is a ContourSet, its extend kwarg is included automatically.<br>
<br>
Note that the shrink kwarg provides a simple way to keep<br>
a vertical colorbar, for example, from being taller than<br>
the axes of the mappable to which the colorbar is attached;<br>
but it is a manual method requiring some trial and error.<br>
If the colorbar is too tall (or a horizontal colorbar is<br>
too wide) use a smaller value of shrink.<br>
<br>
For more precise control, you can manually specify the<br>
positions of the axes objects in which the mappable and<br>
the colorbar are drawn. In this case, do not use any of the<br>
axes properties kwargs.</tt></dd></dl>
<dl><dt><a name="Figure-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred on the figure.<br>
<br>
Returns True,{}</tt></dd></dl>
<dl><dt><a name="Figure-delaxes"><strong>delaxes</strong></a>(self, a)</dt><dd><tt>remove a from the figure and update the current axes</tt></dd></dl>
<dl><dt><a name="Figure-draw"><strong>draw</strong></a>(self, renderer)</dt><dd><tt>Render the figure using Renderer instance renderer</tt></dd></dl>
<dl><dt><a name="Figure-draw_artist"><strong>draw_artist</strong></a>(self, a)</dt><dd><tt>draw artist only -- this is available only after the figure is drawn</tt></dd></dl>
<dl><dt><a name="Figure-figimage"><strong>figimage</strong></a>(self, X, xo<font color="#909090">=0</font>, yo<font color="#909090">=0</font>, alpha<font color="#909090">=1.0</font>, norm<font color="#909090">=None</font>, cmap<font color="#909090">=None</font>, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>, origin<font color="#909090">=None</font>)</dt><dd><tt>FIGIMAGE(X) # add non-resampled array to figure<br>
<br>
FIGIMAGE(X, xo, yo) # with pixel offsets<br>
<br>
FIGIMAGE(X, **kwargs) # control interpolation ,scaling, etc<br>
<br>
Add a nonresampled figure to the figure from array X. xo and yo are<br>
offsets in pixels<br>
<br>
X must be a float array<br>
<br>
If X is MxN, assume luminance (grayscale)<br>
If X is MxNx3, assume RGB<br>
If X is MxNx4, assume RGBA<br>
<br>
The following kwargs are allowed:<br>
<br>
* cmap is a cm colormap instance, eg cm.jet. If None, default to<br>
the rc image.cmap valuex<br>
<br>
* norm is a matplotlib.colors.Normalize instance; default is<br>
normalization(). This scales luminance -> 0-1<br>
<br>
* vmin and vmax are used to scale a luminance image to 0-1. If<br>
either is None, the min and max of the luminance values will be<br>
used. Note if you pass a norm instance, the settings for vmin and<br>
vmax will be ignored.<br>
<br>
* alpha = 1.0 : the alpha blending value<br>
<br>
* origin is either 'upper' or 'lower', which indicates where the [0,0]<br>
index of the array is in the upper left or lower left corner of<br>
the axes. Defaults to the rc image.origin value<br>
<br>
This complements the axes image (Axes.imshow) which will be resampled<br>
to fit the current axes. If you want a resampled image to fill the<br>
entire figure, you can define an Axes with size [0,1,0,1].<br>
<br>
A image.FigureImage instance is returned.</tt></dd></dl>
<dl><dt><a name="Figure-gca"><strong>gca</strong></a>(self, **kwargs)</dt><dd><tt>Return the current axes, creating one if necessary<br>
<br>
The following kwargs are supported<br>
adjustable: ['box' | 'datalim']<br>
alpha: float<br>
anchor: ['C', 'SW', 'S', 'SE', 'E', 'NE', 'N', 'NW', 'W']<br>
animated: [True | False]<br>
aspect: ['auto' | 'equal' | aspect_ratio]<br>
autoscale_on: True|False<br>
axes: an axes instance<br>
axis_bgcolor: any matplotlib color - see help(colors)<br>
axis_off: void<br>
axis_on: void<br>
axisbelow: True|False<br>
clip_box: a matplotlib.transform.Bbox instance<br>
clip_on: [True | False]<br>
clip_path: an agg.path_storage instance<br>
contains: unknown<br>
cursor_props: a (float, color) tuple<br>
figure: a <a href="#Figure">Figure</a> instance<br>
frame_on: True|False<br>
label: any string<br>
lod: [True | False]<br>
navigate: True|False<br>
navigate_mode: unknown<br>
picker: [None|float|boolean|callable]<br>
position: len(4) sequence of floats<br>
title: unknown<br>
transform: a matplotlib.transform transformation instance<br>
visible: [True | False]<br>
xbound: unknown<br>
xlabel: unknown<br>
xlim: len(2) sequence of floats<br>
xscale: ['log' | 'linear' ]<br>
xticklabels: unknown<br>
xticks: sequence of floats<br>
ybound: unknown<br>
ylabel: unknown<br>
ylim: len(2) sequence of floats<br>
yscale: ['log' | 'linear']<br>
yticklabels: unknown<br>
yticks: sequence of floats<br>
zorder: any number</tt></dd></dl>
<dl><dt><a name="Figure-get_axes"><strong>get_axes</strong></a>(self)</dt></dl>
<dl><dt><a name="Figure-get_children"><strong>get_children</strong></a>(self)</dt><dd><tt>get a list of artists contained in the figure</tt></dd></dl>
<dl><dt><a name="Figure-get_dpi"><strong>get_dpi</strong></a>(self)</dt><dd><tt>Return the dpi as a float</tt></dd></dl>
<dl><dt><a name="Figure-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt><dd><tt>Get the edge color of the <a href="#Figure">Figure</a> rectangle</tt></dd></dl>
<dl><dt><a name="Figure-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt><dd><tt>Get the face color of the <a href="#Figure">Figure</a> rectangle</tt></dd></dl>
<dl><dt><a name="Figure-get_figheight"><strong>get_figheight</strong></a>(self)</dt><dd><tt>Return the figheight as a float</tt></dd></dl>
<dl><dt><a name="Figure-get_figwidth"><strong>get_figwidth</strong></a>(self)</dt><dd><tt>Return the figwidth as a float</tt></dd></dl>
<dl><dt><a name="Figure-get_frameon"><strong>get_frameon</strong></a>(self)</dt><dd><tt>get the boolean indicating frameon</tt></dd></dl>
<dl><dt><a name="Figure-get_size_inches"><strong>get_size_inches</strong></a>(self)</dt></dl>
<dl><dt><a name="Figure-get_window_extent"><strong>get_window_extent</strong></a>(self, *args, **kwargs)</dt><dd><tt>get the figure bounding box in display space; kwargs are void</tt></dd></dl>
<dl><dt><a name="Figure-hold"><strong>hold</strong></a>(self, b<font color="#909090">=None</font>)</dt><dd><tt>Set the hold state. If hold is None (default), toggle the<br>
hold state. Else set the hold state to boolean value b.<br>
<br>
Eg<br>
<a href="#Figure-hold">hold</a>() # toggle hold<br>
<a href="#Figure-hold">hold</a>(True) # hold is on<br>
<a href="#Figure-hold">hold</a>(False) # hold is off</tt></dd></dl>
<dl><dt><a name="Figure-legend"><strong>legend</strong></a>(self, handles, labels, *args, **kwargs)</dt><dd><tt>Place a legend in the figure. Labels are a sequence of<br>
strings, handles is a sequence of line or patch instances, and<br>
loc can be a string or an integer specifying the legend<br>
location<br>
<br>
USAGE:<br>
<a href="#Figure-legend">legend</a>( (line1, line2, line3),<br>
('label1', 'label2', 'label3'),<br>
'upper right')<br>
<br>
The LOC location codes are<br>
<br>
'best' : 0, (currently not supported for figure legends)<br>
'upper right' : 1,<br>
'upper left' : 2,<br>
'lower left' : 3,<br>
'lower right' : 4,<br>
'right' : 5,<br>
'center left' : 6,<br>
'center right' : 7,<br>
'lower center' : 8,<br>
'upper center' : 9,<br>
'center' : 10,<br>
<br>
loc can also be an (x,y) tuple in figure coords, which<br>
specifies the lower left of the legend box. figure coords are<br>
(0,0) is the left, bottom of the figure and 1,1 is the right,<br>
top.<br>
<br>
The legend instance is returned. The following kwargs are supported:<br>
<br>
loc = "upper right" #<br>
numpoints = 4 # the number of points in the legend line<br>
prop = FontProperties(size='smaller') # the font property<br>
pad = 0.2 # the fractional whitespace inside the legend border<br>
markerscale = 0.6 # the relative size of legend markers vs. original<br>
shadow # if True, draw a shadow behind legend<br>
labelsep = 0.005 # the vertical space between the legend entries<br>
handlelen = 0.05 # the length of the legend lines<br>
handletextsep = 0.02 # the space between the legend line and legend text<br>
axespad = 0.02 # the border between the axes and legend edge</tt></dd></dl>
<dl><dt><a name="Figure-savefig"><strong>savefig</strong></a>(self, *args, **kwargs)</dt><dd><tt>SAVEFIG(fname, dpi=None, facecolor='w', edgecolor='w',<br>
orientation='portrait', papertype=None, format=None):<br>
<br>
Save the current figure.<br>
<br>
fname - the filename to save the current figure to. The<br>
output formats supported depend on the backend being<br>
used. and are deduced by the extension to fname.<br>
Possibilities are eps, jpeg, pdf, png, ps, svg. fname<br>
can also be a file or file-like object - cairo backend<br>
only.<br>
<br>
dpi - is the resolution in dots per inch. If<br>
None it will default to the value savefig.dpi in the<br>
matplotlibrc file<br>
<br>
facecolor and edgecolor are the colors of the figure rectangle<br>
<br>
orientation is either 'landscape' or 'portrait' - not supported on<br>
all backends; currently only on postscript output<br>
<br>
papertype is is one of 'letter', 'legal', 'executive', 'ledger', 'a0'<br>
through 'a10', or 'b0' through 'b10' - only supported for postscript<br>
output<br>
<br>
format - one of the file extensions supported by the active backend.</tt></dd></dl>
<dl><dt><a name="Figure-sca"><strong>sca</strong></a>(self, a)</dt><dd><tt>Set the current axes to be a and return a</tt></dd></dl>
<dl><dt><a name="Figure-set_canvas"><strong>set_canvas</strong></a>(self, canvas)</dt><dd><tt>Set the canvas the contains the figure<br>
<br>
ACCEPTS: a FigureCanvas instance</tt></dd></dl>
<dl><dt><a name="Figure-set_dpi"><strong>set_dpi</strong></a>(self, val)</dt><dd><tt>Set the dots-per-inch of the figure<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Figure-set_edgecolor"><strong>set_edgecolor</strong></a>(self, color)</dt><dd><tt>Set the edge color of the <a href="#Figure">Figure</a> rectangle<br>
<br>
ACCEPTS: any matplotlib color - see help(colors)</tt></dd></dl>
<dl><dt><a name="Figure-set_facecolor"><strong>set_facecolor</strong></a>(self, color)</dt><dd><tt>Set the face color of the <a href="#Figure">Figure</a> rectangle<br>
<br>
ACCEPTS: any matplotlib color - see help(colors)</tt></dd></dl>
<dl><dt><a name="Figure-set_figheight"><strong>set_figheight</strong></a>(self, val)</dt><dd><tt>Set the height of the figure in inches<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Figure-set_figsize_inches"><strong>set_figsize_inches</strong></a>(self, *args, **kwargs)</dt></dl>
<dl><dt><a name="Figure-set_figwidth"><strong>set_figwidth</strong></a>(self, val)</dt><dd><tt>Set the width of the figure in inches<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Figure-set_frameon"><strong>set_frameon</strong></a>(self, b)</dt><dd><tt>Set whether the figure frame (background) is displayed or invisible<br>
<br>
ACCEPTS: boolean</tt></dd></dl>
<dl><dt><a name="Figure-set_size_inches"><strong>set_size_inches</strong></a>(self, *args, **kwargs)</dt><dd><tt><a href="#Figure-set_size_inches">set_size_inches</a>(w,h, forward=False)<br>
<br>
Set the figure size in inches<br>
<br>
Usage: <a href="#Figure-set_size_inches">set_size_inches</a>(self, w,h) OR<br>
<a href="#Figure-set_size_inches">set_size_inches</a>(self, (w,h) )<br>
<br>
optional kwarg forward=True will cause the canvas size to be<br>
automatically updated; eg you can resize the figure window<br>
from the shell<br>
<br>
WARNING: forward=True is broken on all backends except GTK*<br>
<br>
ACCEPTS: a w,h tuple with w,h in inches</tt></dd></dl>
<dl><dt><a name="Figure-subplots_adjust"><strong>subplots_adjust</strong></a>(self, *args, **kwargs)</dt><dd><tt><a href="#Figure-subplots_adjust">subplots_adjust</a>(self, left=None, bottom=None, right=None, top=None,<br>
wspace=None, hspace=None)<br>
fig.<a href="#Figure-subplots_adjust">subplots_adjust</a>(left=None, bottom=None, right=None, wspace=None, hspace=None):<br>
Update the <a href="#SubplotParams">SubplotParams</a> with kwargs (defaulting to rc where<br>
None) and update the subplot locations</tt></dd></dl>
<dl><dt><a name="Figure-text"><strong>text</strong></a>(self, x, y, s, *args, **kwargs)</dt><dd><tt>Add text to figure at location x,y (relative 0-1 coords) See<br>
the help for Axis text for the meaning of the other arguments<br>
<br>
kwargs control the Text properties:<br>
alpha: float<br>
animated: [True | False]<br>
axes: an axes instance<br>
backgroundcolor: any matplotlib color<br>
bbox: rectangle prop dict plus key 'pad' which is a pad in points<br>
clip_box: a matplotlib.transform.Bbox instance<br>
clip_on: [True | False]<br>
clip_path: an agg.path_storage instance<br>
color: any matplotlib color<br>
contains: unknown<br>
family: [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ]<br>
figure: a matplotlib.figure.<a href="#Figure">Figure</a> instance<br>
fontproperties: a matplotlib.font_manager.FontProperties instance<br>
horizontalalignment or ha: [ 'center' | 'right' | 'left' ]<br>
label: any string<br>
linespacing: float<br>
lod: [True | False]<br>
multialignment: ['left' | 'right' | 'center' ]<br>
name or fontname: string eg, ['Sans' | 'Courier' | 'Helvetica' ...]<br>
picker: [None|float|boolean|callable]<br>
position: (x,y)<br>
rotation: [ angle in degrees 'vertical' | 'horizontal'<br>
size or fontsize: [ size in points | relative size eg 'smaller', 'x-large' ]<br>
style or fontstyle: [ 'normal' | 'italic' | 'oblique']<br>
text: string or anything printable with '%s' conversion<br>
transform: a matplotlib.transform transformation instance<br>
variant: [ 'normal' | 'small-caps' ]<br>
verticalalignment or va: [ 'center' | 'top' | 'bottom' | 'baseline' ]<br>
visible: [True | False]<br>
weight or fontweight: [ 'normal' | 'bold' | 'heavy' | 'light' | 'ultrabold' | 'ultralight']<br>
x: float<br>
y: float<br>
zorder: any number</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><a name="Figure-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Figure-convert_xunits"><strong>convert_xunits</strong></a>(self, x)</dt><dd><tt>for artists in an axes, if the xaxis as units support,<br>
convert x using xaxis unit type</tt></dd></dl>
<dl><dt><a name="Figure-convert_yunits"><strong>convert_yunits</strong></a>(self, y)</dt><dd><tt>for artists in an axes, if the yaxis as units support,<br>
convert y using yaxis unit type</tt></dd></dl>
<dl><dt><a name="Figure-get_alpha"><strong>get_alpha</strong></a>(self)</dt><dd><tt>Return the alpha value used for blending - not supported on all<br>
backends</tt></dd></dl>
<dl><dt><a name="Figure-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Figure-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Figure-get_clip_on"><strong>get_clip_on</strong></a>(self)</dt><dd><tt>Return whether artist uses clipping</tt></dd></dl>
<dl><dt><a name="Figure-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Figure-get_contains"><strong>get_contains</strong></a>(self)</dt><dd><tt>return the _contains test used by the artist, or None for default.</tt></dd></dl>
<dl><dt><a name="Figure-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>return the figure instance</tt></dd></dl>
<dl><dt><a name="Figure-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Figure-get_picker"><strong>get_picker</strong></a>(self)</dt><dd><tt>return the Pickeration instance used by this artist</tt></dd></dl>
<dl><dt><a name="Figure-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>return the Transformation instance used by this artist</tt></dd></dl>
<dl><dt><a name="Figure-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Figure-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Figure-have_units"><strong>have_units</strong></a>(self)</dt><dd><tt>return True if units are set on the x or y axes</tt></dd></dl>
<dl><dt><a name="Figure-hitlist"><strong>hitlist</strong></a>(self, event)</dt><dd><tt>List the children of the artist which contain the mouse event</tt></dd></dl>
<dl><dt><a name="Figure-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Figure-is_transform_set"><strong>is_transform_set</strong></a>(self)</dt><dd><tt><a href="matplotlib.artist.html#Artist">Artist</a> has transform explicity let</tt></dd></dl>
<dl><dt><a name="Figure-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Figure-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt><a href="#Figure-pick">pick</a>(mouseevent)<br>
<br>
each child artist will fire a pick event if mouseevent is over<br>
the artist and the artist has picker set</tt></dd></dl>
<dl><dt><a name="Figure-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return True if self is pickable</tt></dd></dl>
<dl><dt><a name="Figure-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect will not<br>
be visible until the figure is redrawn, e.g., with ax.draw_idle().<br>
Call ax.relim() to update the axes limits if desired.<br>
<br>
Note: relim() will not see collections even if the collection<br>
was added to axes with autolim=True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="Figure-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Figure-set"><strong>set</strong></a>(self, **kwargs)</dt><dd><tt>A tkstyle set command, pass kwargs to set properties</tt></dd></dl>
<dl><dt><a name="Figure-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha value used for blending - not supported on<br>
all backends<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Figure-set_animated"><strong>set_animated</strong></a>(self, b)</dt><dd><tt>set the artist's animation state<br>
<br>
ACCEPTS: [True | False]</tt></dd></dl>
<dl><dt><a name="Figure-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance the artist resides in, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="Figure-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
ACCEPTS: a matplotlib.transform.Bbox instance</tt></dd></dl>
<dl><dt><a name="Figure-set_clip_on"><strong>set_clip_on</strong></a>(self, b)</dt><dd><tt>Set whether artist uses clipping<br>
<br>
ACCEPTS: [True | False]</tt></dd></dl>
<dl><dt><a name="Figure-set_clip_path"><strong>set_clip_path</strong></a>(self, path)</dt><dd><tt>Set the artist's clip path<br>
<br>
ACCEPTS: an agg.path_storage instance</tt></dd></dl>
<dl><dt><a name="Figure-set_contains"><strong>set_contains</strong></a>(self, picker)</dt><dd><tt>Replace the contains test used by this artist. The new picker should<br>
be a callable function which determines whether the artist is hit by the<br>
mouse event:<br>
<br>
hit, props = picker(artist, mouseevent)<br>
<br>
If the mouse event is over the artist, return hit=True and props<br>
is a dictionary of properties you want returned with the contains test.</tt></dd></dl>
<dl><dt><a name="Figure-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the figure instance the artist belong to<br>
<br>
ACCEPTS: a matplotlib.figure.<a href="#Figure">Figure</a> instance</tt></dd></dl>
<dl><dt><a name="Figure-set_label"><strong>set_label</strong></a>(self, s)</dt><dd><tt>Set the line label to s for auto legend<br>
<br>
ACCEPTS: any string</tt></dd></dl>
<dl><dt><a name="Figure-set_lod"><strong>set_lod</strong></a>(self, on)</dt><dd><tt>Set Level of Detail on or off. If on, the artists may examine<br>
things like the pixel width of the axes and draw a subset of<br>
their contents accordingly<br>
<br>
ACCEPTS: [True | False]</tt></dd></dl>
<dl><dt><a name="Figure-set_picker"><strong>set_picker</strong></a>(self, picker)</dt><dd><tt>set the epsilon for picking used by this artist<br>
<br>
picker can be one of the following:<br>
<br>
None - picking is disabled for this artist (default)<br>
<br>
boolean - if True then picking will be enabled and the<br>
artist will fire a pick event if the mouse event is over<br>
the artist<br>
<br>
float - if picker is a number it is interpreted as an<br>
epsilon tolerance in points and the the artist will fire<br>
off an event if it's data is within epsilon of the mouse<br>
event. For some artists like lines and patch collections,<br>
the artist may provide additional data to the pick event<br>
that is generated, eg the indices of the data within<br>
epsilon of the pick event<br>
<br>
function - if picker is callable, it is a user supplied<br>
function which determines whether the artist is hit by the<br>
mouse event.<br>
<br>
hit, props = picker(artist, mouseevent)<br>
<br>
to determine the hit test. if the mouse event is over the<br>
artist, return hit=True and props is a dictionary of<br>
properties you want added to the PickEvent attributes<br>
<br>
ACCEPTS: [None|float|boolean|callable]</tt></dd></dl>
<dl><dt><a name="Figure-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>set the Transformation instance used by this artist<br>
<br>
ACCEPTS: a matplotlib.transform transformation instance</tt></dd></dl>
<dl><dt><a name="Figure-set_visible"><strong>set_visible</strong></a>(self, b)</dt><dd><tt>set the artist's visiblity<br>
<br>
ACCEPTS: [True | False]</tt></dd></dl>
<dl><dt><a name="Figure-set_zorder"><strong>set_zorder</strong></a>(self, level)</dt><dd><tt>Set the zorder for the artist<br>
<br>
ACCEPTS: any number</tt></dd></dl>
<dl><dt><a name="Figure-update"><strong>update</strong></a>(self, props)</dt></dl>
<dl><dt><a name="Figure-update_from"><strong>update_from</strong></a>(self, other)</dt><dd><tt>copy properties from other to self</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>aname</strong> = 'Artist'</dl>
<dl><dt><strong>zorder</strong> = 0</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="SubplotParams">class <strong>SubplotParams</strong></a></font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A class to hold the parameters for a subplot<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="SubplotParams-__init__"><strong>__init__</strong></a>(self, left<font color="#909090">=None</font>, bottom<font color="#909090">=None</font>, right<font color="#909090">=None</font>, top<font color="#909090">=None</font>, wspace<font color="#909090">=None</font>, hspace<font color="#909090">=None</font>)</dt><dd><tt>All dimensions are fraction of the figure width or height.<br>
All values default to their rc params<br>
<br>
The following attributes are available:<br>
<br>
left : the left side of the subplots of the figure<br>
right : the right side of the subplots of the figure<br>
bottom : the bottom of the subplots of the figure<br>
top : the top of the subplots of the figure<br>
wspace : the amount of width reserved for blank space between subplots<br>
hspace : the amount of height reserved for white space between subplots<br>
<br>
validate : make sure the params are in a legal state<br>
(left<right, etc)</tt></dd></dl>
<dl><dt><a name="SubplotParams-update"><strong>update</strong></a>(self, left<font color="#909090">=None</font>, bottom<font color="#909090">=None</font>, right<font color="#909090">=None</font>, top<font color="#909090">=None</font>, wspace<font color="#909090">=None</font>, hspace<font color="#909090">=None</font>)</dt><dd><tt>Update the current values. If any kwarg is None, default to<br>
the current value, if set, otherwise to rc</tt></dd></dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt><a name="-Bbox"><strong>Bbox</strong></a>(...)</dt><dd><tt><a href="#-Bbox">Bbox</a>(ll, ur)</tt></dd></dl>
<dl><dt><a name="-Point"><strong>Point</strong></a>(...)</dt><dd><tt><a href="#-Point">Point</a>(x, y)</tt></dd></dl>
<dl><dt><a name="-Value"><strong>Value</strong></a>(...)</dt><dd><tt><a href="#-Value">Value</a>(x)</tt></dd></dl>
<dl><dt><a name="-figaspect"><strong>figaspect</strong></a>(arg)</dt><dd><tt>Create a figure with specified aspect ratio. If arg is a number,<br>
use that aspect ratio. If arg is an array, figaspect will<br>
determine the width and height for a figure that would fit array<br>
preserving aspect ratio. The figure width, height in inches are<br>
returned. Be sure to create an axes with equal with and height,<br>
eg<br>
<br>
Example usage:<br>
<br>
# make a figure twice as tall as it is wide<br>
w, h = <a href="#-figaspect">figaspect</a>(2.)<br>
fig = <a href="#Figure">Figure</a>(figsize=(w,h))<br>
ax = fig.add_axes([0.1, 0.1, 0.8, 0.8])<br>
ax.imshow(A, **kwargs)<br>
<br>
<br>
# make a figure with the proper aspect for an array<br>
A = rand(5,3)<br>
w, h = <a href="#-figaspect">figaspect</a>(A)<br>
fig = <a href="#Figure">Figure</a>(figsize=(w,h))<br>
ax = fig.add_axes([0.1, 0.1, 0.8, 0.8])<br>
ax.imshow(A, **kwargs)<br>
<br>
Thanks to Fernando Perez for this function</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>rcParams</strong> = {'figure.subplot.right': 0.90000000000000002, 'm...persize': 'letter', 'svg.embed_char_paths': True}</td></tr></table>
@footer@
