Menu
▾
▴
[r8989]: / trunk / htdocs / matplotlib.axes.html.template Maximize Restore History
10230 lines (9776 with data), 1.6 MB
@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>.axes</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/lib64/python2.5/site-packages/matplotlib/axes.py">/home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/axes.py</a></font></td></tr></table>
<p></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.cbook.html">matplotlib.cbook</a><br>
<a href="datetime.html">datetime</a><br>
<a href="matplotlib.font_manager.html">matplotlib.font_manager</a><br>
<a href="numpy.ma.html">numpy.ma</a><br>
<a href="matplotlib.artist.html">matplotlib.artist</a><br>
<a href="math.html">math</a><br>
<a href="matplotlib.html">matplotlib</a><br>
</td><td width="25%" valign=top><a href="matplotlib.axis.html">matplotlib.axis</a><br>
<a href="matplotlib.collections.html">matplotlib.collections</a><br>
<a href="matplotlib.colors.html">matplotlib.colors</a><br>
<a href="matplotlib.contour.html">matplotlib.contour</a><br>
<a href="matplotlib.dates.html">matplotlib.dates</a><br>
<a href="matplotlib.image.html">matplotlib.image</a><br>
<a href="matplotlib.mlab.html">matplotlib.mlab</a><br>
</td><td width="25%" valign=top><a href="matplotlib.legend.html">matplotlib.legend</a><br>
<a href="matplotlib.lines.html">matplotlib.lines</a><br>
<a href="matplotlib.patches.html">matplotlib.patches</a><br>
<a href="matplotlib.quiver.html">matplotlib.quiver</a><br>
<a href="matplotlib.scale.html">matplotlib.scale</a><br>
<a href="matplotlib.table.html">matplotlib.table</a><br>
<a href="matplotlib.text.html">matplotlib.text</a><br>
</td><td width="25%" valign=top><a href="matplotlib.ticker.html">matplotlib.ticker</a><br>
<a href="matplotlib.transforms.html">matplotlib.transforms</a><br>
<a href="new.html">new</a><br>
<a href="numpy.html">numpy</a><br>
<a href="sys.html">sys</a><br>
<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>(<a href="__builtin__.html#object">__builtin__.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.axes.html#Axes">Axes</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="matplotlib.axes.html#SubplotBase">SubplotBase</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial">AxesSubplot(<a href="matplotlib.axes.html#SubplotBase">SubplotBase</a>, <a href="matplotlib.axes.html#Axes">Axes</a>)
</font></dt></dl>
</dd>
</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="Axes">class <strong>Axes</strong></a>(<a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>The :class:`<a href="#Axes">Axes</a>` contains most of the figure elements:<br>
:class:`~matplotlib.axis.Axis`, :class:`~matplotlib.axis.Tick`,<br>
:class:`~matplotlib.lines.Line2D`, :class:`~matplotlib.text.Text`,<br>
:class:`~matplotlib.patches.Polygon`, etc., and sets the<br>
coordinate system.<br>
<br>
The :class:`<a href="#Axes">Axes</a>` instance supports callbacks through a callbacks attribute<br>
which is a :class:`~matplotlib.cbook.CallbackRegistry` instance.<br>
The events you can connect to are :meth:`xlim_changed` and<br>
:meth:`ylim_changed` and the callback will be called with<br>
func(*ax() where *ax* is the :class:`<a href="#Axes">Axes</a>` instance.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.axes.html#Axes">Axes</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Axes-__init__"><strong>__init__</strong></a>(self, fig, rect, axisbg<font color="#909090">=None</font>, frameon<font color="#909090">=True</font>, sharex<font color="#909090">=None</font>, sharey<font color="#909090">=None</font>, label<font color="#909090">=''</font>, **kwargs)</dt></dl>
<dl><dt><a name="Axes-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="Axes-acorr"><strong>acorr</strong></a>(self, x, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-acorr">acorr</a>(x, normed=False, detrend=mlab.detrend_none, usevlines=False,<br>
maxlags=None, **kwargs)<br>
<br>
Plot the autocorrelation of *x*. If *normed* = *True*,<br>
normalize the data but the autocorrelation at 0-th lag. *x* is<br>
detrended by the *detrend* callable (default no normalization).<br>
<br>
Data are plotted as ``<a href="#Axes-plot">plot</a>(lags, c, **kwargs)``<br>
<br>
Return value is a tuple (*lags*, *c*, *line*) where:<br>
<br>
- *lags* are a length 2*maxlags+1 lag vector<br>
<br>
- *c* is the 2*maxlags+1 auto correlation vector<br>
<br>
- *line* is a :class:`~matplotlib.lines.Line2D` instance<br>
returned by :meth:`plot`<br>
<br>
The default *linestyle* is None and the default *marker* is<br>
``'o'``, though these can be overridden with keyword args.<br>
The cross correlation is performed with :func:`numpy.correlate` with<br>
*mode* = 2.<br>
<br>
If *usevlines* is *True*, :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.vlines`<br>
rather than :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.plot` is used to draw<br>
vertical lines from the origin to the acorr. Otherwise, the<br>
plot style is determined by the kwargs, which are<br>
:class:`~matplotlib.lines.Line2D` properties. The return<br>
value is a tuple (*lags*, *c*, *linecol*, *b*) where<br>
<br>
- *linecol* is the<br>
:class:`~matplotlib.collections.LineCollection`<br>
<br>
- *b* is the *x*-axis.<br>
<br>
*maxlags* is a positive integer detailing the number of lags<br>
to show. The default value of *None* will return all<br>
``(2*len(x)-1)`` lags.<br>
<br>
See the respective :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.plot` or<br>
:meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.vlines` functions for<br>
documentation on valid kwargs.<br>
<br>
**Example:**<br>
<br>
:func:`~matplotlib.pyplot.xcorr` above, and<br>
:func:`~matplotlib.pyplot.acorr` below.<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/xcorr_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-add_artist"><strong>add_artist</strong></a>(self, a)</dt><dd><tt>Add any :class:`~matplotlib.artist.<a href="matplotlib.artist.html#Artist">Artist</a>` to the axes</tt></dd></dl>
<dl><dt><a name="Axes-add_collection"><strong>add_collection</strong></a>(self, collection, autolim<font color="#909090">=True</font>)</dt><dd><tt>add a :class:`~matplotlib.collections.Collection` instance<br>
to the axes</tt></dd></dl>
<dl><dt><a name="Axes-add_line"><strong>add_line</strong></a>(self, line)</dt><dd><tt>Add a :class:`~matplotlib.lines.Line2D` to the list of plot<br>
lines</tt></dd></dl>
<dl><dt><a name="Axes-add_patch"><strong>add_patch</strong></a>(self, p)</dt><dd><tt>Add a :class:`~matplotlib.patches.Patch` *p* to the list of<br>
axes patches; the clipbox will be set to the <a href="#Axes">Axes</a> clipping<br>
box. If the transform is not set, it will be set to<br>
:attr:`transData`.</tt></dd></dl>
<dl><dt><a name="Axes-add_table"><strong>add_table</strong></a>(self, tab)</dt><dd><tt>Add a :class:`~matplotlib.tables.Table` instance to the<br>
list of axes tables</tt></dd></dl>
<dl><dt><a name="Axes-annotate"><strong>annotate</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-annotate">annotate</a>(s, xy, xytext=None, xycoords='data',<br>
textcoords='data', arrowprops=None, **kwargs)<br>
<br>
Keyword arguments:<br>
<br>
Annotate the *x*, *y* point *xy* with text *s* at *x*, *y*<br>
location *xytext*. (If *xytext* = *None*, defaults to *xy*,<br>
and if *textcoords* = *None*, defaults to *xycoords*).<br>
<br>
*arrowprops*, if not *None*, is a dictionary of line properties<br>
(see :class:`matplotlib.lines.Line2D`) for the arrow that connects<br>
annotation to the point. Valid keys are<br>
<br>
========= ===========================================================<br>
Key Description<br>
========= ===========================================================<br>
width the width of the arrow in points<br>
frac the fraction of the arrow length occupied by the head<br>
headwidth the width of the base of the arrow head in points<br>
shrink oftentimes it is convenient to have the arrowtip<br>
and base a bit away from the text and point being<br>
annotated. If *d* is the distance between the text and<br>
annotated point, shrink will shorten the arrow so the tip<br>
and base are shink percent of the distance *d* away from the<br>
endpoints. ie, ``shrink=0.05 is 5%``<br>
? any key for :class:`matplotlib.patches.polygon`<br>
========= ===========================================================<br>
<br>
*xycoords* and *textcoords* are strings that indicate the<br>
coordinates of *xy* and *xytext*.<br>
<br>
================= ===================================================<br>
Property Description<br>
================= ===================================================<br>
'figure points' points from the lower left corner of the figure<br>
'figure pixels' pixels from the lower left corner of the figure<br>
'figure fraction' 0,0 is lower left of figure and 1,1 is upper, right<br>
'axes points' points from lower left corner of axes<br>
'axes pixels' pixels from lower left corner of axes<br>
'axes fraction' 0,1 is lower left of axes and 1,1 is upper right<br>
'data' use the coordinate system of the object being<br>
annotated (default)<br>
'offset points' Specify an offset (in points) from the *xy* value<br>
<br>
'polar' you can specify *theta*, *r* for the annotation,<br>
even in cartesian plots. Note that if you<br>
are using a polar axes, you do not need<br>
to specify polar for the coordinate<br>
system since that is the native "data" coordinate<br>
system.<br>
================= ===================================================<br>
<br>
If a 'points' or 'pixels' option is specified, values will be<br>
added to the bottom-left and if negative, values will be<br>
subtracted from the top-right. Eg::<br>
<br>
# 10 points to the right of the left border of the axes and<br>
# 5 points below the top border<br>
xy=(10,-5), xycoords='axes points'<br>
<br>
Additional kwargs are Text properties:<br>
<br>
<br>
========================= =====================================================================<br>
Property Description <br>
========================= =====================================================================<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 :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color any matplotlib color <br>
contains unknown <br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br>
figure a :class:`matplotlib.figure.Figure` 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 unknown <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 <br>
========================= =====================================================================</tt></dd></dl>
<dl><dt><a name="Axes-apply_aspect"><strong>apply_aspect</strong></a>(self, position<font color="#909090">=None</font>)</dt><dd><tt>Use :meth:`_aspect` and :meth:`_adjustable` to modify the<br>
axes box or the view limits.</tt></dd></dl>
<dl><dt><a name="Axes-arrow"><strong>arrow</strong></a>(self, x, y, dx, dy, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-arrow">arrow</a>(x, y, dx, dy, **kwargs)<br>
<br>
Draws arrow on specified axis from (*x*, *y*) to (*x* + *dx*,<br>
*y* + *dy*).<br>
<br>
Optional kwargs control the arrow properties:<br>
<br>
=========== ===========================================================<br>
Property Description <br>
=========== ===========================================================<br>
aa [True | False] or None for default <br>
alpha float <br>
animated [True | False] <br>
antialiased [True | False] or None for default <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
contains unknown <br>
ec mpl color spec, or None for default, or 'none' for no color<br>
edgecolor mpl color spec, or None for default, or 'none' for no color<br>
facecolor mpl color spec, or None for default, or 'none' for no color<br>
fc mpl color spec, or None for default, or 'none' for no color<br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fill [True | False] <br>
hatch unknown <br>
label any string <br>
linestyle ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
linewidth float or None for default <br>
lod [True | False] <br>
ls ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
lw float or None for default <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
=========== ===========================================================<br>
<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/arrow_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-autoscale_view"><strong>autoscale_view</strong></a>(self, tight<font color="#909090">=False</font>, scalex<font color="#909090">=True</font>, scaley<font color="#909090">=True</font>)</dt><dd><tt>autoscale the view limits using the data limits. You can<br>
selectively autoscale only a single axis, eg, the xaxis by<br>
setting *scaley* to *False*. The autoscaling preserves any<br>
axis direction reversal that has already been done.</tt></dd></dl>
<dl><dt><a name="Axes-axhline"><strong>axhline</strong></a>(self, y<font color="#909090">=0</font>, xmin<font color="#909090">=0</font>, xmax<font color="#909090">=1</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-axhline">axhline</a>(y=0, xmin=0, xmax=1, **kwargs)<br>
<br>
Axis Horizontal Line<br>
<br>
Draw a horizontal line at *y* from *xmin* to *xmax*. With the<br>
default values of *xmin* = 0 and *xmax* = 1, this line will<br>
always span the horizontal extent of the axes, regardless of<br>
the xlim settings, even if you change them, eg. with the<br>
:meth:`set_xlim` command. That is, the horizontal extent is<br>
in axes coords: 0=left, 0.5=middle, 1.0=right but the *y*<br>
location is in data coordinates.<br>
<br>
Return value is the :class:`~matplotlib.lines.Line2D`<br>
instance. kwargs are the same as kwargs to plot, and can be<br>
used to control the line properties. Eg.,<br>
<br>
* draw a thick red hline at *y* = 0 that spans the xrange<br>
<br>
>>> <a href="#Axes-axhline">axhline</a>(linewidth=4, color='r')<br>
<br>
* draw a default hline at *y* = 1 that spans the xrange<br>
<br>
>>> <a href="#Axes-axhline">axhline</a>(y=1)<br>
<br>
* draw a default hline at *y* = .5 that spans the the middle half of<br>
the xrange<br>
<br>
>>> <a href="#Axes-axhline">axhline</a>(y=.5, xmin=0.25, xmax=0.75)<br>
<br>
Valid kwargs are :class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
See :meth:`axhspan` for example plot and source code</tt></dd></dl>
<dl><dt><a name="Axes-axhspan"><strong>axhspan</strong></a>(self, ymin, ymax, xmin<font color="#909090">=0</font>, xmax<font color="#909090">=1</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-axhspan">axhspan</a>(ymin, ymax, xmin=0, xmax=1, **kwargs)<br>
<br>
Axis Horizontal Span.<br>
<br>
*y* coords are in data units and *x* coords are in axes (relative<br>
0-1) units.<br>
<br>
Draw a horizontal span (rectangle) from *ymin* to *ymax*.<br>
With the default values of *xmin* = 0 and *xmax* = 1, this<br>
always span the xrange, regardless of the xlim settings, even<br>
if you change them, eg. with the :meth:`set_xlim` command.<br>
That is, the horizontal extent is in axes coords: 0=left,<br>
0.5=middle, 1.0=right but the *y* location is in data<br>
coordinates.<br>
<br>
Return value is a :class:`matplotlib.patches.Polygon`<br>
instance.<br>
<br>
Examples:<br>
<br>
* draw a gray rectangle from *y* = 0.25-0.75 that spans the<br>
horizontal extent of the axes<br>
<br>
>>> <a href="#Axes-axhspan">axhspan</a>(0.25, 0.75, facecolor='0.5', alpha=0.5)<br>
<br>
Valid kwargs are :class:`~matplotlib.patches.Polygon` properties:<br>
<br>
<br>
=========== ===========================================================<br>
Property Description <br>
=========== ===========================================================<br>
aa [True | False] or None for default <br>
alpha float <br>
animated [True | False] <br>
antialiased [True | False] or None for default <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
contains unknown <br>
ec mpl color spec, or None for default, or 'none' for no color<br>
edgecolor mpl color spec, or None for default, or 'none' for no color<br>
facecolor mpl color spec, or None for default, or 'none' for no color<br>
fc mpl color spec, or None for default, or 'none' for no color<br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fill [True | False] <br>
hatch unknown <br>
label any string <br>
linestyle ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
linewidth float or None for default <br>
lod [True | False] <br>
ls ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
lw float or None for default <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
=========== ===========================================================<br>
<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/axhspan_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-axis"><strong>axis</strong></a>(self, *v, **kwargs)</dt><dd><tt>Convenience method for manipulating the x and y view limits<br>
and the aspect ratio of the plot.<br>
<br>
*kwargs* are passed on to :meth:`set_xlim` and<br>
:meth:`set_ylim`</tt></dd></dl>
<dl><dt><a name="Axes-axvline"><strong>axvline</strong></a>(self, x<font color="#909090">=0</font>, ymin<font color="#909090">=0</font>, ymax<font color="#909090">=1</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-axvline">axvline</a>(x=0, ymin=0, ymax=1, **kwargs)<br>
<br>
Axis Vertical Line<br>
<br>
Draw a vertical line at *x* from *ymin* to *ymax*. With the<br>
default values of *ymin* = 0 and *ymax* = 1, this line will<br>
always span the vertical extent of the axes, regardless of the<br>
xlim settings, even if you change them, eg. with the<br>
:meth:`set_xlim` command. That is, the vertical extent is in<br>
axes coords: 0=bottom, 0.5=middle, 1.0=top but the *x* location<br>
is in data coordinates.<br>
<br>
Return value is the :class:`~matplotlib.lines.Line2D`<br>
instance. kwargs are the same as kwargs to plot, and can be<br>
used to control the line properties. Eg.,<br>
<br>
* draw a thick red vline at *x* = 0 that spans the yrange<br>
<br>
>>> <a href="#Axes-axvline">axvline</a>(linewidth=4, color='r')<br>
<br>
* draw a default vline at *x* = 1 that spans the yrange<br>
<br>
>>> <a href="#Axes-axvline">axvline</a>(x=1)<br>
<br>
* draw a default vline at *x* = .5 that spans the the middle half of<br>
the yrange<br>
<br>
>>> <a href="#Axes-axvline">axvline</a>(x=.5, ymin=0.25, ymax=0.75)<br>
<br>
Valid kwargs are :class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
See :meth:`axhspan` for example plot and source code</tt></dd></dl>
<dl><dt><a name="Axes-axvspan"><strong>axvspan</strong></a>(self, xmin, xmax, ymin<font color="#909090">=0</font>, ymax<font color="#909090">=1</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-axvspan">axvspan</a>(xmin, xmax, ymin=0, ymax=1, **kwargs)<br>
<br>
Axis Vertical Span.<br>
<br>
*x* coords are in data units and *y* coords are in axes (relative<br>
0-1) units.<br>
<br>
Draw a vertical span (rectangle) from *xmin* to *xmax*. With<br>
the default values of *ymin* = 0 and *ymax* = 1, this always<br>
span the yrange, regardless of the ylim settings, even if you<br>
change them, eg. with the :meth:`set_ylim` command. That is,<br>
the vertical extent is in axes coords: 0=bottom, 0.5=middle,<br>
1.0=top but the *y* location is in data coordinates.<br>
<br>
Return value is the :class:`matplotlib.patches.Polygon`<br>
instance.<br>
<br>
Examples:<br>
<br>
* draw a vertical green translucent rectangle from x=1.25 to 1.55 that<br>
spans the yrange of the axes<br>
<br>
>>> <a href="#Axes-axvspan">axvspan</a>(1.25, 1.55, facecolor='g', alpha=0.5)<br>
<br>
Valid kwargs are :class:`~matplotlib.patches.Polygon`<br>
properties:<br>
<br>
<br>
=========== ===========================================================<br>
Property Description <br>
=========== ===========================================================<br>
aa [True | False] or None for default <br>
alpha float <br>
animated [True | False] <br>
antialiased [True | False] or None for default <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
contains unknown <br>
ec mpl color spec, or None for default, or 'none' for no color<br>
edgecolor mpl color spec, or None for default, or 'none' for no color<br>
facecolor mpl color spec, or None for default, or 'none' for no color<br>
fc mpl color spec, or None for default, or 'none' for no color<br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fill [True | False] <br>
hatch unknown <br>
label any string <br>
linestyle ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
linewidth float or None for default <br>
lod [True | False] <br>
ls ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
lw float or None for default <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
=========== ===========================================================<br>
<br>
<br>
See :meth:`axhspan` for example plot and source code</tt></dd></dl>
<dl><dt><a name="Axes-bar"><strong>bar</strong></a>(self, left, height, width<font color="#909090">=0.80000000000000004</font>, bottom<font color="#909090">=None</font>, color<font color="#909090">=None</font>, edgecolor<font color="#909090">=None</font>, linewidth<font color="#909090">=None</font>, yerr<font color="#909090">=None</font>, xerr<font color="#909090">=None</font>, ecolor<font color="#909090">=None</font>, capsize<font color="#909090">=3</font>, align<font color="#909090">='edge'</font>, orientation<font color="#909090">='vertical'</font>, log<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-bar">bar</a>(left, height, width=0.8, bottom=0,<br>
color=None, edgecolor=None, linewidth=None,<br>
yerr=None, xerr=None, ecolor=None, capsize=3,<br>
align='edge', orientation='vertical', log=False)<br>
<br>
Make a bar plot with rectangles bounded by:<br>
<br>
*left*, *left* + *width*, *bottom*, *bottom* + *height*<br>
(left, right, bottom and top edges)<br>
<br>
*left*, *height*, *width*, and *bottom* can be either scalars<br>
or sequences<br>
<br>
Return value is a list of<br>
:class:`matplotlib.patches.Rectangle` instances.<br>
<br>
Required arguments:<br>
<br>
======== ===============================================<br>
Argument Description<br>
======== ===============================================<br>
*left* the x coordinates of the left sides of the bars<br>
*height* the heights of the bars<br>
======== ===============================================<br>
<br>
Optional keyword arguments:<br>
<br>
=============== ==========================================<br>
Keyword Description<br>
=============== ==========================================<br>
*width* the widths of the bars<br>
*bottom* the y coordinates of the bottom edges of<br>
the bars<br>
*color* the colors of the bars<br>
*edgecolor* the colors of the bar edges<br>
*linewidth* width of bar edges; None means use default<br>
linewidth; 0 means don't draw edges.<br>
*xerr* if not None, will be used to generate<br>
errorbars on the bar chart<br>
*yerr* if not None, will be used to generate<br>
errorbars on the bar chart<br>
*ecolor* specifies the color of any errorbar<br>
*capsize* (default 3) determines the length in<br>
points of the error bar caps<br>
*align* 'edge' (default) | 'center'<br>
*orientation* 'vertical' | 'horizontal'<br>
*log* [False|True] False (default) leaves the<br>
orientation axis as-is; True sets it to<br>
log scale<br>
=============== ==========================================<br>
<br>
For vertical bars, *align* = 'edge' aligns bars by their left<br>
edges in left, while *align* = 'center' interprets these<br>
values as the *x* coordinates of the bar centers. For<br>
horizontal bars, *align* = 'edge' aligns bars by their bottom<br>
edges in bottom, while *align* = 'center' interprets these<br>
values as the *y* coordinates of the bar centers.<br>
<br>
The optional arguments *color*, *edgecolor*, *linewidth*,<br>
*xerr*, and *yerr* can be either scalars or sequences of<br>
length equal to the number of bars. This enables you to use<br>
bar as the basis for stacked bar charts, or candlestick plots.<br>
<br>
Other optional kwargs:<br>
<br>
<br>
=========== ===========================================================<br>
Property Description <br>
=========== ===========================================================<br>
aa [True | False] or None for default <br>
alpha float <br>
animated [True | False] <br>
antialiased [True | False] or None for default <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
contains unknown <br>
ec mpl color spec, or None for default, or 'none' for no color<br>
edgecolor mpl color spec, or None for default, or 'none' for no color<br>
facecolor mpl color spec, or None for default, or 'none' for no color<br>
fc mpl color spec, or None for default, or 'none' for no color<br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fill [True | False] <br>
hatch unknown <br>
label any string <br>
linestyle ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
linewidth float or None for default <br>
lod [True | False] <br>
ls ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
lw float or None for default <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
=========== ===========================================================<br>
<br>
<br>
**Example:** A stacked bar chart.<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/bar_stacked.py</tt></dd></dl>
<dl><dt><a name="Axes-barbs"><strong>barbs</strong></a>(self, *args, **kw)</dt><dd><tt>Plot a 2-D field of barbs.<br>
<br>
call signatures::<br>
<br>
barb(U, V, **kw)<br>
barb(U, V, C, **kw)<br>
barb(X, Y, U, V, **kw)<br>
barb(X, Y, U, V, C, **kw)<br>
<br>
Arguments:<br>
<br>
*X*, *Y*:<br>
The x and y coordinates of the barb locations<br>
(default is head of barb; see *pivot* kwarg)<br>
<br>
*U*, *V*:<br>
give the *x* and *y* components of the barb shaft<br>
<br>
*C*:<br>
an optional array used to map colors to the barbs<br>
<br>
All arguments may be 1-D or 2-D arrays or sequences. If *X* and *Y*<br>
are absent, they will be generated as a uniform grid. If *U* and *V*<br>
are 2-D arrays but *X* and *Y* are 1-D, and if len(*X*) and len(*Y*)<br>
match the column and row dimensions of *U*, then *X* and *Y* will be<br>
expanded with :func:`numpy.meshgrid`.<br>
<br>
*U*, *V*, *C* may be masked arrays, but masked *X*, *Y* are not<br>
supported at present.<br>
<br>
Keyword arguments:<br>
<br>
*length*:<br>
Length of the barb in points; the other parts of the barb<br>
are scaled against this.<br>
Default is 9<br>
<br>
*pivot*: [ 'tip' | 'middle' ]<br>
The part of the arrow that is at the grid point; the arrow<br>
rotates about this point, hence the name *pivot*.<br>
Default is 'tip'<br>
<br>
*barbcolor*: [ color | color sequence ]<br>
Specifies the color all parts of the barb except any flags.<br>
This parameter is analagous to the *edgecolor* parameter<br>
for polygons, which can be used instead. However this parameter<br>
will override facecolor.<br>
<br>
*flagcolor*: [ color | color sequence ]<br>
Specifies the color of any flags on the barb.<br>
This parameter is analagous to the *facecolor* parameter<br>
for polygons, which can be used instead. However this parameter<br>
will override facecolor. If this is not set (and *C* has not either)<br>
then *flagcolor* will be set to match *barbcolor* so that the barb<br>
has a uniform color. If *C* has been set, *flagcolor* has no effect.<br>
<br>
*sizes*:<br>
A dictionary of coefficients specifying the ratio of a given feature<br>
to the length of the barb. Only those values one wishes to override<br>
need to be included. These features include:<br>
'spacing' - space between features (flags, full/half barbs)<br>
'height' - height (distance from shaft to top) of a flag or full barb<br>
'width' - width of a flag, twice the width of a full barb<br>
'emptybarb' - radius of the circle used for low magnitudes<br>
<br>
*fill_empty*:<br>
A flag on whether the empty barbs (circles) that are drawn should be filled<br>
with the flag color. If they are not filled, they will be drawn such that<br>
no color is applied to the center.<br>
Default is False<br>
<br>
*rounding*:<br>
A flag to indicate whether the vector magnitude should be rounded when<br>
allocating barb components. If True, the magnitude is rounded to the<br>
nearest multiple of the half-barb increment. If False, the magnitude<br>
is simply truncated to the next lowest multiple.<br>
Default is True<br>
<br>
*barb_increments*:<br>
A dictionary of increments specifying values to associate with different<br>
parts of the barb. Only those values one wishes to override need to be<br>
included.<br>
'half' - half barbs (Default is 5)<br>
'full' - full barbs (Default is 10)<br>
'flag' - flags (default is 50)<br>
<br>
*flip_barb*:<br>
Either a single boolean flag or an array of booleans. Single boolean<br>
indicates whether the lines and flags should point opposite to normal<br>
for all barbs. An array (which should be the same size as the other<br>
data arrays) indicates whether to flip for each individual barb.<br>
Normal behavior is for the barbs and lines to point right (comes from<br>
wind barbs having these features point towards low pressure in the<br>
Northern Hemisphere.)<br>
Default is False<br>
<br>
Barbs are traditionally used in meteorology as a way to plot the speed<br>
and direction of wind observations, but can technically be used to plot<br>
any two dimensional vector quantity. As opposed to arrows, which give<br>
vector magnitude by the length of the arrow, the barbs give more quantitative<br>
information about the vector magnitude by putting slanted lines or a triangle<br>
for various increments in magnitude, as show schematically below:<br>
<br>
/\ / \ / \ \ / \ \ ------------------------------<br>
<br>
The largest increment is given by a triangle (or "flag"). After those come full<br>
lines (barbs). The smallest increment is a half line. There is only, of<br>
course, ever at most 1 half line. If the magnitude is small and only needs a<br>
single half-line and no full lines or triangles, the half-line is offset from<br>
the end of the barb so that it can be easily distinguished from barbs with a<br>
single full line. The magnitude for the barb shown above would nominally be<br>
65, using the standard increments of 50, 10, and 5.<br>
<br>
linewidths and edgecolors can be used to customize the barb.<br>
Additional :class:`~matplotlib.collections.PolyCollection`<br>
keyword arguments:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================</tt></dd></dl>
<dl><dt><a name="Axes-barh"><strong>barh</strong></a>(self, bottom, width, height<font color="#909090">=0.80000000000000004</font>, left<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-barh">barh</a>(bottom, width, height=0.8, left=0, **kwargs)<br>
<br>
Make a horizontal bar plot with rectangles bounded by:<br>
<br>
*left*, *left* + *width*, *bottom*, *bottom* + *height*<br>
(left, right, bottom and top edges)<br>
<br>
*bottom*, *width*, *height*, and *left* can be either scalars<br>
or sequences<br>
<br>
Return value is a list of<br>
:class:`matplotlib.patches.Rectangle` instances.<br>
<br>
Required arguments:<br>
<br>
======== ======================================================<br>
Argument Description<br>
======== ======================================================<br>
*bottom* the vertical positions of the bottom edges of the bars<br>
*width* the lengths of the bars<br>
======== ======================================================<br>
<br>
Optional keyword arguments:<br>
<br>
=============== ==========================================<br>
Keyword Description<br>
=============== ==========================================<br>
*height* the heights (thicknesses) of the bars<br>
*left* the x coordinates of the left edges of the<br>
bars<br>
*color* the colors of the bars<br>
*edgecolor* the colors of the bar edges<br>
*linewidth* width of bar edges; None means use default<br>
linewidth; 0 means don't draw edges.<br>
*xerr* if not None, will be used to generate<br>
errorbars on the bar chart<br>
*yerr* if not None, will be used to generate<br>
errorbars on the bar chart<br>
*ecolor* specifies the color of any errorbar<br>
*capsize* (default 3) determines the length in<br>
points of the error bar caps<br>
*align* 'edge' (default) | 'center'<br>
*log* [False|True] False (default) leaves the<br>
horizontal axis as-is; True sets it to log<br>
scale<br>
=============== ==========================================<br>
<br>
Setting *align* = 'edge' aligns bars by their bottom edges in<br>
bottom, while *align* = 'center' interprets these values as<br>
the *y* coordinates of the bar centers.<br>
<br>
The optional arguments *color*, *edgecolor*, *linewidth*,<br>
*xerr*, and *yerr* can be either scalars or sequences of<br>
length equal to the number of bars. This enables you to use<br>
barh as the basis for stacked bar charts, or candlestick<br>
plots.<br>
<br>
other optional kwargs:<br>
<br>
<br>
=========== ===========================================================<br>
Property Description <br>
=========== ===========================================================<br>
aa [True | False] or None for default <br>
alpha float <br>
animated [True | False] <br>
antialiased [True | False] or None for default <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
contains unknown <br>
ec mpl color spec, or None for default, or 'none' for no color<br>
edgecolor mpl color spec, or None for default, or 'none' for no color<br>
facecolor mpl color spec, or None for default, or 'none' for no color<br>
fc mpl color spec, or None for default, or 'none' for no color<br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fill [True | False] <br>
hatch unknown <br>
label any string <br>
linestyle ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
linewidth float or None for default <br>
lod [True | False] <br>
ls ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
lw float or None for default <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
=========== ===========================================================</tt></dd></dl>
<dl><dt><a name="Axes-boxplot"><strong>boxplot</strong></a>(self, x, notch<font color="#909090">=0</font>, sym<font color="#909090">='b+'</font>, vert<font color="#909090">=1</font>, whis<font color="#909090">=1.5</font>, positions<font color="#909090">=None</font>, widths<font color="#909090">=None</font>)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-boxplot">boxplot</a>(x, notch=0, sym='+', vert=1, whis=1.5,<br>
positions=None, widths=None)<br>
<br>
Make a box and whisker plot for each column of *x* or each<br>
vector in sequence *x*. The box extends from the lower to<br>
upper quartile values of the data, with a line at the median.<br>
The whiskers extend from the box to show the range of the<br>
data. Flier points are those past the end of the whiskers.<br>
<br>
- *notch* = 0 (default) produces a rectangular box plot.<br>
- *notch* = 1 will produce a notched box plot<br>
<br>
*sym* (default 'b+') is the default symbol for flier points.<br>
Enter an empty string ('') if you don't want to show fliers.<br>
<br>
- *vert* = 1 (default) makes the boxes vertical.<br>
- *vert* = 0 makes horizontal boxes. This seems goofy, but<br>
that's how Matlab did it.<br>
<br>
*whis* (default 1.5) defines the length of the whiskers as<br>
a function of the inner quartile range. They extend to the<br>
most extreme data point within ( ``whis*(75%-25%)`` ) data range.<br>
<br>
*positions* (default 1,2,...,n) sets the horizontal positions of<br>
the boxes. The ticks and limits are automatically set to match<br>
the positions.<br>
<br>
*widths* is either a scalar or a vector and sets the width of<br>
each box. The default is 0.5, or ``0.15*(distance between extreme<br>
positions)`` if that is smaller.<br>
<br>
*x* is an array or a sequence of vectors.<br>
<br>
Returns a list of the :class:`matplotlib.lines.Line2D`<br>
instances added.<br>
<br>
**Example:**<br>
<br>
.. plot:: boxplot_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-broken_barh"><strong>broken_barh</strong></a>(self, xranges, yrange, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-broken_barh">broken_barh</a>(self, xranges, yrange, **kwargs)<br>
<br>
A collection of horizontal bars spanning *yrange* with a sequence of<br>
*xranges*.<br>
<br>
Required arguments:<br>
<br>
========= ==============================<br>
Argument Description<br>
========= ==============================<br>
*xranges* sequence of (*xmin*, *xwidth*)<br>
*yrange* sequence of (*ymin*, *ywidth*)<br>
========= ==============================<br>
<br>
kwargs are<br>
:class:`matplotlib.collections.BrokenBarHCollection`<br>
properties:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================<br>
<br>
<br>
these can either be a single argument, ie::<br>
<br>
facecolors = 'black'<br>
<br>
or a sequence of arguments for the various bars, ie::<br>
<br>
facecolors = ('black', 'red', 'green')<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/broken_barh.py</tt></dd></dl>
<dl><dt><a name="Axes-can_zoom"><strong>can_zoom</strong></a>(self)</dt><dd><tt>Return *True* if this axes support the zoom box</tt></dd></dl>
<dl><dt><a name="Axes-cla"><strong>cla</strong></a>(self)</dt><dd><tt>Clear the current axes</tt></dd></dl>
<dl><dt><a name="Axes-clabel"><strong>clabel</strong></a>(self, CS, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-clabel">clabel</a>(cs, **kwargs)<br>
<br>
adds labels to line contours in *cs*, where *cs* is a<br>
:class:`~matplotlib.contour.ContourSet` object returned by<br>
contour.<br>
<br>
::<br>
<br>
<a href="#Axes-clabel">clabel</a>(cs, v, **kwargs)<br>
<br>
only labels contours listed in *v*.<br>
<br>
Optional keyword arguments:<br>
<br>
*fontsize*:<br>
See <a href="http://matplotlib.sf.net/fonts.html">http://matplotlib.sf.net/fonts.html</a><br>
<br>
.. TODO: Update this link to new fonts document<br>
<br>
*colors*:<br>
- if *None*, the color of each label matches the color of<br>
the corresponding contour<br>
<br>
- if one string color, e.g. *colors* = 'r' or *colors* =<br>
'red', all labels will be plotted in this color<br>
<br>
- if a tuple of matplotlib color args (string, float, rgb, etc),<br>
different labels will be plotted in different colors in the order<br>
specified<br>
<br>
*inline*:<br>
controls whether the underlying contour is removed or<br>
not. Default is *True*.<br>
<br>
*inline_spacing*:<br>
space in pixels to leave on each side of label when<br>
placing inline. Defaults to 5. This spacing will be<br>
exact for labels at locations where the contour is<br>
straight, less so for labels on curved contours.<br>
<br>
*fmt*:<br>
a format string for the label. Default is '%1.3f'<br>
Alternatively, this can be a dictionary matching contour<br>
levels with arbitrary strings to use for each contour level<br>
(i.e., fmt[level]=string)<br>
<br>
*manual*:<br>
if *True*, contour labels will be placed manually using<br>
mouse clicks. Click the first button near a contour to<br>
add a label, click the second button (or potentially both<br>
mouse buttons at once) to finish adding labels. The third<br>
button can be used to remove the last label added, but<br>
only if labels are not inline.</tt></dd></dl>
<dl><dt><a name="Axes-clear"><strong>clear</strong></a>(self)</dt><dd><tt>clear the axes</tt></dd></dl>
<dl><dt><a name="Axes-cohere"><strong>cohere</strong></a>(self, x, y, NFFT<font color="#909090">=256</font>, Fs<font color="#909090">=2</font>, Fc<font color="#909090">=0</font>, detrend<font color="#909090">=<function detrend_none at 0x26b5ed8></font>, window<font color="#909090">=<function window_hanning at 0x26b5578></font>, noverlap<font color="#909090">=0</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-cohere">cohere</a>(x, y, NFFT=256, Fs=2, Fc=0, detrend = mlab.detrend_none,<br>
window = mlab.window_hanning, noverlap=0, **kwargs)<br>
<br>
cohere the coherence between *x* and *y*. Coherence is the normalized<br>
cross spectral density:<br>
<br>
.. math::<br>
<br>
C_{xy} = \frac{|P_{xy}|^2}{P_{xx}*P_{yy}}<br>
<br>
The return value is a tuple (*Cxy*, *f*), where *f* are the<br>
frequencies of the coherence vector.<br>
<br>
See the :meth:`psd` for a description of the optional parameters.<br>
<br>
kwargs are applied to the lines.<br>
<br>
References:<br>
<br>
* Bendat & Piersol -- Random Data: Analysis and Measurement<br>
Procedures, John Wiley & Sons (1986)<br>
<br>
kwargs control the :class:`~matplotlib.lines.Line2D`<br>
properties of the coherence plot:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/cohere_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-connect"><strong>connect</strong></a>(self, s, func)</dt><dd><tt>Register observers to be notified when certain events occur. Register<br>
with callback functions with the following signatures. The function<br>
has the following signature::<br>
<br>
func(ax) # where ax is the instance making the callback.<br>
<br>
The following events can be connected to:<br>
<br>
'xlim_changed','ylim_changed'<br>
<br>
The connection id is is returned - you can use this with<br>
disconnect to disconnect from the axes event</tt></dd></dl>
<dl><dt><a name="Axes-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occured in the axes.<br>
<br>
Returns T/F, {}</tt></dd></dl>
<dl><dt><a name="Axes-contour"><strong>contour</strong></a>(self, *args, **kwargs)</dt><dd><tt>:func:`~matplotlib.pyplot.contour` and<br>
:func:`~matplotlib.pyplot.contourf` draw contour lines and<br>
filled contours, respectively. Except as noted, function<br>
signatures and return values are the same for both versions.<br>
<br>
:func:`~matplotlib.pyplot.contourf` differs from the Matlab<br>
(TM) version in that it does not draw the polygon edges,<br>
because the contouring engine yields simply connected regions<br>
with branch cuts. To draw the edges, add line contours with<br>
calls to :func:`~matplotlib.pyplot.contour`.<br>
<br>
<br>
call signatures::<br>
<br>
<a href="#Axes-contour">contour</a>(Z)<br>
<br>
make a contour plot of an array *Z*. The level values are chosen<br>
automatically.<br>
<br>
::<br>
<br>
<a href="#Axes-contour">contour</a>(X,Y,Z)<br>
<br>
*X*, *Y* specify the (*x*, *y*) coordinates of the surface<br>
<br>
::<br>
<br>
<a href="#Axes-contour">contour</a>(Z,N)<br>
<a href="#Axes-contour">contour</a>(X,Y,Z,N)<br>
<br>
contour *N* automatically-chosen levels.<br>
<br>
::<br>
<br>
<a href="#Axes-contour">contour</a>(Z,V)<br>
<a href="#Axes-contour">contour</a>(X,Y,Z,V)<br>
<br>
draw contour lines at the values specified in sequence *V*<br>
<br>
::<br>
<br>
<a href="#Axes-contourf">contourf</a>(..., V)<br>
<br>
fill the (len(*V*)-1) regions between the values in *V*<br>
<br>
::<br>
<br>
<a href="#Axes-contour">contour</a>(Z, **kwargs)<br>
<br>
Use keyword args to control colors, linewidth, origin, cmap ... see<br>
below for more details.<br>
<br>
*X*, *Y*, and *Z* must be arrays with the same dimensions.<br>
<br>
*Z* may be a masked array, but filled contouring may not<br>
handle internal masked regions correctly.<br>
<br>
``C = <a href="#Axes-contour">contour</a>(...)`` returns a<br>
:class:`~matplotlib.contour.ContourSet` object.<br>
<br>
Optional keyword arguments:<br>
<br>
*colors*: [ None | string | (mpl_colors) ]<br>
If *None*, the colormap specified by cmap will be used.<br>
<br>
If a string, like 'r' or 'red', all levels will be plotted in this<br>
color.<br>
<br>
If a tuple of matplotlib color args (string, float, rgb, etc),<br>
different levels will be plotted in different colors in the order<br>
specified.<br>
<br>
*alpha*: float<br>
The alpha blending value<br>
<br>
*cmap*: [ None | Colormap ]<br>
A cm :class:`~matplotlib.cm.Colormap` instance or<br>
*None*. If *cmap* is *None* and *colors* is *None*, a<br>
default Colormap is used.<br>
<br>
*norm*: [ None | Normalize ]<br>
A :class:`matplotlib.colors.Normalize` instance for<br>
scaling data values to colors. If *norm* is *None* and<br>
*colors* is *None*, the default linear scaling is used.<br>
<br>
*origin*: [ None | 'upper' | 'lower' | 'image' ]<br>
If *None*, the first value of *Z* will correspond to the<br>
lower left corner, location (0,0). If 'image', the rc<br>
value for ``image.origin`` will be used.<br>
<br>
This keyword is not active if *X* and *Y* are specified in<br>
the call to contour.<br>
<br>
*extent*: [ None | (x0,x1,y0,y1) ]<br>
<br>
If *origin* is not *None*, then *extent* is interpreted as<br>
in :func:`matplotlib.pyplot.imshow`: it gives the outer<br>
pixel boundaries. In this case, the position of Z[0,0]<br>
is the center of the pixel, not a corner. If *origin* is<br>
*None*, then (*x0*, *y0*) is the position of Z[0,0], and<br>
(*x1*, *y1*) is the position of Z[-1,-1].<br>
<br>
This keyword is not active if *X* and *Y* are specified in<br>
the call to contour.<br>
<br>
*locator*: [ None | ticker.Locator subclass ]<br>
If *locator* is None, the default<br>
:class:`~matplotlib.ticker.MaxNLocator` is used. The<br>
locator is used to determine the contour levels if they<br>
are not given explicitly via the *V* argument.<br>
<br>
*extend*: [ 'neither' | 'both' | 'min' | 'max' ]<br>
Unless this is 'neither', contour levels are automatically<br>
added to one or both ends of the range so that all data<br>
are included. These added ranges are then mapped to the<br>
special colormap values which default to the ends of the<br>
colormap range, but can be set via<br>
:meth:`matplotlib.cm.Colormap.set_under` and<br>
:meth:`matplotlib.cm.Colormap.set_over` methods.<br>
<br>
contour-only keyword arguments:<br>
<br>
*linewidths*: [ None | number | tuple of numbers ]<br>
If *linewidths* is *None*, the default width in<br>
``lines.linewidth`` in ``matplotlibrc`` is used<br>
<br>
If a number, all levels will be plotted with this linewidth.<br>
<br>
If a tuple, different levels will be plotted with different<br>
linewidths in the order specified<br>
<br>
contourf-only keyword arguments:<br>
<br>
*antialiased*: [ True | False ]<br>
enable antialiasing<br>
<br>
*nchunk*: [ 0 | integer ]<br>
If 0, no subdivision of the domain. Specify a positive integer to<br>
divide the domain into subdomains of roughly *nchunk* by *nchunk*<br>
points. This may never actually be advantageous, so this option may<br>
be removed. Chunking introduces artifacts at the chunk boundaries<br>
unless *antialiased* is *False*.<br>
<br>
**Example:**<br>
<br>
.. plot:: contour_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-contourf"><strong>contourf</strong></a>(self, *args, **kwargs)</dt><dd><tt>:func:`~matplotlib.pyplot.contour` and<br>
:func:`~matplotlib.pyplot.contourf` draw contour lines and<br>
filled contours, respectively. Except as noted, function<br>
signatures and return values are the same for both versions.<br>
<br>
:func:`~matplotlib.pyplot.contourf` differs from the Matlab<br>
(TM) version in that it does not draw the polygon edges,<br>
because the contouring engine yields simply connected regions<br>
with branch cuts. To draw the edges, add line contours with<br>
calls to :func:`~matplotlib.pyplot.contour`.<br>
<br>
<br>
call signatures::<br>
<br>
<a href="#Axes-contour">contour</a>(Z)<br>
<br>
make a contour plot of an array *Z*. The level values are chosen<br>
automatically.<br>
<br>
::<br>
<br>
<a href="#Axes-contour">contour</a>(X,Y,Z)<br>
<br>
*X*, *Y* specify the (*x*, *y*) coordinates of the surface<br>
<br>
::<br>
<br>
<a href="#Axes-contour">contour</a>(Z,N)<br>
<a href="#Axes-contour">contour</a>(X,Y,Z,N)<br>
<br>
contour *N* automatically-chosen levels.<br>
<br>
::<br>
<br>
<a href="#Axes-contour">contour</a>(Z,V)<br>
<a href="#Axes-contour">contour</a>(X,Y,Z,V)<br>
<br>
draw contour lines at the values specified in sequence *V*<br>
<br>
::<br>
<br>
<a href="#Axes-contourf">contourf</a>(..., V)<br>
<br>
fill the (len(*V*)-1) regions between the values in *V*<br>
<br>
::<br>
<br>
<a href="#Axes-contour">contour</a>(Z, **kwargs)<br>
<br>
Use keyword args to control colors, linewidth, origin, cmap ... see<br>
below for more details.<br>
<br>
*X*, *Y*, and *Z* must be arrays with the same dimensions.<br>
<br>
*Z* may be a masked array, but filled contouring may not<br>
handle internal masked regions correctly.<br>
<br>
``C = <a href="#Axes-contour">contour</a>(...)`` returns a<br>
:class:`~matplotlib.contour.ContourSet` object.<br>
<br>
Optional keyword arguments:<br>
<br>
*colors*: [ None | string | (mpl_colors) ]<br>
If *None*, the colormap specified by cmap will be used.<br>
<br>
If a string, like 'r' or 'red', all levels will be plotted in this<br>
color.<br>
<br>
If a tuple of matplotlib color args (string, float, rgb, etc),<br>
different levels will be plotted in different colors in the order<br>
specified.<br>
<br>
*alpha*: float<br>
The alpha blending value<br>
<br>
*cmap*: [ None | Colormap ]<br>
A cm :class:`~matplotlib.cm.Colormap` instance or<br>
*None*. If *cmap* is *None* and *colors* is *None*, a<br>
default Colormap is used.<br>
<br>
*norm*: [ None | Normalize ]<br>
A :class:`matplotlib.colors.Normalize` instance for<br>
scaling data values to colors. If *norm* is *None* and<br>
*colors* is *None*, the default linear scaling is used.<br>
<br>
*origin*: [ None | 'upper' | 'lower' | 'image' ]<br>
If *None*, the first value of *Z* will correspond to the<br>
lower left corner, location (0,0). If 'image', the rc<br>
value for ``image.origin`` will be used.<br>
<br>
This keyword is not active if *X* and *Y* are specified in<br>
the call to contour.<br>
<br>
*extent*: [ None | (x0,x1,y0,y1) ]<br>
<br>
If *origin* is not *None*, then *extent* is interpreted as<br>
in :func:`matplotlib.pyplot.imshow`: it gives the outer<br>
pixel boundaries. In this case, the position of Z[0,0]<br>
is the center of the pixel, not a corner. If *origin* is<br>
*None*, then (*x0*, *y0*) is the position of Z[0,0], and<br>
(*x1*, *y1*) is the position of Z[-1,-1].<br>
<br>
This keyword is not active if *X* and *Y* are specified in<br>
the call to contour.<br>
<br>
*locator*: [ None | ticker.Locator subclass ]<br>
If *locator* is None, the default<br>
:class:`~matplotlib.ticker.MaxNLocator` is used. The<br>
locator is used to determine the contour levels if they<br>
are not given explicitly via the *V* argument.<br>
<br>
*extend*: [ 'neither' | 'both' | 'min' | 'max' ]<br>
Unless this is 'neither', contour levels are automatically<br>
added to one or both ends of the range so that all data<br>
are included. These added ranges are then mapped to the<br>
special colormap values which default to the ends of the<br>
colormap range, but can be set via<br>
:meth:`matplotlib.cm.Colormap.set_under` and<br>
:meth:`matplotlib.cm.Colormap.set_over` methods.<br>
<br>
contour-only keyword arguments:<br>
<br>
*linewidths*: [ None | number | tuple of numbers ]<br>
If *linewidths* is *None*, the default width in<br>
``lines.linewidth`` in ``matplotlibrc`` is used<br>
<br>
If a number, all levels will be plotted with this linewidth.<br>
<br>
If a tuple, different levels will be plotted with different<br>
linewidths in the order specified<br>
<br>
contourf-only keyword arguments:<br>
<br>
*antialiased*: [ True | False ]<br>
enable antialiasing<br>
<br>
*nchunk*: [ 0 | integer ]<br>
If 0, no subdivision of the domain. Specify a positive integer to<br>
divide the domain into subdomains of roughly *nchunk* by *nchunk*<br>
points. This may never actually be advantageous, so this option may<br>
be removed. Chunking introduces artifacts at the chunk boundaries<br>
unless *antialiased* is *False*.<br>
<br>
**Example:**<br>
<br>
.. plot:: contour_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-csd"><strong>csd</strong></a>(self, x, y, NFFT<font color="#909090">=256</font>, Fs<font color="#909090">=2</font>, Fc<font color="#909090">=0</font>, detrend<font color="#909090">=<function detrend_none at 0x26b5ed8></font>, window<font color="#909090">=<function window_hanning at 0x26b5578></font>, noverlap<font color="#909090">=0</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-csd">csd</a>(x, y, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,<br>
window=window_hanning, noverlap=0, **kwargs)<br>
<br>
The cross spectral density :math:`P_{xy}` by Welches average<br>
periodogram method. The vectors *x* and *y* are divided into<br>
*NFFT* length segments. Each segment is detrended by function<br>
*detrend* and windowed by function *window*. The product of<br>
the direct FFTs of *x* and *y* are averaged over each segment<br>
to compute :math:`P_{xy}`, with a scaling to correct for power<br>
loss due to windowing.<br>
<br>
See :meth:`psd` for a description of the optional parameters.<br>
<br>
Returns the tuple (*Pxy*, *freqs*). *P* is the cross spectrum<br>
(complex valued), and :math:`10\log_{10}|P_{xy}|` is<br>
plotted.<br>
<br>
References:<br>
Bendat & Piersol -- Random Data: Analysis and Measurement<br>
Procedures, John Wiley & Sons (1986)<br>
<br>
kwargs control the Line2D properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/csd_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-disconnect"><strong>disconnect</strong></a>(self, cid)</dt><dd><tt>disconnect from the <a href="#Axes">Axes</a> event.</tt></dd></dl>
<dl><dt><a name="Axes-drag_pan"><strong>drag_pan</strong></a>(self, button, key, x, y)</dt><dd><tt>Called when the mouse moves during a pan operation.<br>
<br>
*button* is the mouse button number:<br>
<br>
* 1: LEFT<br>
* 2: MIDDLE<br>
* 3: RIGHT<br>
<br>
*key* is a "shift" key<br>
<br>
*x*, *y* are the mouse coordinates in display coords.<br>
<br>
.. note::<br>
Intended to be overridden by new projection types.</tt></dd></dl>
<dl><dt><a name="Axes-draw"><strong>draw</strong></a>(self, renderer<font color="#909090">=None</font>, inframe<font color="#909090">=False</font>)</dt><dd><tt>Draw everything (plot lines, axes, labels)</tt></dd></dl>
<dl><dt><a name="Axes-draw_artist"><strong>draw_artist</strong></a>(self, a)</dt><dd><tt>This method can only be used after an initial draw which<br>
caches the renderer. It is used to efficiently update <a href="#Axes">Axes</a><br>
data (axis ticks, labels, etc are not updated)</tt></dd></dl>
<dl><dt><a name="Axes-end_pan"><strong>end_pan</strong></a>(self)</dt><dd><tt>Called when a pan operation completes (when the mouse button<br>
is up.)<br>
<br>
.. note::<br>
Intended to be overridden by new projection types.</tt></dd></dl>
<dl><dt><a name="Axes-errorbar"><strong>errorbar</strong></a>(self, x, y, yerr<font color="#909090">=None</font>, xerr<font color="#909090">=None</font>, fmt<font color="#909090">='-'</font>, ecolor<font color="#909090">=None</font>, elinewidth<font color="#909090">=None</font>, capsize<font color="#909090">=3</font>, barsabove<font color="#909090">=False</font>, lolims<font color="#909090">=False</font>, uplims<font color="#909090">=False</font>, xlolims<font color="#909090">=False</font>, xuplims<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-errorbar">errorbar</a>(x, y, yerr=None, xerr=None,<br>
fmt='-', ecolor=None, elinewidth=None, capsize=3,<br>
barsabove=False, lolims=False, uplims=False,<br>
xlolims=False, xuplims=False)<br>
<br>
Plot *x* versus *y* with error deltas in *yerr* and *xerr*.<br>
Vertical errorbars are plotted if *yerr* is not *None*.<br>
Horizontal errorbars are plotted if *xerr* is not *None*.<br>
<br>
*x*, *y*, *xerr*, and *yerr* can all be scalars, which plots a<br>
single error bar at *x*, *y*.<br>
<br>
Optional keyword arguments:<br>
<br>
*xerr*/*yerr*: [ scalar | N, Nx1, Nx2 array-like ]<br>
If a scalar number, len(N) array-like object, or an Nx1 array-like<br>
object, errorbars are drawn +/- value.<br>
<br>
If a rank-1, Nx2 Numpy array, errorbars are drawn at -column1 and<br>
+column2<br>
<br>
*fmt*: '-'<br>
The plot format symbol for *y*. If *fmt* is *None*, just plot the<br>
errorbars with no line symbols. This can be useful for creating a<br>
bar plot with errorbars.<br>
<br>
*ecolor*: [ None | mpl color ]<br>
a matplotlib color arg which gives the color the errorbar lines; if<br>
*None*, use the marker color.<br>
<br>
*elinewidth*: scalar<br>
the linewidth of the errorbar lines. If *None*, use the linewidth.<br>
<br>
*capsize*: scalar<br>
the size of the error bar caps in points<br>
<br>
*barsabove*: [ True | False ]<br>
if *True*, will plot the errorbars above the plot<br>
symbols. Default is below.<br>
<br>
*lolims*/*uplims*/*xlolims*/*xuplims*: [ False | True ]<br>
These arguments can be used to indicate that a value gives<br>
only upper/lower limits. In that case a caret symbol is<br>
used to indicate this. lims-arguments may be of the same<br>
type as *xerr* and *yerr*.<br>
<br>
All other keyword arguments are passed on to the plot command for the<br>
markers, so you can add additional key=value pairs to control the<br>
errorbar markers. For example, this code makes big red squares with<br>
thick green edges::<br>
<br>
x,y,yerr = rand(3,10)<br>
<a href="#Axes-errorbar">errorbar</a>(x, y, yerr, marker='s',<br>
mfc='red', mec='green', ms=20, mew=4)<br>
<br>
where *mfc*, *mec*, *ms* and *mew* are aliases for the longer<br>
property names, *markerfacecolor*, *markeredgecolor*, *markersize*<br>
and *markeredgewith*.<br>
<br>
valid kwargs for the marker properties are<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
Return value is a length 3 tuple. The first element is the<br>
:class:`~matplotlib.lines.Line2D` instance for the *y* symbol<br>
lines. The second element is a list of error bar cap lines,<br>
the third element is a list of<br>
:class:`~matplotlib.collections.LineCollection` instances for<br>
the horizontal and vertical error ranges.<br>
<br>
**Example:**<br>
<br>
.. plot:: errorbar_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-fill"><strong>fill</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-fill">fill</a>(*args, **kwargs)<br>
<br>
Plot filled polygons. *args* is a variable length argument,<br>
allowing for multiple *x*, *y* pairs with an optional color<br>
format string; see :func:`~matplotlib.pyplot.plot` for details<br>
on the argument parsing. For example, to plot a polygon with<br>
vertices at *x*, *y* in blue.::<br>
<br>
ax.<a href="#Axes-fill">fill</a>(x,y, 'b' )<br>
<br>
An arbitrary number of *x*, *y*, *color* groups can be specified::<br>
<br>
ax.<a href="#Axes-fill">fill</a>(x1, y1, 'g', x2, y2, 'r')<br>
<br>
Return value is a list of :class:`~matplotlib.patches.Patch`<br>
instances that were added.<br>
<br>
The same color strings that :func:`~matplotlib.pyplot.plot`<br>
supports are supported by the fill format string.<br>
<br>
If you would like to fill below a curve, eg. shade a region<br>
between 0 and *y* along *x*, use<br>
:func:`~matplotlib.pylab.poly_between`, eg.::<br>
<br>
xs, ys = poly_between(x, 0, y)<br>
axes.<a href="#Axes-fill">fill</a>(xs, ys, facecolor='red', alpha=0.5)<br>
<br>
See :file:`examples/pylab_examples/fill_between.py` for more examples.<br>
<br>
The *closed* kwarg will close the polygon when *True* (default).<br>
<br>
kwargs control the Polygon properties:<br>
<br>
<br>
=========== ===========================================================<br>
Property Description <br>
=========== ===========================================================<br>
aa [True | False] or None for default <br>
alpha float <br>
animated [True | False] <br>
antialiased [True | False] or None for default <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
contains unknown <br>
ec mpl color spec, or None for default, or 'none' for no color<br>
edgecolor mpl color spec, or None for default, or 'none' for no color<br>
facecolor mpl color spec, or None for default, or 'none' for no color<br>
fc mpl color spec, or None for default, or 'none' for no color<br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fill [True | False] <br>
hatch unknown <br>
label any string <br>
linestyle ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
linewidth float or None for default <br>
lod [True | False] <br>
ls ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
lw float or None for default <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
=========== ===========================================================<br>
<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/fill_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-format_coord"><strong>format_coord</strong></a>(self, x, y)</dt><dd><tt>return a format string formatting the *x*, *y* coord</tt></dd></dl>
<dl><dt><a name="Axes-format_xdata"><strong>format_xdata</strong></a>(self, x)</dt><dd><tt>Return *x* string formatted. This function will use the attribute<br>
self.<strong>fmt_xdata</strong> if it is callable, else will fall back on the xaxis<br>
major formatter</tt></dd></dl>
<dl><dt><a name="Axes-format_ydata"><strong>format_ydata</strong></a>(self, y)</dt><dd><tt>Return y string formatted. This function will use the<br>
:attr:`fmt_ydata` attribute if it is callable, else will fall<br>
back on the yaxis major formatter</tt></dd></dl>
<dl><dt><a name="Axes-get_adjustable"><strong>get_adjustable</strong></a>(self)</dt></dl>
<dl><dt><a name="Axes-get_anchor"><strong>get_anchor</strong></a>(self)</dt></dl>
<dl><dt><a name="Axes-get_aspect"><strong>get_aspect</strong></a>(self)</dt></dl>
<dl><dt><a name="Axes-get_autoscale_on"><strong>get_autoscale_on</strong></a>(self)</dt><dd><tt>Get whether autoscaling is applied on plot commands</tt></dd></dl>
<dl><dt><a name="Axes-get_axis_bgcolor"><strong>get_axis_bgcolor</strong></a>(self)</dt><dd><tt>Return the axis background color</tt></dd></dl>
<dl><dt><a name="Axes-get_axisbelow"><strong>get_axisbelow</strong></a>(self)</dt><dd><tt>Get whether axis below is true or not</tt></dd></dl>
<dl><dt><a name="Axes-get_child_artists"><strong>get_child_artists</strong></a>(self)</dt><dd><tt>Return a list of artists the axes contains.<br>
<br>
.. deprecated:: 0.98</tt></dd></dl>
<dl><dt><a name="Axes-get_children"><strong>get_children</strong></a>(self)</dt><dd><tt>return a list of child artists</tt></dd></dl>
<dl><dt><a name="Axes-get_cursor_props"><strong>get_cursor_props</strong></a>(self)</dt><dd><tt>return the cursor propertiess as a (*linewidth*, *color*)<br>
tuple, where *linewidth* is a float and *color* is an RGBA<br>
tuple</tt></dd></dl>
<dl><dt><a name="Axes-get_data_ratio"><strong>get_data_ratio</strong></a>(self)</dt><dd><tt>Returns the aspect ratio of the raw data.<br>
<br>
This method is intended to be overridden by new projection<br>
types.</tt></dd></dl>
<dl><dt><a name="Axes-get_frame"><strong>get_frame</strong></a>(self)</dt><dd><tt>Return the axes Rectangle frame</tt></dd></dl>
<dl><dt><a name="Axes-get_frame_on"><strong>get_frame_on</strong></a>(self)</dt><dd><tt>Get whether the axes rectangle patch is drawn</tt></dd></dl>
<dl><dt><a name="Axes-get_images"><strong>get_images</strong></a>(self)</dt><dd><tt>return a list of <a href="#Axes">Axes</a> images contained by the <a href="#Axes">Axes</a></tt></dd></dl>
<dl><dt><a name="Axes-get_legend"><strong>get_legend</strong></a>(self)</dt><dd><tt>Return the legend.Legend instance, or None if no legend is defined</tt></dd></dl>
<dl><dt><a name="Axes-get_lines"><strong>get_lines</strong></a>(self)</dt><dd><tt>Return a list of lines contained by the <a href="#Axes">Axes</a></tt></dd></dl>
<dl><dt><a name="Axes-get_navigate"><strong>get_navigate</strong></a>(self)</dt><dd><tt>Get whether the axes responds to navigation commands</tt></dd></dl>
<dl><dt><a name="Axes-get_navigate_mode"><strong>get_navigate_mode</strong></a>(self)</dt><dd><tt>Get the navigation toolbar button status: 'PAN', 'ZOOM', or None</tt></dd></dl>
<dl><dt><a name="Axes-get_position"><strong>get_position</strong></a>(self, original<font color="#909090">=False</font>)</dt><dd><tt>Return the a copy of the axes rectangle as a Bbox</tt></dd></dl>
<dl><dt><a name="Axes-get_renderer_cache"><strong>get_renderer_cache</strong></a>(self)</dt></dl>
<dl><dt><a name="Axes-get_shared_x_axes"><strong>get_shared_x_axes</strong></a>(self)</dt><dd><tt>Return a copy of the shared axes Grouper object for x axes</tt></dd></dl>
<dl><dt><a name="Axes-get_shared_y_axes"><strong>get_shared_y_axes</strong></a>(self)</dt><dd><tt>Return a copy of the shared axes Grouper object for y axes</tt></dd></dl>
<dl><dt><a name="Axes-get_title"><strong>get_title</strong></a>(self)</dt><dd><tt>Get the title text string.</tt></dd></dl>
<dl><dt><a name="Axes-get_window_extent"><strong>get_window_extent</strong></a>(self, *args, **kwargs)</dt><dd><tt>get the axes bounding box in display space; *args* and<br>
*kwargs* are empty</tt></dd></dl>
<dl><dt><a name="Axes-get_xaxis"><strong>get_xaxis</strong></a>(self)</dt><dd><tt>Return the XAxis instance</tt></dd></dl>
<dl><dt><a name="Axes-get_xaxis_text1_transform"><strong>get_xaxis_text1_transform</strong></a>(self, pad_points)</dt><dd><tt>Get the transformation used for drawing x-axis labels, which<br>
will add the given amount of padding (in points) between the<br>
axes and the label. The x-direction is in data coordinates<br>
and the y-direction is in axis coordinates. Returns a<br>
3-tuple of the form::<br>
<br>
(transform, valign, halign)<br>
<br>
where *valign* and *halign* are requested alignments for the<br>
text.<br>
<br>
.. note::<br>
This transformation is primarily used by the<br>
:class:`~matplotlib.axis.Axis` class, and is meant to be<br>
overridden by new kinds of projections that may need to<br>
place axis elements in different locations.</tt></dd></dl>
<dl><dt><a name="Axes-get_xaxis_text2_transform"><strong>get_xaxis_text2_transform</strong></a>(self, pad_points)</dt><dd><tt>Get the transformation used for drawing the secondary x-axis<br>
labels, which will add the given amount of padding (in points)<br>
between the axes and the label. The x-direction is in data<br>
coordinates and the y-direction is in axis coordinates.<br>
Returns a 3-tuple of the form::<br>
<br>
(transform, valign, halign)<br>
<br>
where *valign* and *halign* are requested alignments for the<br>
text.<br>
<br>
.. note::<br>
This transformation is primarily used by the<br>
:class:`~matplotlib.axis.Axis` class, and is meant to be<br>
overridden by new kinds of projections that may need to<br>
place axis elements in different locations.</tt></dd></dl>
<dl><dt><a name="Axes-get_xaxis_transform"><strong>get_xaxis_transform</strong></a>(self)</dt><dd><tt>Get the transformation used for drawing x-axis labels, ticks<br>
and gridlines. The x-direction is in data coordinates and the<br>
y-direction is in axis coordinates.<br>
<br>
.. note::<br>
This transformation is primarily used by the<br>
:class:`~matplotlib.axis.Axis` class, and is meant to be<br>
overridden by new kinds of projections that may need to<br>
place axis elements in different locations.</tt></dd></dl>
<dl><dt><a name="Axes-get_xbound"><strong>get_xbound</strong></a>(self)</dt><dd><tt>Returns the x-axis numerical bounds where::<br>
<br>
lowerBound < upperBound</tt></dd></dl>
<dl><dt><a name="Axes-get_xgridlines"><strong>get_xgridlines</strong></a>(self)</dt><dd><tt>Get the x grid lines as a list of Line2D instances</tt></dd></dl>
<dl><dt><a name="Axes-get_xlabel"><strong>get_xlabel</strong></a>(self)</dt><dd><tt>Get the xlabel text string.</tt></dd></dl>
<dl><dt><a name="Axes-get_xlim"><strong>get_xlim</strong></a>(self)</dt><dd><tt>Get the x-axis range [*xmin*, *xmax*]</tt></dd></dl>
<dl><dt><a name="Axes-get_xmajorticklabels"><strong>get_xmajorticklabels</strong></a>(self)</dt><dd><tt>Get the xtick labels as a list of Text instances</tt></dd></dl>
<dl><dt><a name="Axes-get_xminorticklabels"><strong>get_xminorticklabels</strong></a>(self)</dt><dd><tt>Get the xtick labels as a list of Text instances</tt></dd></dl>
<dl><dt><a name="Axes-get_xscale"><strong>get_xscale</strong></a>(self)</dt></dl>
<dl><dt><a name="Axes-get_xticklabels"><strong>get_xticklabels</strong></a>(self, minor<font color="#909090">=False</font>)</dt><dd><tt>Get the xtick labels as a list of Text instances</tt></dd></dl>
<dl><dt><a name="Axes-get_xticklines"><strong>get_xticklines</strong></a>(self)</dt><dd><tt>Get the xtick lines as a list of Line2D instances</tt></dd></dl>
<dl><dt><a name="Axes-get_xticks"><strong>get_xticks</strong></a>(self, minor<font color="#909090">=False</font>)</dt><dd><tt>Return the x ticks as a list of locations</tt></dd></dl>
<dl><dt><a name="Axes-get_yaxis"><strong>get_yaxis</strong></a>(self)</dt><dd><tt>Return the YAxis instance</tt></dd></dl>
<dl><dt><a name="Axes-get_yaxis_text1_transform"><strong>get_yaxis_text1_transform</strong></a>(self, pad_points)</dt><dd><tt>Get the transformation used for drawing y-axis labels, which<br>
will add the given amount of padding (in points) between the<br>
axes and the label. The x-direction is in axis coordinates<br>
and the y-direction is in data coordinates. Returns a 3-tuple<br>
of the form::<br>
<br>
(transform, valign, halign)<br>
<br>
where *valign* and *halign* are requested alignments for the<br>
text.<br>
<br>
.. note::<br>
This transformation is primarily used by the<br>
:class:`~matplotlib.axis.Axis` class, and is meant to be<br>
overridden by new kinds of projections that may need to<br>
place axis elements in different locations.</tt></dd></dl>
<dl><dt><a name="Axes-get_yaxis_text2_transform"><strong>get_yaxis_text2_transform</strong></a>(self, pad_points)</dt><dd><tt>Get the transformation used for drawing the secondary y-axis<br>
labels, which will add the given amount of padding (in points)<br>
between the axes and the label. The x-direction is in axis<br>
coordinates and the y-direction is in data coordinates.<br>
Returns a 3-tuple of the form::<br>
<br>
(transform, valign, halign)<br>
<br>
where *valign* and *halign* are requested alignments for the<br>
text.<br>
<br>
.. note::<br>
<br>
This transformation is primarily used by the<br>
:class:`~matplotlib.axis.Axis` class, and is meant to be<br>
overridden by new kinds of projections that may need to<br>
place axis elements in different locations.</tt></dd></dl>
<dl><dt><a name="Axes-get_yaxis_transform"><strong>get_yaxis_transform</strong></a>(self)</dt><dd><tt>Get the transformation used for drawing y-axis labels, ticks<br>
and gridlines. The x-direction is in axis coordinates and the<br>
y-direction is in data coordinates.<br>
<br>
.. note::<br>
This transformation is primarily used by the<br>
:class:`~matplotlib.axis.Axis` class, and is meant to be<br>
overridden by new kinds of projections that may need to<br>
place axis elements in different locations.</tt></dd></dl>
<dl><dt><a name="Axes-get_ybound"><strong>get_ybound</strong></a>(self)</dt><dd><tt>Returns the y-axis numerical bounds in the form of lowerBound < upperBound</tt></dd></dl>
<dl><dt><a name="Axes-get_ygridlines"><strong>get_ygridlines</strong></a>(self)</dt><dd><tt>Get the y grid lines as a list of Line2D instances</tt></dd></dl>
<dl><dt><a name="Axes-get_ylabel"><strong>get_ylabel</strong></a>(self)</dt><dd><tt>Get the ylabel text string.</tt></dd></dl>
<dl><dt><a name="Axes-get_ylim"><strong>get_ylim</strong></a>(self)</dt><dd><tt>Get the y-axis range [*ymin*, *ymax*]</tt></dd></dl>
<dl><dt><a name="Axes-get_ymajorticklabels"><strong>get_ymajorticklabels</strong></a>(self)</dt><dd><tt>Get the xtick labels as a list of Text instances</tt></dd></dl>
<dl><dt><a name="Axes-get_yminorticklabels"><strong>get_yminorticklabels</strong></a>(self)</dt><dd><tt>Get the xtick labels as a list of Text instances</tt></dd></dl>
<dl><dt><a name="Axes-get_yscale"><strong>get_yscale</strong></a>(self)</dt></dl>
<dl><dt><a name="Axes-get_yticklabels"><strong>get_yticklabels</strong></a>(self, minor<font color="#909090">=False</font>)</dt><dd><tt>Get the xtick labels as a list of Text instances</tt></dd></dl>
<dl><dt><a name="Axes-get_yticklines"><strong>get_yticklines</strong></a>(self)</dt><dd><tt>Get the ytick lines as a list of Line2D instances</tt></dd></dl>
<dl><dt><a name="Axes-get_yticks"><strong>get_yticks</strong></a>(self, minor<font color="#909090">=False</font>)</dt><dd><tt>Return the y ticks as a list of locations</tt></dd></dl>
<dl><dt><a name="Axes-grid"><strong>grid</strong></a>(self, b<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-grid">grid</a>(self, b=None, **kwargs)<br>
<br>
Set the axes grids on or off; *b* is a boolean<br>
<br>
If *b* is *None* and ``len(kwargs)==0``, toggle the grid state. If<br>
*kwargs* are supplied, it is assumed that you want a grid and *b*<br>
is thus set to *True*<br>
<br>
*kawrgs* are used to set the grid line properties, eg::<br>
<br>
ax.<a href="#Axes-grid">grid</a>(color='r', linestyle='-', linewidth=2)<br>
<br>
Valid :class:`~matplotlib.lines.Line2D` kwargs are<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================</tt></dd></dl>
<dl><dt><a name="Axes-has_data"><strong>has_data</strong></a>(self)</dt><dd><tt>Return *True* if any artists have been added to axes.<br>
<br>
This should not be used to determine whether the *dataLim*<br>
need to be updated, and may not actually be useful for<br>
anything.</tt></dd></dl>
<dl><dt><a name="Axes-hexbin"><strong>hexbin</strong></a>(self, x, y, C<font color="#909090">=None</font>, gridsize<font color="#909090">=100</font>, bins<font color="#909090">=None</font>, xscale<font color="#909090">='linear'</font>, yscale<font color="#909090">='linear'</font>, cmap<font color="#909090">=None</font>, norm<font color="#909090">=None</font>, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>, alpha<font color="#909090">=1.0</font>, linewidths<font color="#909090">=None</font>, edgecolors<font color="#909090">='none'</font>, reduce_C_function<font color="#909090">=<function mean at 0x1eebaa0></font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-hexbin">hexbin</a>(x, y, C = None, gridsize = 100, bins = None,<br>
xscale = 'linear', yscale = 'linear',<br>
cmap=None, norm=None, vmin=None, vmax=None,<br>
alpha=1.0, linewidths=None, edgecolors='none'<br>
reduce_C_function = np.mean,<br>
**kwargs)<br>
<br>
Make a hexagonal binning plot of *x* versus *y*, where *x*,<br>
*y* are 1-D sequences of the same length, *N*. If *C* is None<br>
(the default), this is a histogram of the number of occurences<br>
of the observations at (x[i],y[i]).<br>
<br>
If *C* is specified, it specifies values at the coordinate<br>
(x[i],y[i]). These values are accumulated for each hexagonal<br>
bin and then reduced according to *reduce_C_function*, which<br>
defaults to numpy's mean function (np.mean). (If *C* is<br>
specified, it must also be a 1-D sequence of the same length<br>
as *x* and *y*.)<br>
<br>
*x*, *y* and/or *C* may be masked arrays, in which case only<br>
unmasked points will be plotted.<br>
<br>
Optional keyword arguments:<br>
<br>
*gridsize*: [ 100 | integer ]<br>
The number of hexagons in the *x*-direction, default is<br>
100. The corresponding number of hexagons in the<br>
*y*-direction is chosen such that the hexagons are<br>
approximately regular. Alternatively, gridsize can be a<br>
tuple with two elements specifying the number of hexagons<br>
in the *x*-direction and the *y*-direction.<br>
<br>
*bins*: [ None | 'log' | integer | sequence ]<br>
If *None*, no binning is applied; the color of each hexagon<br>
directly corresponds to its count value.<br>
<br>
If 'log', use a logarithmic scale for the color<br>
map. Internally, :math:`log_{10}(i+1)` is used to<br>
determine the hexagon color.<br>
<br>
If an integer, divide the counts in the specified number<br>
of bins, and color the hexagons accordingly.<br>
<br>
If a sequence of values, the values of the lower bound of<br>
the bins to be used.<br>
<br>
*xscale*: [ 'linear' | 'log' ]<br>
Use a linear or log10 scale on the horizontal axis.<br>
<br>
*scale*: [ 'linear' | 'log' ]<br>
Use a linear or log10 scale on the vertical axis.<br>
<br>
Other keyword arguments controlling color mapping and normalization<br>
arguments:<br>
<br>
*cmap*: [ None | Colormap ]<br>
a :class:`matplotlib.cm.Colormap` instance. If *None*,<br>
defaults to rc ``image.cmap``.<br>
<br>
*norm*: [ None | Normalize ]<br>
:class:`matplotlib.colors.Normalize` instance is used to<br>
scale luminance data to 0,1.<br>
<br>
*vmin*/*vmax*: scalar<br>
*vmin* and *vmax* are used in conjunction with *norm* to normalize<br>
luminance data. If either are *None*, the min and max of the color<br>
array *C* is used. Note if you pass a norm instance, your settings<br>
for *vmin* and *vmax* will be ignored.<br>
<br>
*alpha*: scalar<br>
the alpha value for the patches<br>
<br>
*linewidths*: [ None | scalar ]<br>
If *None*, defaults to rc lines.linewidth. Note that this<br>
is a tuple, and if you set the linewidths argument you<br>
must set it as a sequence of floats, as required by<br>
:class:`~matplotlib.collections.RegularPolyCollection`.<br>
<br>
Other keyword arguments controlling the Collection properties:<br>
<br>
*edgecolors*: [ None | mpl color | color sequence ]<br>
If 'none', draws the edges in the same color as the fill color.<br>
This is the default, as it avoids unsightly unpainted pixels<br>
between the hexagons.<br>
<br>
If *None*, draws the outlines in the default color.<br>
<br>
If a matplotlib color arg or sequence of rgba tuples, draws the<br>
outlines in the specified color.<br>
<br>
Here are the standard descriptions of all the<br>
:class:`~matplotlib.collections.Collection` kwargs:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================<br>
<br>
<br>
The return value is a<br>
:class:`~matplotlib.collections.PolyCollection` instance; use<br>
:meth:`~matplotlib.collection.PolyCollection.get_array` on<br>
this :class:`~matplotlib.collections.PolyCollection` to get<br>
the counts in each hexagon.<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/hexbin_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-hist"><strong>hist</strong></a>(self, x, bins<font color="#909090">=10</font>, range<font color="#909090">=None</font>, normed<font color="#909090">=False</font>, cumulative<font color="#909090">=False</font>, bottom<font color="#909090">=None</font>, histtype<font color="#909090">='bar'</font>, align<font color="#909090">='mid'</font>, orientation<font color="#909090">='vertical'</font>, rwidth<font color="#909090">=None</font>, log<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-hist">hist</a>(x, bins=10, range=None, normed=False, cumulative=False,<br>
bottom=None, histtype='bar', align='mid',<br>
orientation='vertical', rwidth=None, log=False, **kwargs)<br>
<br>
Compute the histogram of *x*. The return value is a tuple<br>
(*n*, *bins*, *patches*) or ([*n0*, *n1*, ...], *bins*,<br>
[*patches0*, *patches1*,...]) if the input contains multiple<br>
data.<br>
<br>
Keyword arguments:<br>
<br>
*bins*:<br>
either an integer number of bins or a sequence giving the<br>
bins. *x* are the data to be binned. *x* can be an array or a<br>
2D array with multiple data in its columns. Note, if *bins*<br>
is an integer input argument=numbins, *bins* + 1 bin edges<br>
will be returned, compatible with the semantics of<br>
:func:`numpy.histogram` with the *new* = True argument.<br>
Unequally spaced bins are supported if *bins* is a sequence.<br>
<br>
*range*:<br>
The lower and upper range of the bins. Lower and upper outliers<br>
are ignored. If not provided, *range* is (x.min(), x.max()).<br>
Range has no effect if *bins* is a sequence.<br>
<br>
*normed*:<br>
If *True*, the first element of the return tuple will<br>
be the counts normalized to form a probability density, i.e.,<br>
``n/(len(x)*dbin)``. In a probability density, the integral of<br>
the histogram should be 1; you can verify that with a<br>
trapezoidal integration of the probability density function::<br>
<br>
pdf, bins, patches = ax.<a href="#Axes-hist">hist</a>(...)<br>
print np.sum(pdf * np.diff(bins))<br>
<br>
*cumulative*:<br>
If *True*, then a histogram is computed where each bin<br>
gives the counts in that bin plus all bins for smaller values.<br>
The last bin gives the total number of datapoints. If *normed*<br>
is also *True* then the histogram is normalized such that the<br>
last bin equals one. If *cumulative* evaluates to less than 0<br>
(e.g. -1), the direction of accumulation is reversed. In this<br>
case, if *normed* is also *True*, then the histogram is normalized<br>
such that the first bin equals 1.<br>
<br>
*histtype*: [ 'bar' | 'barstacked' | 'step' | 'stepfilled' ]<br>
The type of histogram to draw.<br>
<br>
- 'bar' is a traditional bar-type histogram<br>
<br>
- 'barstacked' is a bar-type histogram where multiple<br>
data are stacked on top of each other.<br>
<br>
- 'step' generates a lineplot that is by default<br>
unfilled<br>
<br>
- 'stepfilled' generates a lineplot that this by default<br>
filled.<br>
<br>
*align*: ['left' | 'mid' | 'right' ]<br>
Controls how the histogram is plotted.<br>
<br>
- 'left': bars are centered on the left bin edges<br>
<br>
- 'mid': bars are centered between the bin edges<br>
<br>
- 'right': bars are centered on the right bin edges.<br>
<br>
*orientation*: [ 'horizontal' | 'vertical' ]<br>
If 'horizontal', :func:`~matplotlib.pyplot.barh` will be<br>
used for bar-type histograms and the *bottom* kwarg will be<br>
the left edges.<br>
<br>
*rwidth*:<br>
the relative width of the bars as a fraction of the bin<br>
width. If *None*, automatically compute the width. Ignored<br>
if *histtype* = 'step'.<br>
<br>
*log*:<br>
If *True*, the histogram axis will be set to a log scale.<br>
If *log* is *True* and *x* is a 1D array, empty bins will<br>
be filtered out and only the non-empty (*n*, *bins*,<br>
*patches*) will be returned.<br>
<br>
kwargs are used to update the properties of the hist<br>
:class:`~matplotlib.patches.Rectangle` instances:<br>
<br>
<br>
=========== ===========================================================<br>
Property Description <br>
=========== ===========================================================<br>
aa [True | False] or None for default <br>
alpha float <br>
animated [True | False] <br>
antialiased [True | False] or None for default <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
contains unknown <br>
ec mpl color spec, or None for default, or 'none' for no color<br>
edgecolor mpl color spec, or None for default, or 'none' for no color<br>
facecolor mpl color spec, or None for default, or 'none' for no color<br>
fc mpl color spec, or None for default, or 'none' for no color<br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fill [True | False] <br>
hatch unknown <br>
label any string <br>
linestyle ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
linewidth float or None for default <br>
lod [True | False] <br>
ls ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
lw float or None for default <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
=========== ===========================================================<br>
<br>
<br>
You can use labels for your histogram, and only the first<br>
:class:`~matplotlib.patches.Rectangle` gets the label (the<br>
others get the magic string '_nolegend_'. This will make the<br>
histograms work in the intuitive way for bar charts::<br>
<br>
ax.<a href="#Axes-hist">hist</a>(10+2*np.random.randn(1000), label='men')<br>
ax.<a href="#Axes-hist">hist</a>(12+3*np.random.randn(1000), label='women', alpha=0.5)<br>
ax.<a href="#Axes-legend">legend</a>()<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/histogram_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-hlines"><strong>hlines</strong></a>(self, y, xmin, xmax, colors<font color="#909090">='k'</font>, linestyles<font color="#909090">='solid'</font>, label<font color="#909090">=''</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-hlines">hlines</a>(y, xmin, xmax, colors='k', linestyle='solid', **kwargs)<br>
<br>
Plot horizontal lines at each *y* from *xmin* to *xmax*.<br>
<br>
Returns the :class:`~matplotlib.collections.LineCollection`<br>
that was added.<br>
<br>
Required arguments:<br>
<br>
*y*:<br>
a 1-D numpy array or iterable.<br>
<br>
*xmin* and *xmax*:<br>
can be scalars or ``len(x)`` numpy arrays. If they are<br>
scalars, then the respective values are constant, else the<br>
widths of the lines are determined by *xmin* and *xmax*.<br>
<br>
Optional keyword arguments:<br>
<br>
*colors*:<br>
a line collections color argument, either a single color<br>
or a ``len(y)`` list of colors<br>
<br>
*linestyle*:<br>
[ 'solid' | 'dashed' | 'dashdot' | 'dotted' ]<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/hline_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-hold"><strong>hold</strong></a>(self, b<font color="#909090">=None</font>)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-hold">hold</a>(b=None)<br>
<br>
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>
Examples:<br>
<br>
* toggle hold:<br>
>>> <a href="#Axes-hold">hold</a>()<br>
* turn hold on:<br>
>>> <a href="#Axes-hold">hold</a>(True)<br>
* turn hold off<br>
>>> <a href="#Axes-hold">hold</a>(False)<br>
<br>
<br>
When hold is True, subsequent plot commands will be added to<br>
the current axes. When hold is False, the current axes and<br>
figure will be cleared on the next plot command</tt></dd></dl>
<dl><dt><a name="Axes-imshow"><strong>imshow</strong></a>(self, X, cmap<font color="#909090">=None</font>, norm<font color="#909090">=None</font>, aspect<font color="#909090">=None</font>, interpolation<font color="#909090">=None</font>, alpha<font color="#909090">=1.0</font>, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>, origin<font color="#909090">=None</font>, extent<font color="#909090">=None</font>, shape<font color="#909090">=None</font>, filternorm<font color="#909090">=1</font>, filterrad<font color="#909090">=4.0</font>, imlim<font color="#909090">=None</font>, resample<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-imshow">imshow</a>(X, cmap=None, norm=None, aspect=None, interpolation=None,<br>
alpha=1.0, vmin=None, vmax=None, origin=None, extent=None,<br>
**kwargs)<br>
<br>
Display the image in *X* to current axes. *X* may be a float<br>
array, a uint8 array or a PIL image. If *X* is an array, *X*<br>
can have the following shapes:<br>
<br>
* MxN -- luminance (grayscale, float array only)<br>
* MxNx3 -- RGB (float or uint8 array)<br>
* MxNx4 -- RGBA (float or uint8 array)<br>
<br>
The value for each component of MxNx3 and MxNx4 float arrays should be<br>
in the range 0.0 to 1.0; MxN float arrays may be normalised.<br>
<br>
An :class:`matplotlib.image.AxesImage` instance is returned.<br>
<br>
Keyword arguments:<br>
<br>
*cmap*: [ None | Colormap ]<br>
A :class:`matplotlib.cm.Colormap` instance, eg. cm.jet.<br>
If *None*, default to rc ``image.cmap`` value.<br>
<br>
*cmap* is ignored when *X* has RGB(A) information<br>
<br>
*aspect*: [ None | 'auto' | 'equal' | scalar ]<br>
If 'auto', changes the image aspect ratio to match that of the axes<br>
<br>
If 'equal', and *extent* is *None*, changes the axes<br>
aspect ratio to match that of the image. If *extent* is<br>
not *None*, the axes aspect ratio is changed to match that<br>
of the extent.<br>
<br>
If *None*, default to rc ``image.aspect`` value.<br>
<br>
*interpolation*:<br>
Acceptable values are *None*, 'nearest', 'bilinear', 'bicubic',<br>
'spline16', 'spline36', 'hanning', 'hamming', 'hermite', 'kaiser',<br>
'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell', 'sinc',<br>
'lanczos', 'blackman'<br>
<br>
If *interpolation* is *None*, default to rc<br>
``image.interpolation``. See also the *filternorm* and<br>
*filterrad* parameters<br>
<br>
*norm*: [ None | Normalize ]<br>
An :class:`matplotlib.colors.Normalize` instance; if<br>
*None*, default is ``normalization()``. This scales<br>
luminance -> 0-1<br>
<br>
*norm* is only used for an MxN float array.<br>
<br>
*vmin*/*vmax*: [ None | scalar ]<br>
Used to scale a luminance image to 0-1. If either is<br>
*None*, the min and max of the luminance values will be<br>
used. Note if *norm* is not *None*, the settings for<br>
*vmin* and *vmax* will be ignored.<br>
<br>
*alpha*: scalar<br>
The alpha blending value, between 0 (transparent) and 1 (opaque)<br>
<br>
*origin*: [ None | 'upper' | 'lower' ]<br>
Place the [0,0] index of the array in the upper left or lower left<br>
corner of the axes. If *None*, default to rc ``image.origin``.<br>
<br>
*extent*: [ None | scalars (left, right, bottom, top) ]<br>
Eata values of the axes. The default assigns zero-based row,<br>
column indices to the *x*, *y* centers of the pixels.<br>
<br>
*shape*: [ None | scalars (columns, rows) ]<br>
For raw buffer images<br>
<br>
*filternorm*:<br>
A parameter for the antigrain image resize filter. From the<br>
antigrain documentation, if *filternorm* = 1, the filter normalizes<br>
integer values and corrects the rounding errors. It doesn't do<br>
anything with the source floating point values, it corrects only<br>
integers according to the rule of 1.0 which means that any sum of<br>
pixel weights must be equal to 1.0. So, the filter function must<br>
produce a graph of the proper shape.<br>
<br>
*filterrad*:<br>
The filter radius for filters that have a radius<br>
parameter, i.e. when interpolation is one of: 'sinc',<br>
'lanczos' or 'blackman'<br>
<br>
Additional kwargs are :class:`~matplotlib.artist.<a href="matplotlib.artist.html#Artist">Artist</a>` properties:<br>
<br>
<br>
========= ===============================================<br>
Property Description <br>
========= ===============================================<br>
alpha float <br>
animated [True | False] <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a<br>
contains unknown <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
lod [True | False] <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
========= ===============================================<br>
<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/image_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-in_axes"><strong>in_axes</strong></a>(self, mouseevent)</dt><dd><tt>return *True* if the given *mouseevent* (in display coords)<br>
is in the <a href="#Axes">Axes</a></tt></dd></dl>
<dl><dt><a name="Axes-invert_xaxis"><strong>invert_xaxis</strong></a>(self)</dt><dd><tt>Invert the x-axis.</tt></dd></dl>
<dl><dt><a name="Axes-invert_yaxis"><strong>invert_yaxis</strong></a>(self)</dt><dd><tt>Invert the y-axis.</tt></dd></dl>
<dl><dt><a name="Axes-ishold"><strong>ishold</strong></a>(self)</dt><dd><tt>return the HOLD status of the axes</tt></dd></dl>
<dl><dt><a name="Axes-legend"><strong>legend</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-legend">legend</a>(*args, **kwargs)<br>
<br>
Place a legend on the current axes at location *loc*. Labels are a<br>
sequence of strings and *loc* can be a string or an integer specifying<br>
the legend location.<br>
<br>
To make a legend with existing lines::<br>
<br>
<a href="#Axes-legend">legend</a>()<br>
<br>
:meth:`legend` by itself will try and build a legend using the label<br>
property of the lines/patches/collections. You can set the label of<br>
a line by doing::<br>
<br>
<a href="#Axes-plot">plot</a>(x, y, label='my data')<br>
<br>
or::<br>
<br>
line.<a href="#Axes-set_label">set_label</a>('my data').<br>
<br>
If label is set to '_nolegend_', the item will not be shown in<br>
legend.<br>
<br>
To automatically generate the legend from labels::<br>
<br>
<a href="#Axes-legend">legend</a>( ('label1', 'label2', 'label3') )<br>
<br>
To make a legend for a list of lines and labels::<br>
<br>
<a href="#Axes-legend">legend</a>( (line1, line2, line3), ('label1', 'label2', 'label3') )<br>
<br>
To make a legend at a given location, using a location argument::<br>
<br>
<a href="#Axes-legend">legend</a>( ('label1', 'label2', 'label3'), loc='upper left')<br>
<br>
or::<br>
<br>
<a href="#Axes-legend">legend</a>( (line1, line2, line3), ('label1', 'label2', 'label3'), loc=2)<br>
<br>
The location codes are<br>
<br>
=============== =============<br>
Location String Location Code<br>
=============== =============<br>
'best' 0<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>
<br>
If none of these are locations are suitable, loc can be a 2-tuple<br>
giving x,y in axes coords, ie::<br>
<br>
loc = 0, 1 # left top<br>
loc = 0.5, 0.5 # center<br>
<br>
Keyword arguments:<br>
<br>
*isaxes*: [ True | False ]<br>
Indicates that this is an axes legend<br>
<br>
*numpoints*: integer<br>
The number of points in the legend line, default is 4<br>
<br>
*prop*: [ None | FontProperties ]<br>
A :class:`matplotlib.font_manager.FontProperties`<br>
instance, or *None* to use rc settings.<br>
<br>
*pad*: [ None | scalar ]<br>
The fractional whitespace inside the legend border, between 0 and 1.<br>
If *None*, use rc settings.<br>
<br>
*markerscale*: [ None | scalar ]<br>
The relative size of legend markers vs. original. If *None*, use rc<br>
settings.<br>
<br>
*shadow*: [ None | False | True ]<br>
If *True*, draw a shadow behind legend. If *None*, use rc settings.<br>
<br>
*labelsep*: [ None | scalar ]<br>
The vertical space between the legend entries. If *None*, use rc<br>
settings.<br>
<br>
*handlelen*: [ None | scalar ]<br>
The length of the legend lines. If *None*, use rc settings.<br>
<br>
*handletextsep*: [ None | scalar ]<br>
The space between the legend line and legend text. If *None*, use rc<br>
settings.<br>
<br>
*axespad*: [ None | scalar ]<br>
The border between the axes and legend edge. If *None*, use rc<br>
settings.<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/api/legend_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-loglog"><strong>loglog</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-loglog">loglog</a>(*args, **kwargs)<br>
<br>
Make a plot with log scaling on the *x* and *y* axis.<br>
<br>
:func:`~matplotlib.pyplot.loglog` supports all the keyword<br>
arguments of :func:`~matplotlib.pyplot.plot` and<br>
:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.set_xscale`/:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.set_yscale`.<br>
<br>
Notable keyword arguments:<br>
<br>
*basex*/*basey*: scalar > 1<br>
base of the *x*/*y* logarithm<br>
<br>
*subsx*/*subsy*: [ None | sequence ]<br>
the location of the minor *x*/*y* ticks; *None* defaults<br>
to autosubs, which depend on the number of decades in the<br>
plot; see<br>
:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.set_xscale`/:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.set_yscale`<br>
for details<br>
<br>
The remaining valid kwargs are<br>
:class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/log_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-matshow"><strong>matshow</strong></a>(self, Z, **kwargs)</dt><dd><tt>Plot a matrix or array as an image.<br>
<br>
The matrix will be shown the way it would be printed,<br>
with the first row at the top. Row and column numbering<br>
is zero-based.<br>
<br>
Argument:<br>
*Z* anything that can be interpreted as a 2-D array<br>
<br>
kwargs all are passed to :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.imshow`.<br>
:meth:`matshow` sets defaults for *extent*, *origin*,<br>
*interpolation*, and *aspect*; use care in overriding the<br>
*extent* and *origin* kwargs, because they interact. (Also,<br>
if you want to change them, you probably should be using<br>
imshow directly in your own version of matshow.)<br>
<br>
Returns: an :class:`matplotlib.image.AxesImage` instance.</tt></dd></dl>
<dl><dt><a name="Axes-pcolor"><strong>pcolor</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signatures::<br>
<br>
<a href="#Axes-pcolor">pcolor</a>(C, **kwargs)<br>
<a href="#Axes-pcolor">pcolor</a>(X, Y, C, **kwargs)<br>
<br>
Create a pseudocolor plot of a 2-D array.<br>
<br>
*C* is the array of color values.<br>
<br>
*X* and *Y*, if given, specify the (*x*, *y*) coordinates of<br>
the colored quadrilaterals; the quadrilateral for C[i,j] has<br>
corners at::<br>
<br>
(X[i, j], Y[i, j]),<br>
(X[i, j+1], Y[i, j+1]),<br>
(X[i+1, j], Y[i+1, j]),<br>
(X[i+1, j+1], Y[i+1, j+1]).<br>
<br>
Ideally the dimensions of *X* and *Y* should be one greater<br>
than those of *C*; if the dimensions are the same, then the<br>
last row and column of *C* will be ignored.<br>
<br>
Note that the the column index corresponds to the<br>
*x*-coordinate, and the row index corresponds to *y*; for<br>
details, see the :ref:`Grid Orientation<br>
<axes-pcolor-grid-orientation>` section below.<br>
<br>
If either or both of *X* and *Y* are 1-D arrays or column vectors,<br>
they will be expanded as needed into the appropriate 2-D arrays,<br>
making a rectangular grid.<br>
<br>
*X*, *Y* and *C* may be masked arrays. If either C[i, j], or one<br>
of the vertices surrounding C[i,j] (*X* or *Y* at [i, j], [i+1, j],<br>
[i, j+1],[i+1, j+1]) is masked, nothing is plotted.<br>
<br>
Keyword arguments:<br>
<br>
*cmap*: [ None | Colormap ]<br>
A :class:`matplotlib.cm.Colormap` instance. If *None*, use<br>
rc settings.<br>
<br>
norm: [ None | Normalize ]<br>
An :class:`matplotlib.colors.Normalize` instance is used<br>
to scale luminance data to 0,1. If *None*, defaults to<br>
:func:`normalize`.<br>
<br>
*vmin*/*vmax*: [ None | scalar ]<br>
*vmin* and *vmax* are used in conjunction with *norm* to<br>
normalize luminance data. If either are *None*, the min<br>
and max of the color array *C* is used. If you pass a<br>
*norm* instance, *vmin* and *vmax* will be ignored.<br>
<br>
*shading*: [ 'flat' | 'faceted' ]<br>
If 'faceted', a black grid is drawn around each rectangle; if<br>
'flat', edges are not drawn. Default is 'flat', contrary to<br>
Matlab(TM).<br>
<br>
This kwarg is deprecated; please use 'edgecolors' instead:<br>
* shading='flat' -- edgecolors='None'<br>
* shading='faceted -- edgecolors='k'<br>
<br>
*edgecolors*: [ None | 'None' | color | color sequence]<br>
If *None*, the rc setting is used by default.<br>
<br>
If 'None', edges will not be visible.<br>
<br>
An mpl color or sequence of colors will set the edge color<br>
<br>
*alpha*: 0 <= scalar <= 1<br>
the alpha blending value<br>
<br>
Return value is a :class:`matplotlib.collection.Collection`<br>
instance.<br>
<br>
.. _axes-pcolor-grid-orientation:<br>
<br>
The grid orientation follows the Matlab(TM) convention: an<br>
array *C* with shape (*nrows*, *ncolumns*) is plotted with<br>
the column number as *X* and the row number as *Y*, increasing<br>
up; hence it is plotted the way the array would be printed,<br>
except that the *Y* axis is reversed. That is, *C* is taken<br>
as *C*(*y*, *x*).<br>
<br>
Similarly for :func:`~matplotlib.pyplot.meshgrid`::<br>
<br>
x = np.arange(5)<br>
y = np.arange(3)<br>
X, Y = meshgrid(x,y)<br>
<br>
is equivalent to:<br>
<br>
X = array([[0, 1, 2, 3, 4],<br>
[0, 1, 2, 3, 4],<br>
[0, 1, 2, 3, 4]])<br>
<br>
Y = array([[0, 0, 0, 0, 0],<br>
[1, 1, 1, 1, 1],<br>
[2, 2, 2, 2, 2]])<br>
<br>
so if you have::<br>
<br>
C = rand( len(x), len(y))<br>
<br>
then you need::<br>
<br>
<a href="#Axes-pcolor">pcolor</a>(X, Y, C.T)<br>
<br>
or::<br>
<br>
<a href="#Axes-pcolor">pcolor</a>(C.T)<br>
<br>
Matlab :func:`pcolor` always discards the last row and column<br>
of *C*, but matplotlib displays the last row and column if *X* and<br>
*Y* are not specified, or if *X* and *Y* have one more row and<br>
column than *C*.<br>
<br>
kwargs can be used to control the<br>
:class:`~matplotlib.collection.PolyCollection` properties:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================</tt></dd></dl>
<dl><dt><a name="Axes-pcolorfast"><strong>pcolorfast</strong></a>(self, *args, **kwargs)</dt><dd><tt>pseudocolor plot of a 2-D array<br>
<br>
Experimental; this is a version of pcolor that<br>
does not draw lines, that provides the fastest<br>
possible rendering with the Agg backend, and that<br>
can handle any quadrilateral grid.<br>
<br>
Call signatures::<br>
<br>
<a href="#Axes-pcolor">pcolor</a>(C, **kwargs)<br>
<a href="#Axes-pcolor">pcolor</a>(xr, yr, C, **kwargs)<br>
<a href="#Axes-pcolor">pcolor</a>(x, y, C, **kwargs)<br>
<a href="#Axes-pcolor">pcolor</a>(X, Y, C, **kwargs)<br>
<br>
C is the 2D array of color values corresponding to quadrilateral<br>
cells. Let (nr, nc) be its shape. C may be a masked array.<br>
<br>
``<a href="#Axes-pcolor">pcolor</a>(C, **kwargs)`` is equivalent to<br>
``<a href="#Axes-pcolor">pcolor</a>([0,nc], [0,nr], C, **kwargs)``<br>
<br>
*xr*, *yr* specify the ranges of *x* and *y* corresponding to the<br>
rectangular region bounding *C*. If::<br>
<br>
xr = [x0, x1]<br>
<br>
and::<br>
<br>
yr = [y0,y1]<br>
<br>
then *x* goes from *x0* to *x1* as the second index of *C* goes<br>
from 0 to *nc*, etc. (*x0*, *y0*) is the outermost corner of<br>
cell (0,0), and (*x1*, *y1*) is the outermost corner of cell<br>
(*nr*-1, *nc*-1). All cells are rectangles of the same size.<br>
This is the fastest version.<br>
<br>
*x*, *y* are 1D arrays of length *nc* +1 and *nr* +1, respectively,<br>
giving the x and y boundaries of the cells. Hence the cells are<br>
rectangular but the grid may be nonuniform. The speed is<br>
intermediate. (The grid is checked, and if found to be<br>
uniform the fast version is used.)<br>
<br>
*X* and *Y* are 2D arrays with shape (*nr* +1, *nc* +1) that specify<br>
the (x,y) coordinates of the corners of the colored<br>
quadrilaterals; the quadrilateral for C[i,j] has corners at<br>
(X[i,j],Y[i,j]), (X[i,j+1],Y[i,j+1]), (X[i+1,j],Y[i+1,j]),<br>
(X[i+1,j+1],Y[i+1,j+1]). The cells need not be rectangular.<br>
This is the most general, but the slowest to render. It may<br>
produce faster and more compact output using ps, pdf, and<br>
svg backends, however.<br>
<br>
Note that the the column index corresponds to the x-coordinate,<br>
and the row index corresponds to y; for details, see<br>
the "Grid Orientation" section below.<br>
<br>
Optional keyword arguments:<br>
<br>
*cmap*: [ None | Colormap ]<br>
A cm Colormap instance from cm. If None, use rc settings.<br>
*norm*: [ None | Normalize ]<br>
An mcolors.Normalize instance is used to scale luminance data to<br>
0,1. If None, defaults to normalize()<br>
*vmin*/*vmax*: [ None | scalar ]<br>
*vmin* and *vmax* are used in conjunction with norm to normalize<br>
luminance data. If either are *None*, the min and max of the color<br>
array *C* is used. If you pass a norm instance, *vmin* and *vmax*<br>
will be *None*.<br>
*alpha*: 0 <= scalar <= 1<br>
the alpha blending value<br>
<br>
Return value is an image if a regular or rectangular grid<br>
is specified, and a QuadMesh collection in the general<br>
quadrilateral case.</tt></dd></dl>
<dl><dt><a name="Axes-pcolormesh"><strong>pcolormesh</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signatures::<br>
<br>
<a href="#Axes-pcolormesh">pcolormesh</a>(C)<br>
<a href="#Axes-pcolormesh">pcolormesh</a>(X, Y, C)<br>
<a href="#Axes-pcolormesh">pcolormesh</a>(C, **kwargs)<br>
<br>
*C* may be a masked array, but *X* and *Y* may not. Masked<br>
array support is implemented via *cmap* and *norm*; in<br>
contrast, :func:`~matplotlib.pyplot.pcolor` simply does not<br>
draw quadrilaterals with masked colors or vertices.<br>
<br>
Keyword arguments:<br>
<br>
*cmap*: [ None | Colormap ]<br>
A :class:`matplotlib.cm.Colormap` instance. If None, use<br>
rc settings.<br>
<br>
*norm*: [ None | Normalize ]<br>
A :class:`matplotlib.colors.Normalize` instance is used to<br>
scale luminance data to 0,1. If None, defaults to<br>
:func:`normalize`.<br>
<br>
*vmin*/*vmax*: [ None | scalar ]<br>
*vmin* and *vmax* are used in conjunction with *norm* to<br>
normalize luminance data. If either are *None*, the min<br>
and max of the color array *C* is used. If you pass a<br>
*norm* instance, *vmin* and *vmax* will be ignored.<br>
<br>
*shading*: [ 'flat' | 'faceted' ]<br>
If 'faceted', a black grid is drawn around each rectangle; if<br>
'flat', edges are not drawn. Default is 'flat', contrary to<br>
Matlab(TM).<br>
<br>
This kwarg is deprecated; please use 'edgecolors' instead:<br>
* shading='flat' -- edgecolors='None'<br>
* shading='faceted -- edgecolors='k'<br>
<br>
*edgecolors*: [ None | 'None' | color | color sequence]<br>
If None, the rc setting is used by default.<br>
<br>
If 'None', edges will not be visible.<br>
<br>
An mpl color or sequence of colors will set the edge color<br>
<br>
*alpha*: 0 <= scalar <= 1<br>
the alpha blending value<br>
<br>
Return value is a :class:`matplotlib.collection.QuadMesh`<br>
object.<br>
<br>
See :func:`~matplotlib.pyplot.pcolor` for an explanation of<br>
the grid orientation and the expansion of 1-D *X* and/or *Y*<br>
to 2-D arrays.<br>
<br>
kwargs can be used to control the<br>
:class:`matplotlib.collections.QuadMesh`<br>
properties:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================</tt></dd></dl>
<dl><dt><a name="Axes-pick"><strong>pick</strong></a>(self, *args)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-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="Axes-pie"><strong>pie</strong></a>(self, x, explode<font color="#909090">=None</font>, labels<font color="#909090">=None</font>, colors<font color="#909090">=None</font>, autopct<font color="#909090">=None</font>, pctdistance<font color="#909090">=0.59999999999999998</font>, shadow<font color="#909090">=False</font>, labeldistance<font color="#909090">=1.1000000000000001</font>)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-pie">pie</a>(x, explode=None, labels=None,<br>
colors=('b', 'g', 'r', 'c', 'm', 'y', 'k', 'w'),<br>
autopct=None, pctdistance=0.6, labeldistance=1.1, shadow=False)<br>
<br>
Make a pie chart of array *x*. The fractional area of each<br>
wedge is given by x/sum(x). If sum(x) <= 1, then the values<br>
of x give the fractional area directly and the array will not<br>
be normalized.<br>
<br>
Keyword arguments:<br>
<br>
*explode*: [ None | len(x) sequence ]<br>
If not *None*, is a len(*x*) array which specifies the<br>
fraction of the radius with which to offset each wedge.<br>
<br>
*colors*: [ None | color sequence ]<br>
A sequence of matplotlib color args through which the pie chart<br>
will cycle.<br>
<br>
*labels*: [ None | len(x) sequence of strings ]<br>
A sequence of strings providing the labels for each wedge<br>
<br>
*autopct*: [ None | format string | format function ]<br>
If not *None*, is a string or function used to label the<br>
wedges with their numeric value. The label will be placed inside<br>
the wedge. If it is a format string, the label will be ``fmt%pct``.<br>
If it is a function, it will be called.<br>
<br>
*pctdistance*: scalar<br>
The ratio between the center of each pie slice and the<br>
start of the text generated by *autopct*. Ignored if<br>
*autopct* is *None*; default is 0.6.<br>
<br>
*labeldistance*: scalar<br>
The radial distance at which the pie labels are drawn<br>
<br>
*shadow*: [ False | True ]<br>
Draw a shadow beneath the pie.<br>
<br>
The pie chart will probably look best if the figure and axes are<br>
square. Eg.::<br>
<br>
figure(figsize=(8,8))<br>
ax = axes([0.1, 0.1, 0.8, 0.8])<br>
<br>
Return value:<br>
If *autopct* is None, return the tuple (*patches*, *texts*):<br>
<br>
- *patches* is a sequence of<br>
:class:`matplotlib.patches.Wedge` instances<br>
<br>
- *texts* is a list of the label<br>
:class:`matplotlib.text.Text` instances.<br>
<br>
If *autopct* is not *None*, return the tuple (*patches*,<br>
*texts*, *autotexts*), where *patches* and *texts* are as<br>
above, and *autotexts* is a list of<br>
:class:`~matplotlib.text.Text` instances for the numeric<br>
labels.</tt></dd></dl>
<dl><dt><a name="Axes-plot"><strong>plot</strong></a>(self, *args, **kwargs)</dt><dd><tt>Plot lines and/or markers to the<br>
:class:`~matplotlib.axes.<a href="#Axes">Axes</a>`. *args* is a variable length<br>
argument, allowing for multiple *x*, *y* pairs with an<br>
optional format string. For example, each of the following is<br>
legal::<br>
<br>
<a href="#Axes-plot">plot</a>(x, y) # plot x and y using the default line style and color<br>
<a href="#Axes-plot">plot</a>(x, y, 'bo') # plot x and y using blue circle markers<br>
<a href="#Axes-plot">plot</a>(y) # plot y using x as index array 0..N-1<br>
<a href="#Axes-plot">plot</a>(y, 'r+') # ditto, but with red plusses<br>
<br>
If *x* and/or *y* is 2-dimensional, then the corresponding columns<br>
will be plotted.<br>
<br>
An arbitrary number of *x*, *y*, *fmt* groups can be<br>
specified, as in::<br>
<br>
a.<a href="#Axes-plot">plot</a>(x1, y1, 'g^', x2, y2, 'g-')<br>
<br>
Return value is a list of lines that were added.<br>
<br>
The following line styles are supported::<br>
<br>
- # solid line<br>
-- # dashed line<br>
-. # dash-dot line<br>
: # dotted line<br>
. # points<br>
, # pixels<br>
o # circle symbols<br>
^ # triangle up symbols<br>
v # triangle down symbols<br>
< # triangle left symbols<br>
> # triangle right symbols<br>
s # square symbols<br>
+ # plus symbols<br>
x # cross symbols<br>
D # diamond symbols<br>
d # thin diamond symbols<br>
1 # tripod down symbols<br>
2 # tripod up symbols<br>
3 # tripod left symbols<br>
4 # tripod right symbols<br>
h # hexagon symbols<br>
H # rotated hexagon symbols<br>
p # pentagon symbols<br>
| # vertical line symbols<br>
_ # horizontal line symbols<br>
steps # use gnuplot style 'steps' # kwarg only<br>
<br>
The following color abbreviations are supported::<br>
<br>
b # blue<br>
g # green<br>
r # red<br>
c # cyan<br>
m # magenta<br>
y # yellow<br>
k # black<br>
w # white<br>
<br>
In addition, you can specify colors in many weird and<br>
wonderful ways, including full names (``'green'``), hex<br>
strings (``'#008000'``), RGB or RGBA tuples (``(0,1,0,1)``) or<br>
grayscale intensities as a string (``'0.8'``). Of these, the<br>
string specifications can be used in place of a ``fmt`` group,<br>
but the tuple forms can be used only as ``kwargs``.<br>
<br>
Line styles and colors are combined in a single format string, as in<br>
``'bo'`` for blue circles.<br>
<br>
The *kwargs* can be used to set line properties (any property that has<br>
a ``set_*`` method). You can use this to set a line label (for auto<br>
legends), linewidth, anitialising, marker face color, etc. Here is an<br>
example::<br>
<br>
<a href="#Axes-plot">plot</a>([1,2,3], [1,2,3], 'go-', label='line 1', linewidth=2)<br>
<a href="#Axes-plot">plot</a>([1,2,3], [1,4,9], 'rs', label='line 2')<br>
<a href="#Axes-axis">axis</a>([0, 4, 0, 10])<br>
<a href="#Axes-legend">legend</a>()<br>
<br>
If you make multiple lines with one plot command, the kwargs<br>
apply to all those lines, e.g.::<br>
<br>
<a href="#Axes-plot">plot</a>(x1, y1, x2, y2, antialised=False)<br>
<br>
Neither line will be antialiased.<br>
<br>
The kwargs are :class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
kwargs *scalex* and *scaley*, if defined, are passed on to<br>
:meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.autoscale_view` to determine<br>
whether the *x* and *y* axes are autoscaled; the default is<br>
*True*.</tt></dd></dl>
<dl><dt><a name="Axes-plot_date"><strong>plot_date</strong></a>(self, x, y, fmt<font color="#909090">='bo'</font>, tz<font color="#909090">=None</font>, xdate<font color="#909090">=True</font>, ydate<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-plot_date">plot_date</a>(x, y, fmt='bo', tz=None, xdate=True, ydate=False, **kwargs)<br>
<br>
Similar to the :func:`~matplotlib.pyplot.plot` command, except<br>
the *x* or *y* (or both) data is considered to be dates, and the<br>
axis is labeled accordingly.<br>
<br>
*x* and/or *y* can be a sequence of dates represented as float days since<br>
0001-01-01 UTC.<br>
<br>
See :mod:`~matplotlib.dates` for helper functions<br>
:func:`~matplotlib.dates.date2num`,<br>
:func:`~matplotlib.dates.num2date` and<br>
:func:`~matplotlib.dates.drange` for help on creating the<br>
required floating point dates.<br>
<br>
Keyword arguments:<br>
<br>
*fmt*: string<br>
The plot format string.<br>
<br>
*tz*: [ None | timezone string ]<br>
The time zone to use in labeling dates. If *None*, defaults to rc<br>
value.<br>
<br>
*xdate*: [ True | False ]<br>
If *True*, the *x*-axis will be labeled with dates.<br>
<br>
*ydate*: [ False | True ]<br>
If *True*, the *y*-axis will be labeled with dates.<br>
<br>
Note if you are using custom date tickers and formatters, it<br>
may be necessary to set the formatters/locators after the call<br>
to :meth:`plot_date` since :meth:`plot_date` will set the<br>
default tick locator to<br>
:class:`matplotlib.ticker.AutoDateLocator` (if the tick<br>
locator is not already set to a<br>
:class:`matplotlib.ticker.DateLocator` instance) and the<br>
default tick formatter to<br>
:class:`matplotlib.ticker.AutoDateFormatter` (if the tick<br>
formatter is not already set to a<br>
:class:`matplotlib.ticker.DateFormatter` instance).<br>
<br>
Valid kwargs are :class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================</tt></dd></dl>
<dl><dt><a name="Axes-psd"><strong>psd</strong></a>(self, x, NFFT<font color="#909090">=256</font>, Fs<font color="#909090">=2</font>, Fc<font color="#909090">=0</font>, detrend<font color="#909090">=<function detrend_none at 0x26b5ed8></font>, window<font color="#909090">=<function window_hanning at 0x26b5578></font>, noverlap<font color="#909090">=0</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-psd">psd</a>(x, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,<br>
window=mlab.window_hanning, noverlap=0, **kwargs)<br>
<br>
The power spectral density by Welches average periodogram<br>
method. The vector *x* is divided into *NFFT* length<br>
segments. Each segment is detrended by function *detrend* and<br>
windowed by function *window*. *noperlap* gives the length of<br>
the overlap between segments. The :math:`|\mathrm{fft}(i)|^2`<br>
of each segment :math:`i` are averaged to compute *Pxx*, with a<br>
scaling to correct for power loss due to windowing. *Fs* is the<br>
sampling frequency.<br>
<br>
Keyword arguments:<br>
<br>
*NFFT*: integer<br>
The length of the fft segment, must be a power of 2<br>
<br>
*Fs*: integer<br>
The sampling frequency.<br>
<br>
*Fc*: integer<br>
The center frequency of *x* (defaults to 0), which offsets<br>
the yextents of the image to reflect the frequency range used<br>
when a signal is acquired and then filtered and downsampled to<br>
baseband.<br>
<br>
*detrend*:<br>
The function applied to each segment before fft-ing,<br>
designed to remove the mean or linear trend. Unlike in<br>
matlab, where the *detrend* parameter is a vector, in<br>
matplotlib is it a function. The :mod:`~matplotlib.pylab`<br>
module defines :func:`~matplotlib.pylab.detrend_none`,<br>
:func:`~matplotlib.pylab.detrend_mean`, and<br>
:func:`~matplotlib.pylab.detrend_linear`, but you can use<br>
a custom function as well.<br>
<br>
*window*:<br>
The function used to window the segments. *window* is a<br>
function, unlike in matlab where it is a vector.<br>
:mod:`~matplotlib.pylab` defines<br>
:func:`~matplotlib.pylab.window_none`, and<br>
:func:`~matplotlib.pylab.window_hanning`, but you can use<br>
a custom function as well.<br>
<br>
*noverlap*: integer<br>
Gives the length of the overlap between segments.<br>
<br>
Returns the tuple (*Pxx*, *freqs*).<br>
<br>
For plotting, the power is plotted as<br>
:math:`10\log_{10}(P_{xx})` for decibels, though *Pxx* itself<br>
is returned.<br>
<br>
References:<br>
Bendat & Piersol -- Random Data: Analysis and Measurement<br>
Procedures, John Wiley & Sons (1986)<br>
<br>
kwargs control the :class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================</tt></dd></dl>
<dl><dt><a name="Axes-quiver"><strong>quiver</strong></a>(self, *args, **kw)</dt><dd><tt>Plot a 2-D field of arrows.<br>
<br>
call signatures::<br>
<br>
<a href="#Axes-quiver">quiver</a>(U, V, **kw)<br>
<a href="#Axes-quiver">quiver</a>(U, V, C, **kw)<br>
<a href="#Axes-quiver">quiver</a>(X, Y, U, V, **kw)<br>
<a href="#Axes-quiver">quiver</a>(X, Y, U, V, C, **kw)<br>
<br>
Arguments:<br>
<br>
*X*, *Y*:<br>
The x and y coordinates of the arrow locations<br>
(default is tail of arrow; see *pivot* kwarg)<br>
<br>
*U*, *V*:<br>
give the *x* and *y* components of the arrow vectors<br>
<br>
*C*:<br>
an optional array used to map colors to the arrows<br>
<br>
All arguments may be 1-D or 2-D arrays or sequences. If *X* and *Y*<br>
are absent, they will be generated as a uniform grid. If *U* and *V*<br>
are 2-D arrays but *X* and *Y* are 1-D, and if len(*X*) and len(*Y*)<br>
match the column and row dimensions of *U*, then *X* and *Y* will be<br>
expanded with :func:`numpy.meshgrid`.<br>
<br>
*U*, *V*, *C* may be masked arrays, but masked *X*, ** are not<br>
supported at present.<br>
<br>
Keyword arguments:<br>
<br>
*units*: ['width' | 'height' | 'dots' | 'inches' | 'x' | 'y' ]<br>
arrow units; the arrow dimensions *except for length* are<br>
in multiples of this unit.<br>
<br>
* 'width' or 'height': the width or height of the axes<br>
* 'dots' or 'inches': pixels or inches, based on the figure dpi<br>
* 'x' or 'y': *X* or *Y* data units<br>
<br>
In all cases the arrow aspect ratio is 1, so that if *U*==*V* the<br>
angle of the arrow on the plot is 45 degrees CCW from the *x*-axis.<br>
<br>
The arrows scale differently depending on the units, however.<br>
For 'x' or 'y', the arrows get larger as one zooms in; for other<br>
units, the arrow size is independent of the zoom state. For<br>
'width or 'height', the arrow size increases with the width and<br>
height of the axes, respectively, when the the window is resized;<br>
for 'dots' or 'inches', resizing does not change the arrows.<br>
<br>
*scale*: [ None | float ]<br>
data units per arrow unit, e.g. m/s per plot width;<br>
a smaller scale parameter makes the arrow longer.<br>
If *None*, a simple autoscaling algorithm is used, based<br>
on the average vector length and the number of vectors.<br>
<br>
*width*:<br>
shaft width in arrow units; default depends on choice of units,<br>
above, and number of vectors; a typical starting value is about<br>
0.005 times the width of the plot.<br>
<br>
*headwidth*: scalar<br>
head width as multiple of shaft width, default is 3<br>
<br>
*headlength*: scalar<br>
head length as multiple of shaft width, default is 5<br>
<br>
*headaxislength*: scalar<br>
head length at shaft intersection, default is 4.5<br>
<br>
*minshaft*: scalar<br>
length below which arrow scales, in units of head length. Do not<br>
set this to less than 1, or small arrows will look terrible!<br>
Default is 1<br>
<br>
*minlength*: scalar<br>
minimum length as a multiple of shaft width; if an arrow length<br>
is less than this, plot a dot (hexagon) of this diameter instead.<br>
Default is 1.<br>
<br>
*pivot*: [ 'tail' | 'middle' | 'tip' ]<br>
The part of the arrow that is at the grid point; the arrow<br>
rotates about this point, hence the name *pivot*.<br>
<br>
*color*: [ color | color sequence ]<br>
This is a synonym for the<br>
:class:`~matplotlib.collections.PolyCollection` facecolor kwarg.<br>
If *C* has been set, *color* has no effect.<br>
<br>
The defaults give a slightly swept-back arrow; to make the head a<br>
triangle, make *headaxislength* the same as *headlength*. To make the<br>
arrow more pointed, reduce *headwidth* or increase *headlength* and<br>
*headaxislength*. To make the head smaller relative to the shaft,<br>
scale down all the head parameters. You will probably do best to leave<br>
minshaft alone.<br>
<br>
linewidths and edgecolors can be used to customize the arrow<br>
outlines. Additional :class:`~matplotlib.collections.PolyCollection`<br>
keyword arguments:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================</tt></dd></dl>
<dl><dt><a name="Axes-quiverkey"><strong>quiverkey</strong></a>(self, *args, **kw)</dt><dd><tt>Add a key to a quiver plot.<br>
<br>
call signature::<br>
<br>
<a href="#Axes-quiverkey">quiverkey</a>(Q, X, Y, U, label, **kw)<br>
<br>
Arguments:<br>
<br>
*Q*:<br>
The Quiver instance returned by a call to quiver.<br>
<br>
*X*, *Y*:<br>
The location of the key; additional explanation follows.<br>
<br>
*U*:<br>
The length of the key<br>
<br>
*label*:<br>
a string with the length and units of the key<br>
<br>
Keyword arguments:<br>
<br>
*coordinates* = [ 'axes' | 'figure' | 'data' | 'inches' ]<br>
Coordinate system and units for *X*, *Y*: 'axes' and 'figure'<br>
are normalized coordinate systems with 0,0 in the lower<br>
left and 1,1 in the upper right; 'data' are the axes<br>
data coordinates (used for the locations of the vectors<br>
in the quiver plot itself); 'inches' is position in the<br>
figure in inches, with 0,0 at the lower left corner.<br>
<br>
*color*:<br>
overrides face and edge colors from *Q*.<br>
<br>
*labelpos* = [ 'N' | 'S' | 'E' | 'W' ]<br>
Position the label above, below, to the right, to the left<br>
of the arrow, respectively.<br>
<br>
*labelsep*:<br>
Distance in inches between the arrow and the label.<br>
Default is 0.1<br>
<br>
*labelcolor*:<br>
defaults to default :class:`~matplotlib.text.Text` color.<br>
<br>
*fontproperties*:<br>
A dictionary with keyword arguments accepted by the<br>
:class:`~matplotlib.font_manager.FontProperties` initializer:<br>
*family*, *style*, *variant*, *size*, *weight*<br>
<br>
Any additional keyword arguments are used to override vector<br>
properties taken from *Q*.<br>
<br>
The positioning of the key depends on *X*, *Y*, *coordinates*, and<br>
*labelpos*. If *labelpos* is 'N' or 'S', *X*, *Y* give the position<br>
of the middle of the key arrow. If *labelpos* is 'E', *X*, *Y*<br>
positions the head, and if *labelpos* is 'W', *X*, *Y* positions the<br>
tail; in either of these two cases, *X*, *Y* is somewhere in the<br>
middle of the arrow+label key object.</tt></dd></dl>
<dl><dt><a name="Axes-redraw_in_frame"><strong>redraw_in_frame</strong></a>(self)</dt><dd><tt>This method can only be used after an initial draw which<br>
caches the renderer. It is used to efficiently update <a href="#Axes">Axes</a><br>
data (axis ticks, labels, etc are not updated)</tt></dd></dl>
<dl><dt><a name="Axes-relim"><strong>relim</strong></a>(self)</dt><dd><tt>recompute the data limits based on current artists</tt></dd></dl>
<dl><dt><a name="Axes-scatter"><strong>scatter</strong></a>(self, x, y, s<font color="#909090">=20</font>, c<font color="#909090">='b'</font>, marker<font color="#909090">='o'</font>, cmap<font color="#909090">=None</font>, norm<font color="#909090">=None</font>, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>, alpha<font color="#909090">=1.0</font>, linewidths<font color="#909090">=None</font>, faceted<font color="#909090">=True</font>, verts<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signatures::<br>
<br>
<a href="#Axes-scatter">scatter</a>(x, y, s=20, c='b', marker='o', cmap=None, norm=None,<br>
vmin=None, vmax=None, alpha=1.0, linewidths=None,<br>
verts=None, **kwargs)<br>
<br>
Make a scatter plot of *x* versus *y*, where *x*, *y* are 1-D<br>
sequences of the same length, *N*.<br>
<br>
Keyword arguments:<br>
<br>
*s*:<br>
size in points^2. It is a scalar or an array of the same<br>
length as *x* and *y*.<br>
<br>
*c*:<br>
a color. *c* can be a single color format string, or a<br>
sequence of color specifications of length *N*, or a<br>
sequence of *N* numbers to be mapped to colors using the<br>
*cmap* and *norm* specified via kwargs (see below). Note<br>
that *c* should not be a single numeric RGB or RGBA<br>
sequence because that is indistinguishable from an array<br>
of values to be colormapped. *c* can be a 2-D array in<br>
which the rows are RGB or RGBA, however.<br>
<br>
*marker*:<br>
can be one of:<br>
<br>
===== ==============<br>
Value Description<br>
===== ==============<br>
's' square<br>
'o' circle<br>
'^' triangle up<br>
'>' triangle right<br>
'v' triangle down<br>
'<' triangle left<br>
'd' diamond<br>
'p' pentagram<br>
'h' hexagon<br>
'8' octagon<br>
'+' plus<br>
'x' cross<br>
===== ==============<br>
<br>
The marker can also be a tuple (*numsides*, *style*,<br>
*angle*), which will create a custom, regular symbol.<br>
<br>
*numsides*:<br>
the number of sides<br>
<br>
*style*:<br>
the style of the regular symbol:<br>
<br>
===== =============================================<br>
Value Description<br>
===== =============================================<br>
0 a regular polygon<br>
1 a star-like symbol<br>
2 an asterisk<br>
3 a circle (*numsides* and *angle* is ignored)<br>
===== =============================================<br>
<br>
*angle*:<br>
the angle of rotation of the symbol<br>
<br>
Finally, *marker* can be (*verts*, 0): *verts* is a<br>
sequence of (*x*, *y*) vertices for a custom scatter<br>
symbol. Alternatively, use the kwarg combination<br>
*marker* = *None*, *verts* = *verts*.<br>
<br>
Any or all of *x*, *y*, *s*, and *c* may be masked arrays, in<br>
which case all masks will be combined and only unmasked points<br>
will be plotted.<br>
<br>
Other keyword arguments: the color mapping and normalization<br>
arguments will be used only if *c* is an array of floats.<br>
<br>
*cmap*: [ None | Colormap ]<br>
A :class:`matplotlib.colors.Colormap` instance. If *None*,<br>
defaults to rc ``image.cmap``. *cmap* is only used if *c*<br>
is an array of floats.<br>
<br>
*norm*: [ None | Normalize ]<br>
A :class:`matplotlib.colors.Normalize` instance is used to<br>
scale luminance data to 0, 1. If *None*, use the default<br>
:func:`normalize`. *norm* is only used if *c* is an array<br>
of floats.<br>
<br>
*vmin*/*vmax*:<br>
*vmin* and *vmax* are used in conjunction with norm to<br>
normalize luminance data. If either are None, the min and<br>
max of the color array *C* is used. Note if you pass a<br>
*norm* instance, your settings for *vmin* and *vmax* will<br>
be ignored.<br>
<br>
*alpha*: 0 <= scalar <= 1<br>
The alpha value for the patches<br>
<br>
*linewidths*: [ None | scalar | sequence ]<br>
If *None*, defaults to (lines.linewidth,). Note that this<br>
is a tuple, and if you set the linewidths argument you<br>
must set it as a sequence of floats, as required by<br>
:class:`~matplotlib.collections.RegularPolyCollection`.<br>
<br>
Optional kwargs control the<br>
:class:`~matplotlib.collections.Collection` properties; in<br>
particular:<br>
<br>
*edgecolors*:<br>
'none' to plot faces with no outlines<br>
<br>
*facecolors*:<br>
'none' to plot unfilled outlines<br>
<br>
Here are the standard descriptions of all the<br>
:class:`~matplotlib.collections.Collection` kwargs:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================<br>
<br>
<br>
A :class:`~matplotlib.collections.Collection` instance is<br>
returned.</tt></dd></dl>
<dl><dt><a name="Axes-semilogx"><strong>semilogx</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-semilogx">semilogx</a>(*args, **kwargs)<br>
<br>
Make a plot with log scaling on the *x* axis.<br>
<br>
:func:`semilogx` supports all the keyword arguments of<br>
:func:`~matplotlib.pyplot.plot` and<br>
:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.set_xscale`.<br>
<br>
Notable keyword arguments:<br>
<br>
*basex*: scalar > 1<br>
base of the *x* logarithm<br>
<br>
*subsx*: [ None | sequence ]<br>
The location of the minor xticks; *None* defaults to<br>
autosubs, which depend on the number of decades in the<br>
plot; see :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.set_xscale` for<br>
details.<br>
<br>
The remaining valid kwargs are<br>
:class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
See :meth:`loglog` for example code and figure</tt></dd></dl>
<dl><dt><a name="Axes-semilogy"><strong>semilogy</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-semilogy">semilogy</a>(*args, **kwargs)<br>
<br>
Make a plot with log scaling on the *y* axis.<br>
<br>
:func:`semilogy` supports all the keyword arguments of<br>
:func:`~matplotlib.pylab.plot` and<br>
:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.set_yscale`.<br>
<br>
Notable keyword arguments:<br>
<br>
*basey*: scalar > 1<br>
Base of the *y* logarithm<br>
<br>
*subsy*: [ None | sequence ]<br>
The location of the minor yticks; *None* defaults to<br>
autosubs, which depend on the number of decades in the<br>
plot; see :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.set_yscale` for<br>
details.<br>
<br>
The remaining valid kwargs are<br>
:class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
See :meth:`loglog` for example code and figure</tt></dd></dl>
<dl><dt><a name="Axes-set_adjustable"><strong>set_adjustable</strong></a>(self, adjustable)</dt><dd><tt>ACCEPTS: [ 'box' | 'datalim' ]</tt></dd></dl>
<dl><dt><a name="Axes-set_anchor"><strong>set_anchor</strong></a>(self, anchor)</dt><dd><tt>*anchor*<br>
<br>
===== ============<br>
value description<br>
===== ============<br>
'C' Center<br>
'SW' bottom left<br>
'S' bottom<br>
'SE' bottom right<br>
'E' right<br>
'NE' top right<br>
'N' top<br>
'NW' top left<br>
'W' left<br>
===== ============</tt></dd></dl>
<dl><dt><a name="Axes-set_aspect"><strong>set_aspect</strong></a>(self, aspect, adjustable<font color="#909090">=None</font>, anchor<font color="#909090">=None</font>)</dt><dd><tt>*aspect*<br>
<br>
======== ================================================<br>
value description<br>
======== ================================================<br>
'auto' automatic; fill position rectangle with data<br>
'normal' same as 'auto'; deprecated<br>
'equal' same scaling from data to plot units for x and y<br>
num a circle will be stretched such that the height<br>
is num times the width. aspect=1 is the same as<br>
aspect='equal'.<br>
======== ================================================<br>
<br>
*adjustable*<br>
<br>
========= ============================<br>
value description<br>
========= ============================<br>
'box' change physical size of axes<br>
'datalim' change xlim or ylim<br>
========= ============================<br>
<br>
*anchor*<br>
<br>
===== =====================<br>
value description<br>
===== =====================<br>
'C' centered<br>
'SW' lower left corner<br>
'S' middle of bottom edge<br>
'SE' lower right corner<br>
etc.<br>
===== =====================</tt></dd></dl>
<dl><dt><a name="Axes-set_autoscale_on"><strong>set_autoscale_on</strong></a>(self, b)</dt><dd><tt>Set whether autoscaling is applied on plot commands<br>
<br>
accepts: [ *True* | *False* ]</tt></dd></dl>
<dl><dt><a name="Axes-set_axis_bgcolor"><strong>set_axis_bgcolor</strong></a>(self, color)</dt><dd><tt>set the axes background color<br>
<br>
ACCEPTS: any matplotlib color - see<br>
:func:`~matplotlib.pyplot.colors`</tt></dd></dl>
<dl><dt><a name="Axes-set_axis_off"><strong>set_axis_off</strong></a>(self)</dt><dd><tt>turn off the axis</tt></dd></dl>
<dl><dt><a name="Axes-set_axis_on"><strong>set_axis_on</strong></a>(self)</dt><dd><tt>turn on the axis</tt></dd></dl>
<dl><dt><a name="Axes-set_axisbelow"><strong>set_axisbelow</strong></a>(self, b)</dt><dd><tt>Set whether the axis ticks and gridlines are above or below most artists<br>
<br>
ACCEPTS: [ *True* | *False* ]</tt></dd></dl>
<dl><dt><a name="Axes-set_color_cycle"><strong>set_color_cycle</strong></a>(self, clist)</dt><dd><tt>Set the color cycle for any future plot commands on this <a href="#Axes">Axes</a>.<br>
<br>
clist is a list of mpl color specifiers.</tt></dd></dl>
<dl><dt><a name="Axes-set_cursor_props"><strong>set_cursor_props</strong></a>(self, *args)</dt><dd><tt>Set the cursor property as::<br>
<br>
ax.<a href="#Axes-set_cursor_props">set_cursor_props</a>(linewidth, color)<br>
<br>
or::<br>
<br>
ax.<a href="#Axes-set_cursor_props">set_cursor_props</a>((linewidth, color))<br>
<br>
ACCEPTS: a (*float*, *color*) tuple</tt></dd></dl>
<dl><dt><a name="Axes-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the class:`~matplotlib.axes.<a href="#Axes">Axes</a>` figure<br>
<br>
accepts a class:`~matplotlib.figure.Figure` instance</tt></dd></dl>
<dl><dt><a name="Axes-set_frame_on"><strong>set_frame_on</strong></a>(self, b)</dt><dd><tt>Set whether the axes rectangle patch is drawn<br>
<br>
ACCEPTS: [ *True* | *False* ]</tt></dd></dl>
<dl><dt><a name="Axes-set_navigate"><strong>set_navigate</strong></a>(self, b)</dt><dd><tt>Set whether the axes responds to navigation toolbar commands<br>
<br>
ACCEPTS: [ True | False ]</tt></dd></dl>
<dl><dt><a name="Axes-set_navigate_mode"><strong>set_navigate_mode</strong></a>(self, b)</dt><dd><tt>Set the navigation toolbar button status;<br>
<br>
.. warning::<br>
this is not a user-API function.</tt></dd></dl>
<dl><dt><a name="Axes-set_position"><strong>set_position</strong></a>(self, pos, which<font color="#909090">='both'</font>)</dt><dd><tt>Set the axes position with::<br>
<br>
pos = [left, bottom, width, height]<br>
<br>
in relative 0,1 coords, or *pos* can be a<br>
:class:`~matplotlib.transforms.Bbox`<br>
<br>
There are two position variables: one which is ultimately<br>
used, but which may be modified by :meth:`apply_aspect`, and a<br>
second which is the starting point for :meth:`apply_aspect`.<br>
<br>
<br>
Optional keyword arguments:<br>
*which*<br>
<br>
========== ====================<br>
value description<br>
========== ====================<br>
'active' to change the first<br>
'original' to change the second<br>
'both' to change both<br>
========== ====================</tt></dd></dl>
<dl><dt><a name="Axes-set_title"><strong>set_title</strong></a>(self, label, fontdict<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-set_title">set_title</a>(label, fontdict=None, **kwargs):<br>
<br>
Set the title for the axes. See the :meth:`text` for<br>
information of how override and the optional args work<br>
<br>
kwargs are Text properties:<br>
<br>
========================= =====================================================================<br>
Property Description <br>
========================= =====================================================================<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 :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color any matplotlib color <br>
contains unknown <br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br>
figure a :class:`matplotlib.figure.Figure` 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 unknown <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 <br>
========================= =====================================================================<br>
<br>
<br>
ACCEPTS: str</tt></dd></dl>
<dl><dt><a name="Axes-set_xbound"><strong>set_xbound</strong></a>(self, lower<font color="#909090">=None</font>, upper<font color="#909090">=None</font>)</dt><dd><tt>Set the lower and upper numerical bounds of the x-axis.<br>
This method will honor axes inversion regardless of parameter order.</tt></dd></dl>
<dl><dt><a name="Axes-set_xlabel"><strong>set_xlabel</strong></a>(self, xlabel, fontdict<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-set_xlabel">set_xlabel</a>(xlabel, fontdict=None, **kwargs)<br>
<br>
Set the label for the xaxis. See the :meth:`text` docstring<br>
for information of how override and the optional args work.<br>
<br>
Valid kwargs are Text properties:<br>
<br>
========================= =====================================================================<br>
Property Description <br>
========================= =====================================================================<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 :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color any matplotlib color <br>
contains unknown <br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br>
figure a :class:`matplotlib.figure.Figure` 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 unknown <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 <br>
========================= =====================================================================<br>
<br>
ACCEPTS: str</tt></dd></dl>
<dl><dt><a name="Axes-set_xlim"><strong>set_xlim</strong></a>(self, xmin<font color="#909090">=None</font>, xmax<font color="#909090">=None</font>, emit<font color="#909090">=True</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-set_xlim">set_xlim</a>(self, *args, **kwargs)<br>
<br>
Set the limits for the xaxis<br>
<br>
Returns the current xlimits as a length 2 tuple: [*xmin*, *xmax*]<br>
<br>
Examples::<br>
<br>
<a href="#Axes-set_xlim">set_xlim</a>((valmin, valmax))<br>
<a href="#Axes-set_xlim">set_xlim</a>(valmin, valmax)<br>
<a href="#Axes-set_xlim">set_xlim</a>(xmin=1) # xmax unchanged<br>
<a href="#Axes-set_xlim">set_xlim</a>(xmax=1) # xmin unchanged<br>
<br>
Keyword arguments:<br>
<br>
*ymin*: scalar<br>
the min of the ylim<br>
*ymax*: scalar<br>
the max of the ylim<br>
*emit*: [ True | False ]<br>
notify observers of lim change<br>
<br>
ACCEPTS: len(2) sequence of floats</tt></dd></dl>
<dl><dt><a name="Axes-set_xscale"><strong>set_xscale</strong></a>(self, value, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-set_xscale">set_xscale</a>(value)<br>
<br>
Set the scaling of the x-axis: 'linear' | 'log' | 'symlog'<br>
<br>
ACCEPTS: ['linear' | 'log' | 'symlog']<br>
<br>
Different kwargs are accepted, depending on the scale:<br>
'linear'<br>
<br>
<br>
<br>
<br>
<br>
'log'<br>
<br>
*basex*/*basey*:<br>
The base of the logarithm<br>
<br>
*subsx*/*subsy*:<br>
Where to place the subticks between each major tick.<br>
Should be a sequence of integers. For example, in a log10<br>
scale: ``[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]``<br>
<br>
will place 10 logarithmically spaced minor ticks between<br>
each major tick.<br>
<br>
<br>
'symlog'<br>
<br>
*basex*/*basey*:<br>
The base of the logarithm<br>
<br>
*linthreshx*/*linthreshy*:<br>
The range (-*x*, *x*) within which the plot is linear (to<br>
avoid having the plot go to infinity around zero).<br>
<br>
*subsx*/*subsy*:<br>
Where to place the subticks between each major tick.<br>
Should be a sequence of integers. For example, in a log10<br>
scale: ``[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]``<br>
<br>
will place 10 logarithmically spaced minor ticks between<br>
each major tick.</tt></dd></dl>
<dl><dt><a name="Axes-set_xticklabels"><strong>set_xticklabels</strong></a>(self, labels, fontdict<font color="#909090">=None</font>, minor<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-set_xticklabels">set_xticklabels</a>(labels, fontdict=None, minor=False, **kwargs)<br>
<br>
Set the xtick labels with list of strings *labels*. Return a<br>
list of axis text instances.<br>
<br>
*kwargs* set the :class:`~matplotlib.text.Text` properties.<br>
Valid properties are<br>
<br>
========================= =====================================================================<br>
Property Description <br>
========================= =====================================================================<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 :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color any matplotlib color <br>
contains unknown <br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br>
figure a :class:`matplotlib.figure.Figure` 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 unknown <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 <br>
========================= =====================================================================<br>
<br>
<br>
ACCEPTS: sequence of strings</tt></dd></dl>
<dl><dt><a name="Axes-set_xticks"><strong>set_xticks</strong></a>(self, ticks, minor<font color="#909090">=False</font>)</dt><dd><tt>Set the x ticks with list of *ticks*<br>
<br>
ACCEPTS: sequence of floats</tt></dd></dl>
<dl><dt><a name="Axes-set_ybound"><strong>set_ybound</strong></a>(self, lower<font color="#909090">=None</font>, upper<font color="#909090">=None</font>)</dt><dd><tt>Set the lower and upper numerical bounds of the y-axis.<br>
This method will honor axes inversion regardless of parameter order.</tt></dd></dl>
<dl><dt><a name="Axes-set_ylabel"><strong>set_ylabel</strong></a>(self, ylabel, fontdict<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-set_ylabel">set_ylabel</a>(ylabel, fontdict=None, **kwargs)<br>
<br>
Set the label for the yaxis<br>
<br>
See the :meth:`text` doctstring for information of how<br>
override and the optional args work<br>
<br>
Valid kwargs are Text properties:<br>
<br>
========================= =====================================================================<br>
Property Description <br>
========================= =====================================================================<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 :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color any matplotlib color <br>
contains unknown <br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br>
figure a :class:`matplotlib.figure.Figure` 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 unknown <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 <br>
========================= =====================================================================<br>
<br>
ACCEPTS: str</tt></dd></dl>
<dl><dt><a name="Axes-set_ylim"><strong>set_ylim</strong></a>(self, ymin<font color="#909090">=None</font>, ymax<font color="#909090">=None</font>, emit<font color="#909090">=True</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-set_ylim">set_ylim</a>(self, *args, **kwargs):<br>
<br>
Set the limits for the yaxis; v = [ymin, ymax]::<br>
<br>
<a href="#Axes-set_ylim">set_ylim</a>((valmin, valmax))<br>
<a href="#Axes-set_ylim">set_ylim</a>(valmin, valmax)<br>
<a href="#Axes-set_ylim">set_ylim</a>(ymin=1) # ymax unchanged<br>
<a href="#Axes-set_ylim">set_ylim</a>(ymax=1) # ymin unchanged<br>
<br>
Keyword arguments:<br>
<br>
*ymin*: scalar<br>
the min of the ylim<br>
*ymax*: scalar<br>
the max of the ylim<br>
*emit*: [ True | False ]<br>
notify observers of lim change<br>
<br>
Returns the current ylimits as a length 2 tuple<br>
<br>
ACCEPTS: len(2) sequence of floats</tt></dd></dl>
<dl><dt><a name="Axes-set_yscale"><strong>set_yscale</strong></a>(self, value, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-set_yscale">set_yscale</a>(value)<br>
<br>
Set the scaling of the y-axis: 'linear' | 'log' | 'symlog'<br>
<br>
ACCEPTS: ['linear' | 'log' | 'symlog']<br>
<br>
Different kwargs are accepted, depending on the scale:<br>
'linear'<br>
<br>
<br>
<br>
<br>
<br>
'log'<br>
<br>
*basex*/*basey*:<br>
The base of the logarithm<br>
<br>
*subsx*/*subsy*:<br>
Where to place the subticks between each major tick.<br>
Should be a sequence of integers. For example, in a log10<br>
scale: ``[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]``<br>
<br>
will place 10 logarithmically spaced minor ticks between<br>
each major tick.<br>
<br>
<br>
'symlog'<br>
<br>
*basex*/*basey*:<br>
The base of the logarithm<br>
<br>
*linthreshx*/*linthreshy*:<br>
The range (-*x*, *x*) within which the plot is linear (to<br>
avoid having the plot go to infinity around zero).<br>
<br>
*subsx*/*subsy*:<br>
Where to place the subticks between each major tick.<br>
Should be a sequence of integers. For example, in a log10<br>
scale: ``[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]``<br>
<br>
will place 10 logarithmically spaced minor ticks between<br>
each major tick.</tt></dd></dl>
<dl><dt><a name="Axes-set_yticklabels"><strong>set_yticklabels</strong></a>(self, labels, fontdict<font color="#909090">=None</font>, minor<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-set_yticklabels">set_yticklabels</a>(labels, fontdict=None, minor=False, **kwargs)<br>
<br>
Set the ytick labels with list of strings *labels*. Return a list of<br>
:class:`~matplotlib.text.Text` instances.<br>
<br>
*kwargs* set :class:`~matplotlib.text.Text` properties for the labels.<br>
Valid properties are<br>
<br>
========================= =====================================================================<br>
Property Description <br>
========================= =====================================================================<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 :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color any matplotlib color <br>
contains unknown <br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br>
figure a :class:`matplotlib.figure.Figure` 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 unknown <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 <br>
========================= =====================================================================<br>
<br>
<br>
ACCEPTS: sequence of strings</tt></dd></dl>
<dl><dt><a name="Axes-set_yticks"><strong>set_yticks</strong></a>(self, ticks, minor<font color="#909090">=False</font>)</dt><dd><tt>Set the y ticks with list of *ticks*<br>
<br>
ACCEPTS: sequence of floats<br>
<br>
Keyword arguments:<br>
<br>
*minor*: [ False | True ]<br>
Sets the minor ticks if True</tt></dd></dl>
<dl><dt><a name="Axes-specgram"><strong>specgram</strong></a>(self, x, NFFT<font color="#909090">=256</font>, Fs<font color="#909090">=2</font>, Fc<font color="#909090">=0</font>, detrend<font color="#909090">=<function detrend_none at 0x26b5ed8></font>, window<font color="#909090">=<function window_hanning at 0x26b5578></font>, noverlap<font color="#909090">=128</font>, cmap<font color="#909090">=None</font>, xextent<font color="#909090">=None</font>)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-specgram">specgram</a>(x, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,<br>
window = mlab.window_hanning, noverlap=128,<br>
cmap=None, xextent=None)<br>
<br>
Compute a spectrogram of data in *x*. Data are split into<br>
*NFFT* length segments and the PSD of each section is<br>
computed. The windowing function *window* is applied to each<br>
segment, and the amount of overlap of each segment is<br>
specified with *noverlap*.<br>
<br>
Keyword arguments:<br>
<br>
*cmap*:<br>
A :class:`matplotlib.cm.Colormap` instance; if *None* use<br>
default determined by rc<br>
<br>
*xextent*:<br>
The image extent in the xaxes xextent=xmin, xmax<br>
default 0, max(bins), 0, max(freqs) where bins is the return<br>
value from mlab.specgram<br>
<br>
See :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.psd` for information on the<br>
other keyword arguments.<br>
<br>
Return value is (*Pxx*, *freqs*, *bins*, *im*):<br>
<br>
- *bins* are the time points the spectrogram is calculated over<br>
- *freqs* is an array of frequencies<br>
- *Pxx* is a len(times) x len(freqs) array of power<br>
- *im* is a :class:`matplotlib.image.AxesImage` instance<br>
<br>
Note: If *x* is real (i.e. non-complex), only the positive<br>
spectrum is shown. If *x* is complex, both positive and<br>
negative parts of the spectrum are shown.</tt></dd></dl>
<dl><dt><a name="Axes-spy"><strong>spy</strong></a>(self, Z, precision<font color="#909090">=None</font>, marker<font color="#909090">=None</font>, markersize<font color="#909090">=None</font>, aspect<font color="#909090">='equal'</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-spy">spy</a>(Z, precision=None, marker=None, markersize=None,<br>
aspect='equal', **kwargs)<br>
<br>
``<a href="#Axes-spy">spy</a>(Z)`` plots the sparsity pattern of the 2-D array *Z*.<br>
<br>
If *precision* is *None*, any non-zero value will be plotted;<br>
else, values of :math:`|Z| > precision` will be plotted.<br>
<br>
The array will be plotted as it would be printed, with<br>
the first index (row) increasing down and the second<br>
index (column) increasing to the right.<br>
<br>
By default aspect is 'equal', so that each array element<br>
occupies a square space; set the aspect kwarg to 'auto'<br>
to allow the plot to fill the plot box, or to any scalar<br>
number to specify the aspect ratio of an array element<br>
directly.<br>
<br>
Two plotting styles are available: image or marker. Both<br>
are available for full arrays, but only the marker style<br>
works for :class:`scipy.sparse.spmatrix` instances.<br>
<br>
If *marker* and *markersize* are *None*, an image will be<br>
returned and any remaining kwargs are passed to<br>
:func:`~matplotlib.pyplot.imshow`; else, a<br>
:class:`~matplotlib.lines.Line2D` object will be returned with<br>
the value of marker determining the marker type, and any<br>
remaining kwargs passed to the<br>
:meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.plot` method.<br>
<br>
If *marker* and *markersize* are *None*, useful kwargs include:<br>
<br>
* *cmap*<br>
* *alpha*<br>
<br>
See documentation for :func:`~matplotlib.pyplot.imshow` for details.<br>
<br>
For controlling colors, e.g. cyan background and red marks,<br>
use::<br>
<br>
cmap = mcolors.ListedColormap(['c','r'])<br>
<br>
If *marker* or *markersize* is not *None*, useful kwargs include:<br>
<br>
* *marker*<br>
* *markersize*<br>
* *color*<br>
<br>
See documentation for :func:`~matplotlib.pyplot.plot` for details.<br>
<br>
Useful values for *marker* include:<br>
<br>
* 's' square (default)<br>
* 'o' circle<br>
* '.' point<br>
* ',' pixel</tt></dd></dl>
<dl><dt><a name="Axes-start_pan"><strong>start_pan</strong></a>(self, x, y, button)</dt><dd><tt>Called when a pan operation has started.<br>
<br>
*x*, *y* are the mouse coordinates in display coords.<br>
button is the mouse button number:<br>
<br>
* 1: LEFT<br>
* 2: MIDDLE<br>
* 3: RIGHT<br>
<br>
.. note::<br>
Intended to be overridden by new projection types.</tt></dd></dl>
<dl><dt><a name="Axes-stem"><strong>stem</strong></a>(self, x, y, linefmt<font color="#909090">='b-'</font>, markerfmt<font color="#909090">='bo'</font>, basefmt<font color="#909090">='r-'</font>)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-stem">stem</a>(x, y, linefmt='b-', markerfmt='bo', basefmt='r-')<br>
<br>
A stem plot plots vertical lines (using *linefmt*) at each *x*<br>
location from the baseline to *y*, and places a marker there<br>
using *markerfmt*. A horizontal line at 0 is is plotted using<br>
*basefmt*.<br>
<br>
Return value is a tuple (*markerline*, *stemlines*,<br>
*baseline*).<br>
<br>
See `this document<br>
<<a href="http://www.mathworks.com/access/helpdesk/help/techdoc/ref/stem.html>`_">http://www.mathworks.com/access/helpdesk/help/techdoc/ref/stem.html>`_</a><br>
for details and :file:`examples/pylab_examples/stem_plot.py` for a demo.</tt></dd></dl>
<dl><dt><a name="Axes-step"><strong>step</strong></a>(self, x, y, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-step">step</a>(x, y, *args, **kwargs)<br>
<br>
Make a step plot. Additional keyword args to :func:`step` are the same<br>
as those for :func:`~matplotlib.pyplot.plot`.<br>
<br>
*x* and *y* must be 1-D sequences, and it is assumed, but not checked,<br>
that *x* is uniformly increasing.<br>
<br>
Keyword arguments:<br>
<br>
*where*: [ 'pre' | 'post' | 'mid' ]<br>
If 'pre', the interval from x[i] to x[i+1] has level y[i]<br>
<br>
If 'post', that interval has level y[i+1]<br>
<br>
If 'mid', the jumps in *y* occur half-way between the<br>
*x*-values.</tt></dd></dl>
<dl><dt><a name="Axes-table"><strong>table</strong></a>(self, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-table">table</a>(cellText=None, cellColours=None,<br>
cellLoc='right', colWidths=None,<br>
rowLabels=None, rowColours=None, rowLoc='left',<br>
colLabels=None, colColours=None, colLoc='center',<br>
loc='bottom', bbox=None):<br>
<br>
Add a table to the current axes. Returns a<br>
:class:`matplotlib.table.Table` instance. For finer grained<br>
control over tables, use the :class:`~matplotlib.table.Table`<br>
class and add it to the axes with<br>
:meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.add_table`.<br>
<br>
Thanks to John Gill for providing the class and table.<br>
<br>
kwargs control the :class:`~matplotlib.table.Table`<br>
properties:<br>
<br>
<br>
========= ===============================================<br>
Property Description <br>
========= ===============================================<br>
alpha float <br>
animated [True | False] <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a<br>
contains unknown <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fontsize a float in points <br>
label any string <br>
lod [True | False] <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
========= ===============================================</tt></dd></dl>
<dl><dt><a name="Axes-text"><strong>text</strong></a>(self, x, y, s, fontdict<font color="#909090">=None</font>, withdash<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-text">text</a>(x, y, s, fontdict=None, **kwargs)<br>
<br>
Add text in string *s* to axis at location *x*, *y*, data<br>
coordinates.<br>
<br>
Keyword arguments:<br>
<br>
*fontdict*:<br>
A dictionary to override the default text properties.<br>
If *fontdict* is *None*, the defaults are determined by your rc<br>
parameters.<br>
<br>
*withdash*: [ False | True ]<br>
Creates a :class:`~matplotlib.text.TextWithDash` instance<br>
instead of a :class:`~matplotlib.text.Text` instance.<br>
<br>
Individual keyword arguments can be used to override any given<br>
parameter::<br>
<br>
<a href="#Axes-text">text</a>(x, y, s, fontsize=12)<br>
<br>
The default transform specifies that text is in data coords,<br>
alternatively, you can specify text in axis coords (0,0 is<br>
lower-left and 1,1 is upper-right). The example below places<br>
text in the center of the axes::<br>
<br>
<a href="#Axes-text">text</a>(0.5, 0.5,'matplotlib',<br>
horizontalalignment='center',<br>
verticalalignment='center',<br>
transform = ax.transAxes)<br>
<br>
You can put a rectangular box around the text instance (eg. to<br>
set a background color) by using the keyword *bbox*. *bbox* is<br>
a dictionary of :class:`matplotlib.patches.Rectangle`<br>
properties. For example::<br>
<br>
<a href="#Axes-text">text</a>(x, y, s, bbox=dict(facecolor='red', alpha=0.5))<br>
<br>
Valid kwargs are :class:`matplotlib.text.Text` properties:<br>
<br>
<br>
========================= =====================================================================<br>
Property Description <br>
========================= =====================================================================<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 :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color any matplotlib color <br>
contains unknown <br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br>
figure a :class:`matplotlib.figure.Figure` 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 unknown <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 <br>
========================= =====================================================================</tt></dd></dl>
<dl><dt><a name="Axes-ticklabel_format"><strong>ticklabel_format</strong></a>(self, **kwargs)</dt><dd><tt>Convenience method for manipulating the ScalarFormatter<br>
used by default for linear axes.<br>
<br>
Optional keyword arguments:<br>
<br>
======= =====================================<br>
Keyword Description<br>
======= =====================================<br>
*style* [ 'sci' (or 'scientific') | 'plain' ]<br>
plain turns off scientific notation<br>
*axis* [ 'x' | 'y' | 'both' ]<br>
======= =====================================<br>
<br>
Only the major ticks are affected.<br>
If the method is called when the<br>
:class:`~matplotlib.ticker.ScalarFormatter` is not the<br>
:class:`~matplotlib.ticker.Formatter` being used, an<br>
:exc:`AttributeError` will be raised with no additional error<br>
message.<br>
<br>
Additional capabilities and/or friendlier error checking may<br>
be added.</tt></dd></dl>
<dl><dt><a name="Axes-twinx"><strong>twinx</strong></a>(self)</dt><dd><tt>call signature::<br>
<br>
ax = <a href="#Axes-twinx">twinx</a>()<br>
<br>
create a twin of <a href="#Axes">Axes</a> for generating a plot with a sharex<br>
x-axis but independent y axis. The y-axis of self will have<br>
ticks on left and the returned axes will have ticks on the<br>
right</tt></dd></dl>
<dl><dt><a name="Axes-twiny"><strong>twiny</strong></a>(self)</dt><dd><tt>call signature::<br>
<br>
ax = <a href="#Axes-twiny">twiny</a>()<br>
<br>
create a twin of <a href="#Axes">Axes</a> for generating a plot with a shared<br>
y-axis but independent x axis. The x-axis of self will have<br>
ticks on bottom and the returned axes will have ticks on the<br>
top</tt></dd></dl>
<dl><dt><a name="Axes-update_datalim"><strong>update_datalim</strong></a>(self, xys)</dt><dd><tt>Update the data lim bbox with seq of xy tups or equiv. 2-D array</tt></dd></dl>
<dl><dt><a name="Axes-update_datalim_bounds"><strong>update_datalim_bounds</strong></a>(self, bounds)</dt><dd><tt>Update the datalim to include the given<br>
:class:`~matplotlib.transforms.Bbox` *bounds*</tt></dd></dl>
<dl><dt><a name="Axes-update_datalim_numerix"><strong>update_datalim_numerix</strong></a>(self, x, y)</dt><dd><tt>Update the data lim bbox with seq of xy tups</tt></dd></dl>
<dl><dt><a name="Axes-vlines"><strong>vlines</strong></a>(self, x, ymin, ymax, colors<font color="#909090">='k'</font>, linestyles<font color="#909090">='solid'</font>, label<font color="#909090">=''</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-vlines">vlines</a>(x, ymin, ymax, color='k')<br>
<br>
Plot vertical lines at each *x* from *ymin* to *ymax*. *ymin*<br>
or *ymax* can be scalars or len(*x*) numpy arrays. If they are<br>
scalars, then the respective values are constant, else the<br>
heights of the lines are determined by *ymin* and *ymax*.<br>
<br>
*colors* is a line collections color args, either a single color<br>
or a len(*x*) list of colors<br>
<br>
*linestyle* is one of [ 'solid' | 'dashed' | 'dashdot' | 'dotted' ]<br>
<br>
Returns the :class:`matplotlib.collections.LineCollection`<br>
that was added.<br>
<br>
kwargs are :class:`~matplotlib.collections.LineCollection` properties:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
segments unknown <br>
transform unknown <br>
verts unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================</tt></dd></dl>
<dl><dt><a name="Axes-xaxis_date"><strong>xaxis_date</strong></a>(self, tz<font color="#909090">=None</font>)</dt><dd><tt>Sets up x-axis ticks and labels that treat the x data as dates.<br>
<br>
*tz* is the time zone to use in labeling dates. Defaults to rc value.</tt></dd></dl>
<dl><dt><a name="Axes-xaxis_inverted"><strong>xaxis_inverted</strong></a>(self)</dt><dd><tt>Returns True if the x-axis is inverted.</tt></dd></dl>
<dl><dt><a name="Axes-xcorr"><strong>xcorr</strong></a>(self, x, y, normed<font color="#909090">=False</font>, detrend<font color="#909090">=<function detrend_none at 0x26b5ed8></font>, usevlines<font color="#909090">=False</font>, maxlags<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Axes-xcorr">xcorr</a>(x, y, normed=False, detrend=mlab.detrend_none,<br>
usevlines=False, **kwargs):<br>
<br>
Plot the cross correlation between *x* and *y*. If *normed* =<br>
*True*, normalize the data but the cross correlation at 0-th<br>
lag. *x* and y are detrended by the *detrend* callable<br>
(default no normalization). *x* and *y* must be equal length.<br>
<br>
Data are plotted as ``<a href="#Axes-plot">plot</a>(lags, c, **kwargs)``<br>
<br>
Return value is a tuple (*lags*, *c*, *line*) where:<br>
<br>
- *lags* are a length ``2*maxlags+1`` lag vector<br>
<br>
- *c* is the ``2*maxlags+1`` auto correlation vector<br>
<br>
- *line* is a :class:`~matplotlib.lines.Line2D` instance<br>
returned by :func:`~matplotlib.pyplot.plot`.<br>
<br>
The default *linestyle* is *None* and the default *marker* is<br>
'o', though these can be overridden with keyword args. The<br>
cross correlation is performed with :func:`numpy.correlate`<br>
with *mode* = 2.<br>
<br>
If *usevlines* is *True*:<br>
<br>
:func:`~matplotlib.pyplot.vlines`<br>
rather than :func:`~matplotlib.pyplot.plot` is used to draw<br>
vertical lines from the origin to the xcorr. Otherwise the<br>
plotstyle is determined by the kwargs, which are<br>
:class:`~matplotlib.lines.Line2D` properties.<br>
<br>
The return value is a tuple (*lags*, *c*, *linecol*, *b*)<br>
where *linecol* is the<br>
:class:`matplotlib.collections.LineCollection` instance and<br>
*b* is the *x*-axis.<br>
<br>
*maxlags* is a positive integer detailing the number of lags to show.<br>
The default value of *None* will return all ``(2*len(x)-1)`` lags.<br>
<br>
**Example:**<br>
<br>
:func:`~matplotlib.pyplot.xcorr` above, and<br>
:func:`~matplotlib.pyplot.acorr` below.<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/xcorr_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-yaxis_date"><strong>yaxis_date</strong></a>(self, tz<font color="#909090">=None</font>)</dt><dd><tt>Sets up y-axis ticks and labels that treat the y data as dates.<br>
<br>
*tz* is the time zone to use in labeling dates. Defaults to rc value.</tt></dd></dl>
<dl><dt><a name="Axes-yaxis_inverted"><strong>yaxis_inverted</strong></a>(self)</dt><dd><tt>Returns True if the y-axis is inverted.</tt></dd></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>name</strong> = 'rectilinear'</dl>
<dl><dt><strong>x</strong> = 'symlog'</dl>
<hr>
Methods inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><a name="Axes-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Axes-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="Axes-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="Axes-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Axes-findobj">findobj</a>(o=gcf(), match=None) <br>
<br>
recursively find all :class:matplotlib.artist.<a href="matplotlib.artist.html#Artist">Artist</a> instances<br>
contained in self<br>
<br>
*match* can be<br>
<br>
- None: return all objects contained in artist (including artist)<br>
<br>
- function with signature ``boolean = match(artist)`` used to filter matches<br>
<br>
- class instance: eg Line2D. Only return artists of class type<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/findobj_demo.py</tt></dd></dl>
<dl><dt><a name="Axes-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="Axes-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Axes-get_axes"><strong>get_axes</strong></a>(self)</dt><dd><tt>return the axes instance the artist resides in, or *None*</tt></dd></dl>
<dl><dt><a name="Axes-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Axes-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="Axes-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Axes-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="Axes-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>Return the :class:`~matplotlib.figure.Figure` instance the<br>
artist belongs to.</tt></dd></dl>
<dl><dt><a name="Axes-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Axes-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="Axes-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>Return the :class:`~matplotlib.transforms.Transform`<br>
instance used by this artist.</tt></dd></dl>
<dl><dt><a name="Axes-get_transformed_clip_path_and_affine"><strong>get_transformed_clip_path_and_affine</strong></a>(self)</dt><dd><tt>Return the clip path with the non-affine part of its<br>
transformation applied, and the remaining affine part of its<br>
transformation.</tt></dd></dl>
<dl><dt><a name="Axes-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Axes-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Axes-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="Axes-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="Axes-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Axes-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="Axes-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Axes-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Axes-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect<br>
will not be visible until the figure is redrawn, e.g., with<br>
:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.draw_idle`. Call<br>
:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.relim` to update the axes limits<br>
if desired.<br>
<br>
Note: :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.relim` will not see<br>
collections even if the collection was added to axes with<br>
*autolim* = True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="Axes-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Axes-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="Axes-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="Axes-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="Axes-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance in which the artist resides, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="Axes-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
ACCEPTS: a :class:`matplotlib.transform.Bbox` instance</tt></dd></dl>
<dl><dt><a name="Axes-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="Axes-set_clip_path"><strong>set_clip_path</strong></a>(self, path, transform<font color="#909090">=None</font>)</dt><dd><tt>Set the artist's clip path, which may be:<br>
<br>
* a :class:`~matplotlib.patches.Patch` (or subclass) instance<br>
<br>
* a :class:`~matplotlib.path.Path` instance, in which case<br>
an optional :class:`~matplotlib.transforms.Transform`<br>
instance may be provided, which will be applied to the<br>
path before using it for clipping.<br>
<br>
* *None*, to remove the clipping path<br>
<br>
For efficiency, if the path happens to be an axis-aligned<br>
rectangle, this method will set the clipping box to the<br>
corresponding rectangle and set the clipping path to *None*.<br>
<br>
ACCEPTS: a :class:`~matplotlib.path.Path` instance and a<br>
:class:`~matplotlib.transforms.Transform` instance, a<br>
:class:`~matplotlib.patches.Patch` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="Axes-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="Axes-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="Axes-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="Axes-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>
* A 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>
* A float: if picker is a number it is interpreted as an<br>
epsilon tolerance in points and 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, e.g. the indices of the data within<br>
epsilon of the pick event<br>
<br>
* A 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="Axes-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>Set the :class:`~matplotlib.transforms.Transform` instance<br>
used by this artist.</tt></dd></dl>
<dl><dt><a name="Axes-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="Axes-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="Axes-update"><strong>update</strong></a>(self, props)</dt></dl>
<dl><dt><a name="Axes-update_from"><strong>update_from</strong></a>(self, other)</dt><dd><tt>Copy properties from *other* to *self*.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</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"><strong>Subplot</strong> = <a name="Subplot">class AxesSubplot</a>(<a href="matplotlib.axes.html#SubplotBase">SubplotBase</a>, <a href="matplotlib.axes.html#Axes">Axes</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd>AxesSubplot</dd>
<dd><a href="matplotlib.axes.html#SubplotBase">SubplotBase</a></dd>
<dd><a href="matplotlib.axes.html#Axes">Axes</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods inherited from <a href="matplotlib.axes.html#SubplotBase">SubplotBase</a>:<br>
<dl><dt><a name="AxesSubplot-__init__"><strong>__init__</strong></a>(self, fig, *args, **kwargs)</dt><dd><tt>fig is a figure instance<br>
<br>
args is numRows, numCols, plotNum<br>
where the array of subplots in the figure has dimensions<br>
numRows, numCols, and where plotNum is the number of the<br>
subplot being created. plotNum starts at 1 in the upper<br>
right corner and increases to the right.<br>
<br>
If numRows<=numCols<=plotNum<10, args can be the decimal<br>
integer numRows*100 + numCols*10 + plotNum.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-change_geometry"><strong>change_geometry</strong></a>(self, numrows, numcols, num)</dt><dd><tt>change subplot geometry, eg from 1,1,1 to 2,2,3</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_geometry"><strong>get_geometry</strong></a>(self)</dt><dd><tt>get the subplot geometry, eg 2,2,3</tt></dd></dl>
<dl><dt><a name="AxesSubplot-is_first_col"><strong>is_first_col</strong></a>(self)</dt></dl>
<dl><dt><a name="AxesSubplot-is_first_row"><strong>is_first_row</strong></a>(self)</dt></dl>
<dl><dt><a name="AxesSubplot-is_last_col"><strong>is_last_col</strong></a>(self)</dt></dl>
<dl><dt><a name="AxesSubplot-is_last_row"><strong>is_last_row</strong></a>(self)</dt></dl>
<dl><dt><a name="AxesSubplot-label_outer"><strong>label_outer</strong></a>(self)</dt><dd><tt>set the visible property on ticklabels so xticklabels are<br>
visible only if the subplot is in the last row and yticklabels<br>
are visible only if the subplot is in the first column</tt></dd></dl>
<dl><dt><a name="AxesSubplot-update_params"><strong>update_params</strong></a>(self)</dt><dd><tt>update the subplot position from fig.subplotpars</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.axes.html#Axes">Axes</a>:<br>
<dl><dt><a name="AxesSubplot-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="AxesSubplot-acorr"><strong>acorr</strong></a>(self, x, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-acorr">acorr</a>(x, normed=False, detrend=mlab.detrend_none, usevlines=False,<br>
maxlags=None, **kwargs)<br>
<br>
Plot the autocorrelation of *x*. If *normed* = *True*,<br>
normalize the data but the autocorrelation at 0-th lag. *x* is<br>
detrended by the *detrend* callable (default no normalization).<br>
<br>
Data are plotted as ``<a href="#Subplot-plot">plot</a>(lags, c, **kwargs)``<br>
<br>
Return value is a tuple (*lags*, *c*, *line*) where:<br>
<br>
- *lags* are a length 2*maxlags+1 lag vector<br>
<br>
- *c* is the 2*maxlags+1 auto correlation vector<br>
<br>
- *line* is a :class:`~matplotlib.lines.Line2D` instance<br>
returned by :meth:`plot`<br>
<br>
The default *linestyle* is None and the default *marker* is<br>
``'o'``, though these can be overridden with keyword args.<br>
The cross correlation is performed with :func:`numpy.correlate` with<br>
*mode* = 2.<br>
<br>
If *usevlines* is *True*, :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.vlines`<br>
rather than :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.plot` is used to draw<br>
vertical lines from the origin to the acorr. Otherwise, the<br>
plot style is determined by the kwargs, which are<br>
:class:`~matplotlib.lines.Line2D` properties. The return<br>
value is a tuple (*lags*, *c*, *linecol*, *b*) where<br>
<br>
- *linecol* is the<br>
:class:`~matplotlib.collections.LineCollection`<br>
<br>
- *b* is the *x*-axis.<br>
<br>
*maxlags* is a positive integer detailing the number of lags<br>
to show. The default value of *None* will return all<br>
``(2*len(x)-1)`` lags.<br>
<br>
See the respective :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.plot` or<br>
:meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.vlines` functions for<br>
documentation on valid kwargs.<br>
<br>
**Example:**<br>
<br>
:func:`~matplotlib.pyplot.xcorr` above, and<br>
:func:`~matplotlib.pyplot.acorr` below.<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/xcorr_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-add_artist"><strong>add_artist</strong></a>(self, a)</dt><dd><tt>Add any :class:`~matplotlib.artist.<a href="matplotlib.artist.html#Artist">Artist</a>` to the axes</tt></dd></dl>
<dl><dt><a name="AxesSubplot-add_collection"><strong>add_collection</strong></a>(self, collection, autolim<font color="#909090">=True</font>)</dt><dd><tt>add a :class:`~matplotlib.collections.Collection` instance<br>
to the axes</tt></dd></dl>
<dl><dt><a name="AxesSubplot-add_line"><strong>add_line</strong></a>(self, line)</dt><dd><tt>Add a :class:`~matplotlib.lines.Line2D` to the list of plot<br>
lines</tt></dd></dl>
<dl><dt><a name="AxesSubplot-add_patch"><strong>add_patch</strong></a>(self, p)</dt><dd><tt>Add a :class:`~matplotlib.patches.Patch` *p* to the list of<br>
axes patches; the clipbox will be set to the <a href="#Axes">Axes</a> clipping<br>
box. If the transform is not set, it will be set to<br>
:attr:`transData`.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-add_table"><strong>add_table</strong></a>(self, tab)</dt><dd><tt>Add a :class:`~matplotlib.tables.Table` instance to the<br>
list of axes tables</tt></dd></dl>
<dl><dt><a name="AxesSubplot-annotate"><strong>annotate</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-annotate">annotate</a>(s, xy, xytext=None, xycoords='data',<br>
textcoords='data', arrowprops=None, **kwargs)<br>
<br>
Keyword arguments:<br>
<br>
Annotate the *x*, *y* point *xy* with text *s* at *x*, *y*<br>
location *xytext*. (If *xytext* = *None*, defaults to *xy*,<br>
and if *textcoords* = *None*, defaults to *xycoords*).<br>
<br>
*arrowprops*, if not *None*, is a dictionary of line properties<br>
(see :class:`matplotlib.lines.Line2D`) for the arrow that connects<br>
annotation to the point. Valid keys are<br>
<br>
========= ===========================================================<br>
Key Description<br>
========= ===========================================================<br>
width the width of the arrow in points<br>
frac the fraction of the arrow length occupied by the head<br>
headwidth the width of the base of the arrow head in points<br>
shrink oftentimes it is convenient to have the arrowtip<br>
and base a bit away from the text and point being<br>
annotated. If *d* is the distance between the text and<br>
annotated point, shrink will shorten the arrow so the tip<br>
and base are shink percent of the distance *d* away from the<br>
endpoints. ie, ``shrink=0.05 is 5%``<br>
? any key for :class:`matplotlib.patches.polygon`<br>
========= ===========================================================<br>
<br>
*xycoords* and *textcoords* are strings that indicate the<br>
coordinates of *xy* and *xytext*.<br>
<br>
================= ===================================================<br>
Property Description<br>
================= ===================================================<br>
'figure points' points from the lower left corner of the figure<br>
'figure pixels' pixels from the lower left corner of the figure<br>
'figure fraction' 0,0 is lower left of figure and 1,1 is upper, right<br>
'axes points' points from lower left corner of axes<br>
'axes pixels' pixels from lower left corner of axes<br>
'axes fraction' 0,1 is lower left of axes and 1,1 is upper right<br>
'data' use the coordinate system of the object being<br>
annotated (default)<br>
'offset points' Specify an offset (in points) from the *xy* value<br>
<br>
'polar' you can specify *theta*, *r* for the annotation,<br>
even in cartesian plots. Note that if you<br>
are using a polar axes, you do not need<br>
to specify polar for the coordinate<br>
system since that is the native "data" coordinate<br>
system.<br>
================= ===================================================<br>
<br>
If a 'points' or 'pixels' option is specified, values will be<br>
added to the bottom-left and if negative, values will be<br>
subtracted from the top-right. Eg::<br>
<br>
# 10 points to the right of the left border of the axes and<br>
# 5 points below the top border<br>
xy=(10,-5), xycoords='axes points'<br>
<br>
Additional kwargs are Text properties:<br>
<br>
<br>
========================= =====================================================================<br>
Property Description <br>
========================= =====================================================================<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 :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color any matplotlib color <br>
contains unknown <br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br>
figure a :class:`matplotlib.figure.Figure` 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 unknown <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 <br>
========================= =====================================================================</tt></dd></dl>
<dl><dt><a name="AxesSubplot-apply_aspect"><strong>apply_aspect</strong></a>(self, position<font color="#909090">=None</font>)</dt><dd><tt>Use :meth:`_aspect` and :meth:`_adjustable` to modify the<br>
axes box or the view limits.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-arrow"><strong>arrow</strong></a>(self, x, y, dx, dy, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-arrow">arrow</a>(x, y, dx, dy, **kwargs)<br>
<br>
Draws arrow on specified axis from (*x*, *y*) to (*x* + *dx*,<br>
*y* + *dy*).<br>
<br>
Optional kwargs control the arrow properties:<br>
<br>
=========== ===========================================================<br>
Property Description <br>
=========== ===========================================================<br>
aa [True | False] or None for default <br>
alpha float <br>
animated [True | False] <br>
antialiased [True | False] or None for default <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
contains unknown <br>
ec mpl color spec, or None for default, or 'none' for no color<br>
edgecolor mpl color spec, or None for default, or 'none' for no color<br>
facecolor mpl color spec, or None for default, or 'none' for no color<br>
fc mpl color spec, or None for default, or 'none' for no color<br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fill [True | False] <br>
hatch unknown <br>
label any string <br>
linestyle ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
linewidth float or None for default <br>
lod [True | False] <br>
ls ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
lw float or None for default <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
=========== ===========================================================<br>
<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/arrow_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-autoscale_view"><strong>autoscale_view</strong></a>(self, tight<font color="#909090">=False</font>, scalex<font color="#909090">=True</font>, scaley<font color="#909090">=True</font>)</dt><dd><tt>autoscale the view limits using the data limits. You can<br>
selectively autoscale only a single axis, eg, the xaxis by<br>
setting *scaley* to *False*. The autoscaling preserves any<br>
axis direction reversal that has already been done.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-axhline"><strong>axhline</strong></a>(self, y<font color="#909090">=0</font>, xmin<font color="#909090">=0</font>, xmax<font color="#909090">=1</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-axhline">axhline</a>(y=0, xmin=0, xmax=1, **kwargs)<br>
<br>
Axis Horizontal Line<br>
<br>
Draw a horizontal line at *y* from *xmin* to *xmax*. With the<br>
default values of *xmin* = 0 and *xmax* = 1, this line will<br>
always span the horizontal extent of the axes, regardless of<br>
the xlim settings, even if you change them, eg. with the<br>
:meth:`set_xlim` command. That is, the horizontal extent is<br>
in axes coords: 0=left, 0.5=middle, 1.0=right but the *y*<br>
location is in data coordinates.<br>
<br>
Return value is the :class:`~matplotlib.lines.Line2D`<br>
instance. kwargs are the same as kwargs to plot, and can be<br>
used to control the line properties. Eg.,<br>
<br>
* draw a thick red hline at *y* = 0 that spans the xrange<br>
<br>
>>> <a href="#Subplot-axhline">axhline</a>(linewidth=4, color='r')<br>
<br>
* draw a default hline at *y* = 1 that spans the xrange<br>
<br>
>>> <a href="#Subplot-axhline">axhline</a>(y=1)<br>
<br>
* draw a default hline at *y* = .5 that spans the the middle half of<br>
the xrange<br>
<br>
>>> <a href="#Subplot-axhline">axhline</a>(y=.5, xmin=0.25, xmax=0.75)<br>
<br>
Valid kwargs are :class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
See :meth:`axhspan` for example plot and source code</tt></dd></dl>
<dl><dt><a name="AxesSubplot-axhspan"><strong>axhspan</strong></a>(self, ymin, ymax, xmin<font color="#909090">=0</font>, xmax<font color="#909090">=1</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-axhspan">axhspan</a>(ymin, ymax, xmin=0, xmax=1, **kwargs)<br>
<br>
Axis Horizontal Span.<br>
<br>
*y* coords are in data units and *x* coords are in axes (relative<br>
0-1) units.<br>
<br>
Draw a horizontal span (rectangle) from *ymin* to *ymax*.<br>
With the default values of *xmin* = 0 and *xmax* = 1, this<br>
always span the xrange, regardless of the xlim settings, even<br>
if you change them, eg. with the :meth:`set_xlim` command.<br>
That is, the horizontal extent is in axes coords: 0=left,<br>
0.5=middle, 1.0=right but the *y* location is in data<br>
coordinates.<br>
<br>
Return value is a :class:`matplotlib.patches.Polygon`<br>
instance.<br>
<br>
Examples:<br>
<br>
* draw a gray rectangle from *y* = 0.25-0.75 that spans the<br>
horizontal extent of the axes<br>
<br>
>>> <a href="#Subplot-axhspan">axhspan</a>(0.25, 0.75, facecolor='0.5', alpha=0.5)<br>
<br>
Valid kwargs are :class:`~matplotlib.patches.Polygon` properties:<br>
<br>
<br>
=========== ===========================================================<br>
Property Description <br>
=========== ===========================================================<br>
aa [True | False] or None for default <br>
alpha float <br>
animated [True | False] <br>
antialiased [True | False] or None for default <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
contains unknown <br>
ec mpl color spec, or None for default, or 'none' for no color<br>
edgecolor mpl color spec, or None for default, or 'none' for no color<br>
facecolor mpl color spec, or None for default, or 'none' for no color<br>
fc mpl color spec, or None for default, or 'none' for no color<br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fill [True | False] <br>
hatch unknown <br>
label any string <br>
linestyle ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
linewidth float or None for default <br>
lod [True | False] <br>
ls ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
lw float or None for default <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
=========== ===========================================================<br>
<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/axhspan_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-axis"><strong>axis</strong></a>(self, *v, **kwargs)</dt><dd><tt>Convenience method for manipulating the x and y view limits<br>
and the aspect ratio of the plot.<br>
<br>
*kwargs* are passed on to :meth:`set_xlim` and<br>
:meth:`set_ylim`</tt></dd></dl>
<dl><dt><a name="AxesSubplot-axvline"><strong>axvline</strong></a>(self, x<font color="#909090">=0</font>, ymin<font color="#909090">=0</font>, ymax<font color="#909090">=1</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-axvline">axvline</a>(x=0, ymin=0, ymax=1, **kwargs)<br>
<br>
Axis Vertical Line<br>
<br>
Draw a vertical line at *x* from *ymin* to *ymax*. With the<br>
default values of *ymin* = 0 and *ymax* = 1, this line will<br>
always span the vertical extent of the axes, regardless of the<br>
xlim settings, even if you change them, eg. with the<br>
:meth:`set_xlim` command. That is, the vertical extent is in<br>
axes coords: 0=bottom, 0.5=middle, 1.0=top but the *x* location<br>
is in data coordinates.<br>
<br>
Return value is the :class:`~matplotlib.lines.Line2D`<br>
instance. kwargs are the same as kwargs to plot, and can be<br>
used to control the line properties. Eg.,<br>
<br>
* draw a thick red vline at *x* = 0 that spans the yrange<br>
<br>
>>> <a href="#Subplot-axvline">axvline</a>(linewidth=4, color='r')<br>
<br>
* draw a default vline at *x* = 1 that spans the yrange<br>
<br>
>>> <a href="#Subplot-axvline">axvline</a>(x=1)<br>
<br>
* draw a default vline at *x* = .5 that spans the the middle half of<br>
the yrange<br>
<br>
>>> <a href="#Subplot-axvline">axvline</a>(x=.5, ymin=0.25, ymax=0.75)<br>
<br>
Valid kwargs are :class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
See :meth:`axhspan` for example plot and source code</tt></dd></dl>
<dl><dt><a name="AxesSubplot-axvspan"><strong>axvspan</strong></a>(self, xmin, xmax, ymin<font color="#909090">=0</font>, ymax<font color="#909090">=1</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-axvspan">axvspan</a>(xmin, xmax, ymin=0, ymax=1, **kwargs)<br>
<br>
Axis Vertical Span.<br>
<br>
*x* coords are in data units and *y* coords are in axes (relative<br>
0-1) units.<br>
<br>
Draw a vertical span (rectangle) from *xmin* to *xmax*. With<br>
the default values of *ymin* = 0 and *ymax* = 1, this always<br>
span the yrange, regardless of the ylim settings, even if you<br>
change them, eg. with the :meth:`set_ylim` command. That is,<br>
the vertical extent is in axes coords: 0=bottom, 0.5=middle,<br>
1.0=top but the *y* location is in data coordinates.<br>
<br>
Return value is the :class:`matplotlib.patches.Polygon`<br>
instance.<br>
<br>
Examples:<br>
<br>
* draw a vertical green translucent rectangle from x=1.25 to 1.55 that<br>
spans the yrange of the axes<br>
<br>
>>> <a href="#Subplot-axvspan">axvspan</a>(1.25, 1.55, facecolor='g', alpha=0.5)<br>
<br>
Valid kwargs are :class:`~matplotlib.patches.Polygon`<br>
properties:<br>
<br>
<br>
=========== ===========================================================<br>
Property Description <br>
=========== ===========================================================<br>
aa [True | False] or None for default <br>
alpha float <br>
animated [True | False] <br>
antialiased [True | False] or None for default <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
contains unknown <br>
ec mpl color spec, or None for default, or 'none' for no color<br>
edgecolor mpl color spec, or None for default, or 'none' for no color<br>
facecolor mpl color spec, or None for default, or 'none' for no color<br>
fc mpl color spec, or None for default, or 'none' for no color<br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fill [True | False] <br>
hatch unknown <br>
label any string <br>
linestyle ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
linewidth float or None for default <br>
lod [True | False] <br>
ls ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
lw float or None for default <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
=========== ===========================================================<br>
<br>
<br>
See :meth:`axhspan` for example plot and source code</tt></dd></dl>
<dl><dt><a name="AxesSubplot-bar"><strong>bar</strong></a>(self, left, height, width<font color="#909090">=0.80000000000000004</font>, bottom<font color="#909090">=None</font>, color<font color="#909090">=None</font>, edgecolor<font color="#909090">=None</font>, linewidth<font color="#909090">=None</font>, yerr<font color="#909090">=None</font>, xerr<font color="#909090">=None</font>, ecolor<font color="#909090">=None</font>, capsize<font color="#909090">=3</font>, align<font color="#909090">='edge'</font>, orientation<font color="#909090">='vertical'</font>, log<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-bar">bar</a>(left, height, width=0.8, bottom=0,<br>
color=None, edgecolor=None, linewidth=None,<br>
yerr=None, xerr=None, ecolor=None, capsize=3,<br>
align='edge', orientation='vertical', log=False)<br>
<br>
Make a bar plot with rectangles bounded by:<br>
<br>
*left*, *left* + *width*, *bottom*, *bottom* + *height*<br>
(left, right, bottom and top edges)<br>
<br>
*left*, *height*, *width*, and *bottom* can be either scalars<br>
or sequences<br>
<br>
Return value is a list of<br>
:class:`matplotlib.patches.Rectangle` instances.<br>
<br>
Required arguments:<br>
<br>
======== ===============================================<br>
Argument Description<br>
======== ===============================================<br>
*left* the x coordinates of the left sides of the bars<br>
*height* the heights of the bars<br>
======== ===============================================<br>
<br>
Optional keyword arguments:<br>
<br>
=============== ==========================================<br>
Keyword Description<br>
=============== ==========================================<br>
*width* the widths of the bars<br>
*bottom* the y coordinates of the bottom edges of<br>
the bars<br>
*color* the colors of the bars<br>
*edgecolor* the colors of the bar edges<br>
*linewidth* width of bar edges; None means use default<br>
linewidth; 0 means don't draw edges.<br>
*xerr* if not None, will be used to generate<br>
errorbars on the bar chart<br>
*yerr* if not None, will be used to generate<br>
errorbars on the bar chart<br>
*ecolor* specifies the color of any errorbar<br>
*capsize* (default 3) determines the length in<br>
points of the error bar caps<br>
*align* 'edge' (default) | 'center'<br>
*orientation* 'vertical' | 'horizontal'<br>
*log* [False|True] False (default) leaves the<br>
orientation axis as-is; True sets it to<br>
log scale<br>
=============== ==========================================<br>
<br>
For vertical bars, *align* = 'edge' aligns bars by their left<br>
edges in left, while *align* = 'center' interprets these<br>
values as the *x* coordinates of the bar centers. For<br>
horizontal bars, *align* = 'edge' aligns bars by their bottom<br>
edges in bottom, while *align* = 'center' interprets these<br>
values as the *y* coordinates of the bar centers.<br>
<br>
The optional arguments *color*, *edgecolor*, *linewidth*,<br>
*xerr*, and *yerr* can be either scalars or sequences of<br>
length equal to the number of bars. This enables you to use<br>
bar as the basis for stacked bar charts, or candlestick plots.<br>
<br>
Other optional kwargs:<br>
<br>
<br>
=========== ===========================================================<br>
Property Description <br>
=========== ===========================================================<br>
aa [True | False] or None for default <br>
alpha float <br>
animated [True | False] <br>
antialiased [True | False] or None for default <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
contains unknown <br>
ec mpl color spec, or None for default, or 'none' for no color<br>
edgecolor mpl color spec, or None for default, or 'none' for no color<br>
facecolor mpl color spec, or None for default, or 'none' for no color<br>
fc mpl color spec, or None for default, or 'none' for no color<br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fill [True | False] <br>
hatch unknown <br>
label any string <br>
linestyle ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
linewidth float or None for default <br>
lod [True | False] <br>
ls ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
lw float or None for default <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
=========== ===========================================================<br>
<br>
<br>
**Example:** A stacked bar chart.<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/bar_stacked.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-barbs"><strong>barbs</strong></a>(self, *args, **kw)</dt><dd><tt>Plot a 2-D field of barbs.<br>
<br>
call signatures::<br>
<br>
barb(U, V, **kw)<br>
barb(U, V, C, **kw)<br>
barb(X, Y, U, V, **kw)<br>
barb(X, Y, U, V, C, **kw)<br>
<br>
Arguments:<br>
<br>
*X*, *Y*:<br>
The x and y coordinates of the barb locations<br>
(default is head of barb; see *pivot* kwarg)<br>
<br>
*U*, *V*:<br>
give the *x* and *y* components of the barb shaft<br>
<br>
*C*:<br>
an optional array used to map colors to the barbs<br>
<br>
All arguments may be 1-D or 2-D arrays or sequences. If *X* and *Y*<br>
are absent, they will be generated as a uniform grid. If *U* and *V*<br>
are 2-D arrays but *X* and *Y* are 1-D, and if len(*X*) and len(*Y*)<br>
match the column and row dimensions of *U*, then *X* and *Y* will be<br>
expanded with :func:`numpy.meshgrid`.<br>
<br>
*U*, *V*, *C* may be masked arrays, but masked *X*, *Y* are not<br>
supported at present.<br>
<br>
Keyword arguments:<br>
<br>
*length*:<br>
Length of the barb in points; the other parts of the barb<br>
are scaled against this.<br>
Default is 9<br>
<br>
*pivot*: [ 'tip' | 'middle' ]<br>
The part of the arrow that is at the grid point; the arrow<br>
rotates about this point, hence the name *pivot*.<br>
Default is 'tip'<br>
<br>
*barbcolor*: [ color | color sequence ]<br>
Specifies the color all parts of the barb except any flags.<br>
This parameter is analagous to the *edgecolor* parameter<br>
for polygons, which can be used instead. However this parameter<br>
will override facecolor.<br>
<br>
*flagcolor*: [ color | color sequence ]<br>
Specifies the color of any flags on the barb.<br>
This parameter is analagous to the *facecolor* parameter<br>
for polygons, which can be used instead. However this parameter<br>
will override facecolor. If this is not set (and *C* has not either)<br>
then *flagcolor* will be set to match *barbcolor* so that the barb<br>
has a uniform color. If *C* has been set, *flagcolor* has no effect.<br>
<br>
*sizes*:<br>
A dictionary of coefficients specifying the ratio of a given feature<br>
to the length of the barb. Only those values one wishes to override<br>
need to be included. These features include:<br>
'spacing' - space between features (flags, full/half barbs)<br>
'height' - height (distance from shaft to top) of a flag or full barb<br>
'width' - width of a flag, twice the width of a full barb<br>
'emptybarb' - radius of the circle used for low magnitudes<br>
<br>
*fill_empty*:<br>
A flag on whether the empty barbs (circles) that are drawn should be filled<br>
with the flag color. If they are not filled, they will be drawn such that<br>
no color is applied to the center.<br>
Default is False<br>
<br>
*rounding*:<br>
A flag to indicate whether the vector magnitude should be rounded when<br>
allocating barb components. If True, the magnitude is rounded to the<br>
nearest multiple of the half-barb increment. If False, the magnitude<br>
is simply truncated to the next lowest multiple.<br>
Default is True<br>
<br>
*barb_increments*:<br>
A dictionary of increments specifying values to associate with different<br>
parts of the barb. Only those values one wishes to override need to be<br>
included.<br>
'half' - half barbs (Default is 5)<br>
'full' - full barbs (Default is 10)<br>
'flag' - flags (default is 50)<br>
<br>
*flip_barb*:<br>
Either a single boolean flag or an array of booleans. Single boolean<br>
indicates whether the lines and flags should point opposite to normal<br>
for all barbs. An array (which should be the same size as the other<br>
data arrays) indicates whether to flip for each individual barb.<br>
Normal behavior is for the barbs and lines to point right (comes from<br>
wind barbs having these features point towards low pressure in the<br>
Northern Hemisphere.)<br>
Default is False<br>
<br>
Barbs are traditionally used in meteorology as a way to plot the speed<br>
and direction of wind observations, but can technically be used to plot<br>
any two dimensional vector quantity. As opposed to arrows, which give<br>
vector magnitude by the length of the arrow, the barbs give more quantitative<br>
information about the vector magnitude by putting slanted lines or a triangle<br>
for various increments in magnitude, as show schematically below:<br>
<br>
/\ / \ / \ \ / \ \ ------------------------------<br>
<br>
The largest increment is given by a triangle (or "flag"). After those come full<br>
lines (barbs). The smallest increment is a half line. There is only, of<br>
course, ever at most 1 half line. If the magnitude is small and only needs a<br>
single half-line and no full lines or triangles, the half-line is offset from<br>
the end of the barb so that it can be easily distinguished from barbs with a<br>
single full line. The magnitude for the barb shown above would nominally be<br>
65, using the standard increments of 50, 10, and 5.<br>
<br>
linewidths and edgecolors can be used to customize the barb.<br>
Additional :class:`~matplotlib.collections.PolyCollection`<br>
keyword arguments:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================</tt></dd></dl>
<dl><dt><a name="AxesSubplot-barh"><strong>barh</strong></a>(self, bottom, width, height<font color="#909090">=0.80000000000000004</font>, left<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-barh">barh</a>(bottom, width, height=0.8, left=0, **kwargs)<br>
<br>
Make a horizontal bar plot with rectangles bounded by:<br>
<br>
*left*, *left* + *width*, *bottom*, *bottom* + *height*<br>
(left, right, bottom and top edges)<br>
<br>
*bottom*, *width*, *height*, and *left* can be either scalars<br>
or sequences<br>
<br>
Return value is a list of<br>
:class:`matplotlib.patches.Rectangle` instances.<br>
<br>
Required arguments:<br>
<br>
======== ======================================================<br>
Argument Description<br>
======== ======================================================<br>
*bottom* the vertical positions of the bottom edges of the bars<br>
*width* the lengths of the bars<br>
======== ======================================================<br>
<br>
Optional keyword arguments:<br>
<br>
=============== ==========================================<br>
Keyword Description<br>
=============== ==========================================<br>
*height* the heights (thicknesses) of the bars<br>
*left* the x coordinates of the left edges of the<br>
bars<br>
*color* the colors of the bars<br>
*edgecolor* the colors of the bar edges<br>
*linewidth* width of bar edges; None means use default<br>
linewidth; 0 means don't draw edges.<br>
*xerr* if not None, will be used to generate<br>
errorbars on the bar chart<br>
*yerr* if not None, will be used to generate<br>
errorbars on the bar chart<br>
*ecolor* specifies the color of any errorbar<br>
*capsize* (default 3) determines the length in<br>
points of the error bar caps<br>
*align* 'edge' (default) | 'center'<br>
*log* [False|True] False (default) leaves the<br>
horizontal axis as-is; True sets it to log<br>
scale<br>
=============== ==========================================<br>
<br>
Setting *align* = 'edge' aligns bars by their bottom edges in<br>
bottom, while *align* = 'center' interprets these values as<br>
the *y* coordinates of the bar centers.<br>
<br>
The optional arguments *color*, *edgecolor*, *linewidth*,<br>
*xerr*, and *yerr* can be either scalars or sequences of<br>
length equal to the number of bars. This enables you to use<br>
barh as the basis for stacked bar charts, or candlestick<br>
plots.<br>
<br>
other optional kwargs:<br>
<br>
<br>
=========== ===========================================================<br>
Property Description <br>
=========== ===========================================================<br>
aa [True | False] or None for default <br>
alpha float <br>
animated [True | False] <br>
antialiased [True | False] or None for default <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
contains unknown <br>
ec mpl color spec, or None for default, or 'none' for no color<br>
edgecolor mpl color spec, or None for default, or 'none' for no color<br>
facecolor mpl color spec, or None for default, or 'none' for no color<br>
fc mpl color spec, or None for default, or 'none' for no color<br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fill [True | False] <br>
hatch unknown <br>
label any string <br>
linestyle ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
linewidth float or None for default <br>
lod [True | False] <br>
ls ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
lw float or None for default <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
=========== ===========================================================</tt></dd></dl>
<dl><dt><a name="AxesSubplot-boxplot"><strong>boxplot</strong></a>(self, x, notch<font color="#909090">=0</font>, sym<font color="#909090">='b+'</font>, vert<font color="#909090">=1</font>, whis<font color="#909090">=1.5</font>, positions<font color="#909090">=None</font>, widths<font color="#909090">=None</font>)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-boxplot">boxplot</a>(x, notch=0, sym='+', vert=1, whis=1.5,<br>
positions=None, widths=None)<br>
<br>
Make a box and whisker plot for each column of *x* or each<br>
vector in sequence *x*. The box extends from the lower to<br>
upper quartile values of the data, with a line at the median.<br>
The whiskers extend from the box to show the range of the<br>
data. Flier points are those past the end of the whiskers.<br>
<br>
- *notch* = 0 (default) produces a rectangular box plot.<br>
- *notch* = 1 will produce a notched box plot<br>
<br>
*sym* (default 'b+') is the default symbol for flier points.<br>
Enter an empty string ('') if you don't want to show fliers.<br>
<br>
- *vert* = 1 (default) makes the boxes vertical.<br>
- *vert* = 0 makes horizontal boxes. This seems goofy, but<br>
that's how Matlab did it.<br>
<br>
*whis* (default 1.5) defines the length of the whiskers as<br>
a function of the inner quartile range. They extend to the<br>
most extreme data point within ( ``whis*(75%-25%)`` ) data range.<br>
<br>
*positions* (default 1,2,...,n) sets the horizontal positions of<br>
the boxes. The ticks and limits are automatically set to match<br>
the positions.<br>
<br>
*widths* is either a scalar or a vector and sets the width of<br>
each box. The default is 0.5, or ``0.15*(distance between extreme<br>
positions)`` if that is smaller.<br>
<br>
*x* is an array or a sequence of vectors.<br>
<br>
Returns a list of the :class:`matplotlib.lines.Line2D`<br>
instances added.<br>
<br>
**Example:**<br>
<br>
.. plot:: boxplot_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-broken_barh"><strong>broken_barh</strong></a>(self, xranges, yrange, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-broken_barh">broken_barh</a>(self, xranges, yrange, **kwargs)<br>
<br>
A collection of horizontal bars spanning *yrange* with a sequence of<br>
*xranges*.<br>
<br>
Required arguments:<br>
<br>
========= ==============================<br>
Argument Description<br>
========= ==============================<br>
*xranges* sequence of (*xmin*, *xwidth*)<br>
*yrange* sequence of (*ymin*, *ywidth*)<br>
========= ==============================<br>
<br>
kwargs are<br>
:class:`matplotlib.collections.BrokenBarHCollection`<br>
properties:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================<br>
<br>
<br>
these can either be a single argument, ie::<br>
<br>
facecolors = 'black'<br>
<br>
or a sequence of arguments for the various bars, ie::<br>
<br>
facecolors = ('black', 'red', 'green')<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/broken_barh.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-can_zoom"><strong>can_zoom</strong></a>(self)</dt><dd><tt>Return *True* if this axes support the zoom box</tt></dd></dl>
<dl><dt><a name="AxesSubplot-cla"><strong>cla</strong></a>(self)</dt><dd><tt>Clear the current axes</tt></dd></dl>
<dl><dt><a name="AxesSubplot-clabel"><strong>clabel</strong></a>(self, CS, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-clabel">clabel</a>(cs, **kwargs)<br>
<br>
adds labels to line contours in *cs*, where *cs* is a<br>
:class:`~matplotlib.contour.ContourSet` object returned by<br>
contour.<br>
<br>
::<br>
<br>
<a href="#Subplot-clabel">clabel</a>(cs, v, **kwargs)<br>
<br>
only labels contours listed in *v*.<br>
<br>
Optional keyword arguments:<br>
<br>
*fontsize*:<br>
See <a href="http://matplotlib.sf.net/fonts.html">http://matplotlib.sf.net/fonts.html</a><br>
<br>
.. TODO: Update this link to new fonts document<br>
<br>
*colors*:<br>
- if *None*, the color of each label matches the color of<br>
the corresponding contour<br>
<br>
- if one string color, e.g. *colors* = 'r' or *colors* =<br>
'red', all labels will be plotted in this color<br>
<br>
- if a tuple of matplotlib color args (string, float, rgb, etc),<br>
different labels will be plotted in different colors in the order<br>
specified<br>
<br>
*inline*:<br>
controls whether the underlying contour is removed or<br>
not. Default is *True*.<br>
<br>
*inline_spacing*:<br>
space in pixels to leave on each side of label when<br>
placing inline. Defaults to 5. This spacing will be<br>
exact for labels at locations where the contour is<br>
straight, less so for labels on curved contours.<br>
<br>
*fmt*:<br>
a format string for the label. Default is '%1.3f'<br>
Alternatively, this can be a dictionary matching contour<br>
levels with arbitrary strings to use for each contour level<br>
(i.e., fmt[level]=string)<br>
<br>
*manual*:<br>
if *True*, contour labels will be placed manually using<br>
mouse clicks. Click the first button near a contour to<br>
add a label, click the second button (or potentially both<br>
mouse buttons at once) to finish adding labels. The third<br>
button can be used to remove the last label added, but<br>
only if labels are not inline.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-clear"><strong>clear</strong></a>(self)</dt><dd><tt>clear the axes</tt></dd></dl>
<dl><dt><a name="AxesSubplot-cohere"><strong>cohere</strong></a>(self, x, y, NFFT<font color="#909090">=256</font>, Fs<font color="#909090">=2</font>, Fc<font color="#909090">=0</font>, detrend<font color="#909090">=<function detrend_none at 0x26b5ed8></font>, window<font color="#909090">=<function window_hanning at 0x26b5578></font>, noverlap<font color="#909090">=0</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-cohere">cohere</a>(x, y, NFFT=256, Fs=2, Fc=0, detrend = mlab.detrend_none,<br>
window = mlab.window_hanning, noverlap=0, **kwargs)<br>
<br>
cohere the coherence between *x* and *y*. Coherence is the normalized<br>
cross spectral density:<br>
<br>
.. math::<br>
<br>
C_{xy} = \frac{|P_{xy}|^2}{P_{xx}*P_{yy}}<br>
<br>
The return value is a tuple (*Cxy*, *f*), where *f* are the<br>
frequencies of the coherence vector.<br>
<br>
See the :meth:`psd` for a description of the optional parameters.<br>
<br>
kwargs are applied to the lines.<br>
<br>
References:<br>
<br>
* Bendat & Piersol -- Random Data: Analysis and Measurement<br>
Procedures, John Wiley & Sons (1986)<br>
<br>
kwargs control the :class:`~matplotlib.lines.Line2D`<br>
properties of the coherence plot:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/cohere_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-connect"><strong>connect</strong></a>(self, s, func)</dt><dd><tt>Register observers to be notified when certain events occur. Register<br>
with callback functions with the following signatures. The function<br>
has the following signature::<br>
<br>
func(ax) # where ax is the instance making the callback.<br>
<br>
The following events can be connected to:<br>
<br>
'xlim_changed','ylim_changed'<br>
<br>
The connection id is is returned - you can use this with<br>
disconnect to disconnect from the axes event</tt></dd></dl>
<dl><dt><a name="AxesSubplot-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occured in the axes.<br>
<br>
Returns T/F, {}</tt></dd></dl>
<dl><dt><a name="AxesSubplot-contour"><strong>contour</strong></a>(self, *args, **kwargs)</dt><dd><tt>:func:`~matplotlib.pyplot.contour` and<br>
:func:`~matplotlib.pyplot.contourf` draw contour lines and<br>
filled contours, respectively. Except as noted, function<br>
signatures and return values are the same for both versions.<br>
<br>
:func:`~matplotlib.pyplot.contourf` differs from the Matlab<br>
(TM) version in that it does not draw the polygon edges,<br>
because the contouring engine yields simply connected regions<br>
with branch cuts. To draw the edges, add line contours with<br>
calls to :func:`~matplotlib.pyplot.contour`.<br>
<br>
<br>
call signatures::<br>
<br>
<a href="#Subplot-contour">contour</a>(Z)<br>
<br>
make a contour plot of an array *Z*. The level values are chosen<br>
automatically.<br>
<br>
::<br>
<br>
<a href="#Subplot-contour">contour</a>(X,Y,Z)<br>
<br>
*X*, *Y* specify the (*x*, *y*) coordinates of the surface<br>
<br>
::<br>
<br>
<a href="#Subplot-contour">contour</a>(Z,N)<br>
<a href="#Subplot-contour">contour</a>(X,Y,Z,N)<br>
<br>
contour *N* automatically-chosen levels.<br>
<br>
::<br>
<br>
<a href="#Subplot-contour">contour</a>(Z,V)<br>
<a href="#Subplot-contour">contour</a>(X,Y,Z,V)<br>
<br>
draw contour lines at the values specified in sequence *V*<br>
<br>
::<br>
<br>
<a href="#Subplot-contourf">contourf</a>(..., V)<br>
<br>
fill the (len(*V*)-1) regions between the values in *V*<br>
<br>
::<br>
<br>
<a href="#Subplot-contour">contour</a>(Z, **kwargs)<br>
<br>
Use keyword args to control colors, linewidth, origin, cmap ... see<br>
below for more details.<br>
<br>
*X*, *Y*, and *Z* must be arrays with the same dimensions.<br>
<br>
*Z* may be a masked array, but filled contouring may not<br>
handle internal masked regions correctly.<br>
<br>
``C = <a href="#Subplot-contour">contour</a>(...)`` returns a<br>
:class:`~matplotlib.contour.ContourSet` object.<br>
<br>
Optional keyword arguments:<br>
<br>
*colors*: [ None | string | (mpl_colors) ]<br>
If *None*, the colormap specified by cmap will be used.<br>
<br>
If a string, like 'r' or 'red', all levels will be plotted in this<br>
color.<br>
<br>
If a tuple of matplotlib color args (string, float, rgb, etc),<br>
different levels will be plotted in different colors in the order<br>
specified.<br>
<br>
*alpha*: float<br>
The alpha blending value<br>
<br>
*cmap*: [ None | Colormap ]<br>
A cm :class:`~matplotlib.cm.Colormap` instance or<br>
*None*. If *cmap* is *None* and *colors* is *None*, a<br>
default Colormap is used.<br>
<br>
*norm*: [ None | Normalize ]<br>
A :class:`matplotlib.colors.Normalize` instance for<br>
scaling data values to colors. If *norm* is *None* and<br>
*colors* is *None*, the default linear scaling is used.<br>
<br>
*origin*: [ None | 'upper' | 'lower' | 'image' ]<br>
If *None*, the first value of *Z* will correspond to the<br>
lower left corner, location (0,0). If 'image', the rc<br>
value for ``image.origin`` will be used.<br>
<br>
This keyword is not active if *X* and *Y* are specified in<br>
the call to contour.<br>
<br>
*extent*: [ None | (x0,x1,y0,y1) ]<br>
<br>
If *origin* is not *None*, then *extent* is interpreted as<br>
in :func:`matplotlib.pyplot.imshow`: it gives the outer<br>
pixel boundaries. In this case, the position of Z[0,0]<br>
is the center of the pixel, not a corner. If *origin* is<br>
*None*, then (*x0*, *y0*) is the position of Z[0,0], and<br>
(*x1*, *y1*) is the position of Z[-1,-1].<br>
<br>
This keyword is not active if *X* and *Y* are specified in<br>
the call to contour.<br>
<br>
*locator*: [ None | ticker.Locator subclass ]<br>
If *locator* is None, the default<br>
:class:`~matplotlib.ticker.MaxNLocator` is used. The<br>
locator is used to determine the contour levels if they<br>
are not given explicitly via the *V* argument.<br>
<br>
*extend*: [ 'neither' | 'both' | 'min' | 'max' ]<br>
Unless this is 'neither', contour levels are automatically<br>
added to one or both ends of the range so that all data<br>
are included. These added ranges are then mapped to the<br>
special colormap values which default to the ends of the<br>
colormap range, but can be set via<br>
:meth:`matplotlib.cm.Colormap.set_under` and<br>
:meth:`matplotlib.cm.Colormap.set_over` methods.<br>
<br>
contour-only keyword arguments:<br>
<br>
*linewidths*: [ None | number | tuple of numbers ]<br>
If *linewidths* is *None*, the default width in<br>
``lines.linewidth`` in ``matplotlibrc`` is used<br>
<br>
If a number, all levels will be plotted with this linewidth.<br>
<br>
If a tuple, different levels will be plotted with different<br>
linewidths in the order specified<br>
<br>
contourf-only keyword arguments:<br>
<br>
*antialiased*: [ True | False ]<br>
enable antialiasing<br>
<br>
*nchunk*: [ 0 | integer ]<br>
If 0, no subdivision of the domain. Specify a positive integer to<br>
divide the domain into subdomains of roughly *nchunk* by *nchunk*<br>
points. This may never actually be advantageous, so this option may<br>
be removed. Chunking introduces artifacts at the chunk boundaries<br>
unless *antialiased* is *False*.<br>
<br>
**Example:**<br>
<br>
.. plot:: contour_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-contourf"><strong>contourf</strong></a>(self, *args, **kwargs)</dt><dd><tt>:func:`~matplotlib.pyplot.contour` and<br>
:func:`~matplotlib.pyplot.contourf` draw contour lines and<br>
filled contours, respectively. Except as noted, function<br>
signatures and return values are the same for both versions.<br>
<br>
:func:`~matplotlib.pyplot.contourf` differs from the Matlab<br>
(TM) version in that it does not draw the polygon edges,<br>
because the contouring engine yields simply connected regions<br>
with branch cuts. To draw the edges, add line contours with<br>
calls to :func:`~matplotlib.pyplot.contour`.<br>
<br>
<br>
call signatures::<br>
<br>
<a href="#Subplot-contour">contour</a>(Z)<br>
<br>
make a contour plot of an array *Z*. The level values are chosen<br>
automatically.<br>
<br>
::<br>
<br>
<a href="#Subplot-contour">contour</a>(X,Y,Z)<br>
<br>
*X*, *Y* specify the (*x*, *y*) coordinates of the surface<br>
<br>
::<br>
<br>
<a href="#Subplot-contour">contour</a>(Z,N)<br>
<a href="#Subplot-contour">contour</a>(X,Y,Z,N)<br>
<br>
contour *N* automatically-chosen levels.<br>
<br>
::<br>
<br>
<a href="#Subplot-contour">contour</a>(Z,V)<br>
<a href="#Subplot-contour">contour</a>(X,Y,Z,V)<br>
<br>
draw contour lines at the values specified in sequence *V*<br>
<br>
::<br>
<br>
<a href="#Subplot-contourf">contourf</a>(..., V)<br>
<br>
fill the (len(*V*)-1) regions between the values in *V*<br>
<br>
::<br>
<br>
<a href="#Subplot-contour">contour</a>(Z, **kwargs)<br>
<br>
Use keyword args to control colors, linewidth, origin, cmap ... see<br>
below for more details.<br>
<br>
*X*, *Y*, and *Z* must be arrays with the same dimensions.<br>
<br>
*Z* may be a masked array, but filled contouring may not<br>
handle internal masked regions correctly.<br>
<br>
``C = <a href="#Subplot-contour">contour</a>(...)`` returns a<br>
:class:`~matplotlib.contour.ContourSet` object.<br>
<br>
Optional keyword arguments:<br>
<br>
*colors*: [ None | string | (mpl_colors) ]<br>
If *None*, the colormap specified by cmap will be used.<br>
<br>
If a string, like 'r' or 'red', all levels will be plotted in this<br>
color.<br>
<br>
If a tuple of matplotlib color args (string, float, rgb, etc),<br>
different levels will be plotted in different colors in the order<br>
specified.<br>
<br>
*alpha*: float<br>
The alpha blending value<br>
<br>
*cmap*: [ None | Colormap ]<br>
A cm :class:`~matplotlib.cm.Colormap` instance or<br>
*None*. If *cmap* is *None* and *colors* is *None*, a<br>
default Colormap is used.<br>
<br>
*norm*: [ None | Normalize ]<br>
A :class:`matplotlib.colors.Normalize` instance for<br>
scaling data values to colors. If *norm* is *None* and<br>
*colors* is *None*, the default linear scaling is used.<br>
<br>
*origin*: [ None | 'upper' | 'lower' | 'image' ]<br>
If *None*, the first value of *Z* will correspond to the<br>
lower left corner, location (0,0). If 'image', the rc<br>
value for ``image.origin`` will be used.<br>
<br>
This keyword is not active if *X* and *Y* are specified in<br>
the call to contour.<br>
<br>
*extent*: [ None | (x0,x1,y0,y1) ]<br>
<br>
If *origin* is not *None*, then *extent* is interpreted as<br>
in :func:`matplotlib.pyplot.imshow`: it gives the outer<br>
pixel boundaries. In this case, the position of Z[0,0]<br>
is the center of the pixel, not a corner. If *origin* is<br>
*None*, then (*x0*, *y0*) is the position of Z[0,0], and<br>
(*x1*, *y1*) is the position of Z[-1,-1].<br>
<br>
This keyword is not active if *X* and *Y* are specified in<br>
the call to contour.<br>
<br>
*locator*: [ None | ticker.Locator subclass ]<br>
If *locator* is None, the default<br>
:class:`~matplotlib.ticker.MaxNLocator` is used. The<br>
locator is used to determine the contour levels if they<br>
are not given explicitly via the *V* argument.<br>
<br>
*extend*: [ 'neither' | 'both' | 'min' | 'max' ]<br>
Unless this is 'neither', contour levels are automatically<br>
added to one or both ends of the range so that all data<br>
are included. These added ranges are then mapped to the<br>
special colormap values which default to the ends of the<br>
colormap range, but can be set via<br>
:meth:`matplotlib.cm.Colormap.set_under` and<br>
:meth:`matplotlib.cm.Colormap.set_over` methods.<br>
<br>
contour-only keyword arguments:<br>
<br>
*linewidths*: [ None | number | tuple of numbers ]<br>
If *linewidths* is *None*, the default width in<br>
``lines.linewidth`` in ``matplotlibrc`` is used<br>
<br>
If a number, all levels will be plotted with this linewidth.<br>
<br>
If a tuple, different levels will be plotted with different<br>
linewidths in the order specified<br>
<br>
contourf-only keyword arguments:<br>
<br>
*antialiased*: [ True | False ]<br>
enable antialiasing<br>
<br>
*nchunk*: [ 0 | integer ]<br>
If 0, no subdivision of the domain. Specify a positive integer to<br>
divide the domain into subdomains of roughly *nchunk* by *nchunk*<br>
points. This may never actually be advantageous, so this option may<br>
be removed. Chunking introduces artifacts at the chunk boundaries<br>
unless *antialiased* is *False*.<br>
<br>
**Example:**<br>
<br>
.. plot:: contour_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-csd"><strong>csd</strong></a>(self, x, y, NFFT<font color="#909090">=256</font>, Fs<font color="#909090">=2</font>, Fc<font color="#909090">=0</font>, detrend<font color="#909090">=<function detrend_none at 0x26b5ed8></font>, window<font color="#909090">=<function window_hanning at 0x26b5578></font>, noverlap<font color="#909090">=0</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-csd">csd</a>(x, y, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,<br>
window=window_hanning, noverlap=0, **kwargs)<br>
<br>
The cross spectral density :math:`P_{xy}` by Welches average<br>
periodogram method. The vectors *x* and *y* are divided into<br>
*NFFT* length segments. Each segment is detrended by function<br>
*detrend* and windowed by function *window*. The product of<br>
the direct FFTs of *x* and *y* are averaged over each segment<br>
to compute :math:`P_{xy}`, with a scaling to correct for power<br>
loss due to windowing.<br>
<br>
See :meth:`psd` for a description of the optional parameters.<br>
<br>
Returns the tuple (*Pxy*, *freqs*). *P* is the cross spectrum<br>
(complex valued), and :math:`10\log_{10}|P_{xy}|` is<br>
plotted.<br>
<br>
References:<br>
Bendat & Piersol -- Random Data: Analysis and Measurement<br>
Procedures, John Wiley & Sons (1986)<br>
<br>
kwargs control the Line2D properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/csd_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-disconnect"><strong>disconnect</strong></a>(self, cid)</dt><dd><tt>disconnect from the <a href="#Axes">Axes</a> event.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-drag_pan"><strong>drag_pan</strong></a>(self, button, key, x, y)</dt><dd><tt>Called when the mouse moves during a pan operation.<br>
<br>
*button* is the mouse button number:<br>
<br>
* 1: LEFT<br>
* 2: MIDDLE<br>
* 3: RIGHT<br>
<br>
*key* is a "shift" key<br>
<br>
*x*, *y* are the mouse coordinates in display coords.<br>
<br>
.. note::<br>
Intended to be overridden by new projection types.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-draw"><strong>draw</strong></a>(self, renderer<font color="#909090">=None</font>, inframe<font color="#909090">=False</font>)</dt><dd><tt>Draw everything (plot lines, axes, labels)</tt></dd></dl>
<dl><dt><a name="AxesSubplot-draw_artist"><strong>draw_artist</strong></a>(self, a)</dt><dd><tt>This method can only be used after an initial draw which<br>
caches the renderer. It is used to efficiently update <a href="#Axes">Axes</a><br>
data (axis ticks, labels, etc are not updated)</tt></dd></dl>
<dl><dt><a name="AxesSubplot-end_pan"><strong>end_pan</strong></a>(self)</dt><dd><tt>Called when a pan operation completes (when the mouse button<br>
is up.)<br>
<br>
.. note::<br>
Intended to be overridden by new projection types.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-errorbar"><strong>errorbar</strong></a>(self, x, y, yerr<font color="#909090">=None</font>, xerr<font color="#909090">=None</font>, fmt<font color="#909090">='-'</font>, ecolor<font color="#909090">=None</font>, elinewidth<font color="#909090">=None</font>, capsize<font color="#909090">=3</font>, barsabove<font color="#909090">=False</font>, lolims<font color="#909090">=False</font>, uplims<font color="#909090">=False</font>, xlolims<font color="#909090">=False</font>, xuplims<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-errorbar">errorbar</a>(x, y, yerr=None, xerr=None,<br>
fmt='-', ecolor=None, elinewidth=None, capsize=3,<br>
barsabove=False, lolims=False, uplims=False,<br>
xlolims=False, xuplims=False)<br>
<br>
Plot *x* versus *y* with error deltas in *yerr* and *xerr*.<br>
Vertical errorbars are plotted if *yerr* is not *None*.<br>
Horizontal errorbars are plotted if *xerr* is not *None*.<br>
<br>
*x*, *y*, *xerr*, and *yerr* can all be scalars, which plots a<br>
single error bar at *x*, *y*.<br>
<br>
Optional keyword arguments:<br>
<br>
*xerr*/*yerr*: [ scalar | N, Nx1, Nx2 array-like ]<br>
If a scalar number, len(N) array-like object, or an Nx1 array-like<br>
object, errorbars are drawn +/- value.<br>
<br>
If a rank-1, Nx2 Numpy array, errorbars are drawn at -column1 and<br>
+column2<br>
<br>
*fmt*: '-'<br>
The plot format symbol for *y*. If *fmt* is *None*, just plot the<br>
errorbars with no line symbols. This can be useful for creating a<br>
bar plot with errorbars.<br>
<br>
*ecolor*: [ None | mpl color ]<br>
a matplotlib color arg which gives the color the errorbar lines; if<br>
*None*, use the marker color.<br>
<br>
*elinewidth*: scalar<br>
the linewidth of the errorbar lines. If *None*, use the linewidth.<br>
<br>
*capsize*: scalar<br>
the size of the error bar caps in points<br>
<br>
*barsabove*: [ True | False ]<br>
if *True*, will plot the errorbars above the plot<br>
symbols. Default is below.<br>
<br>
*lolims*/*uplims*/*xlolims*/*xuplims*: [ False | True ]<br>
These arguments can be used to indicate that a value gives<br>
only upper/lower limits. In that case a caret symbol is<br>
used to indicate this. lims-arguments may be of the same<br>
type as *xerr* and *yerr*.<br>
<br>
All other keyword arguments are passed on to the plot command for the<br>
markers, so you can add additional key=value pairs to control the<br>
errorbar markers. For example, this code makes big red squares with<br>
thick green edges::<br>
<br>
x,y,yerr = rand(3,10)<br>
<a href="#Subplot-errorbar">errorbar</a>(x, y, yerr, marker='s',<br>
mfc='red', mec='green', ms=20, mew=4)<br>
<br>
where *mfc*, *mec*, *ms* and *mew* are aliases for the longer<br>
property names, *markerfacecolor*, *markeredgecolor*, *markersize*<br>
and *markeredgewith*.<br>
<br>
valid kwargs for the marker properties are<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
Return value is a length 3 tuple. The first element is the<br>
:class:`~matplotlib.lines.Line2D` instance for the *y* symbol<br>
lines. The second element is a list of error bar cap lines,<br>
the third element is a list of<br>
:class:`~matplotlib.collections.LineCollection` instances for<br>
the horizontal and vertical error ranges.<br>
<br>
**Example:**<br>
<br>
.. plot:: errorbar_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-fill"><strong>fill</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-fill">fill</a>(*args, **kwargs)<br>
<br>
Plot filled polygons. *args* is a variable length argument,<br>
allowing for multiple *x*, *y* pairs with an optional color<br>
format string; see :func:`~matplotlib.pyplot.plot` for details<br>
on the argument parsing. For example, to plot a polygon with<br>
vertices at *x*, *y* in blue.::<br>
<br>
ax.<a href="#Subplot-fill">fill</a>(x,y, 'b' )<br>
<br>
An arbitrary number of *x*, *y*, *color* groups can be specified::<br>
<br>
ax.<a href="#Subplot-fill">fill</a>(x1, y1, 'g', x2, y2, 'r')<br>
<br>
Return value is a list of :class:`~matplotlib.patches.Patch`<br>
instances that were added.<br>
<br>
The same color strings that :func:`~matplotlib.pyplot.plot`<br>
supports are supported by the fill format string.<br>
<br>
If you would like to fill below a curve, eg. shade a region<br>
between 0 and *y* along *x*, use<br>
:func:`~matplotlib.pylab.poly_between`, eg.::<br>
<br>
xs, ys = poly_between(x, 0, y)<br>
axes.<a href="#Subplot-fill">fill</a>(xs, ys, facecolor='red', alpha=0.5)<br>
<br>
See :file:`examples/pylab_examples/fill_between.py` for more examples.<br>
<br>
The *closed* kwarg will close the polygon when *True* (default).<br>
<br>
kwargs control the Polygon properties:<br>
<br>
<br>
=========== ===========================================================<br>
Property Description <br>
=========== ===========================================================<br>
aa [True | False] or None for default <br>
alpha float <br>
animated [True | False] <br>
antialiased [True | False] or None for default <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
contains unknown <br>
ec mpl color spec, or None for default, or 'none' for no color<br>
edgecolor mpl color spec, or None for default, or 'none' for no color<br>
facecolor mpl color spec, or None for default, or 'none' for no color<br>
fc mpl color spec, or None for default, or 'none' for no color<br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fill [True | False] <br>
hatch unknown <br>
label any string <br>
linestyle ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
linewidth float or None for default <br>
lod [True | False] <br>
ls ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
lw float or None for default <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
=========== ===========================================================<br>
<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/fill_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-format_coord"><strong>format_coord</strong></a>(self, x, y)</dt><dd><tt>return a format string formatting the *x*, *y* coord</tt></dd></dl>
<dl><dt><a name="AxesSubplot-format_xdata"><strong>format_xdata</strong></a>(self, x)</dt><dd><tt>Return *x* string formatted. This function will use the attribute<br>
self.<strong>fmt_xdata</strong> if it is callable, else will fall back on the xaxis<br>
major formatter</tt></dd></dl>
<dl><dt><a name="AxesSubplot-format_ydata"><strong>format_ydata</strong></a>(self, y)</dt><dd><tt>Return y string formatted. This function will use the<br>
:attr:`fmt_ydata` attribute if it is callable, else will fall<br>
back on the yaxis major formatter</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_adjustable"><strong>get_adjustable</strong></a>(self)</dt></dl>
<dl><dt><a name="AxesSubplot-get_anchor"><strong>get_anchor</strong></a>(self)</dt></dl>
<dl><dt><a name="AxesSubplot-get_aspect"><strong>get_aspect</strong></a>(self)</dt></dl>
<dl><dt><a name="AxesSubplot-get_autoscale_on"><strong>get_autoscale_on</strong></a>(self)</dt><dd><tt>Get whether autoscaling is applied on plot commands</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_axis_bgcolor"><strong>get_axis_bgcolor</strong></a>(self)</dt><dd><tt>Return the axis background color</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_axisbelow"><strong>get_axisbelow</strong></a>(self)</dt><dd><tt>Get whether axis below is true or not</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_child_artists"><strong>get_child_artists</strong></a>(self)</dt><dd><tt>Return a list of artists the axes contains.<br>
<br>
.. deprecated:: 0.98</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_children"><strong>get_children</strong></a>(self)</dt><dd><tt>return a list of child artists</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_cursor_props"><strong>get_cursor_props</strong></a>(self)</dt><dd><tt>return the cursor propertiess as a (*linewidth*, *color*)<br>
tuple, where *linewidth* is a float and *color* is an RGBA<br>
tuple</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_data_ratio"><strong>get_data_ratio</strong></a>(self)</dt><dd><tt>Returns the aspect ratio of the raw data.<br>
<br>
This method is intended to be overridden by new projection<br>
types.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_frame"><strong>get_frame</strong></a>(self)</dt><dd><tt>Return the axes Rectangle frame</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_frame_on"><strong>get_frame_on</strong></a>(self)</dt><dd><tt>Get whether the axes rectangle patch is drawn</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_images"><strong>get_images</strong></a>(self)</dt><dd><tt>return a list of <a href="#Axes">Axes</a> images contained by the <a href="#Axes">Axes</a></tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_legend"><strong>get_legend</strong></a>(self)</dt><dd><tt>Return the legend.Legend instance, or None if no legend is defined</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_lines"><strong>get_lines</strong></a>(self)</dt><dd><tt>Return a list of lines contained by the <a href="#Axes">Axes</a></tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_navigate"><strong>get_navigate</strong></a>(self)</dt><dd><tt>Get whether the axes responds to navigation commands</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_navigate_mode"><strong>get_navigate_mode</strong></a>(self)</dt><dd><tt>Get the navigation toolbar button status: 'PAN', 'ZOOM', or None</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_position"><strong>get_position</strong></a>(self, original<font color="#909090">=False</font>)</dt><dd><tt>Return the a copy of the axes rectangle as a Bbox</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_renderer_cache"><strong>get_renderer_cache</strong></a>(self)</dt></dl>
<dl><dt><a name="AxesSubplot-get_shared_x_axes"><strong>get_shared_x_axes</strong></a>(self)</dt><dd><tt>Return a copy of the shared axes Grouper object for x axes</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_shared_y_axes"><strong>get_shared_y_axes</strong></a>(self)</dt><dd><tt>Return a copy of the shared axes Grouper object for y axes</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_title"><strong>get_title</strong></a>(self)</dt><dd><tt>Get the title text string.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_window_extent"><strong>get_window_extent</strong></a>(self, *args, **kwargs)</dt><dd><tt>get the axes bounding box in display space; *args* and<br>
*kwargs* are empty</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_xaxis"><strong>get_xaxis</strong></a>(self)</dt><dd><tt>Return the XAxis instance</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_xaxis_text1_transform"><strong>get_xaxis_text1_transform</strong></a>(self, pad_points)</dt><dd><tt>Get the transformation used for drawing x-axis labels, which<br>
will add the given amount of padding (in points) between the<br>
axes and the label. The x-direction is in data coordinates<br>
and the y-direction is in axis coordinates. Returns a<br>
3-tuple of the form::<br>
<br>
(transform, valign, halign)<br>
<br>
where *valign* and *halign* are requested alignments for the<br>
text.<br>
<br>
.. note::<br>
This transformation is primarily used by the<br>
:class:`~matplotlib.axis.Axis` class, and is meant to be<br>
overridden by new kinds of projections that may need to<br>
place axis elements in different locations.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_xaxis_text2_transform"><strong>get_xaxis_text2_transform</strong></a>(self, pad_points)</dt><dd><tt>Get the transformation used for drawing the secondary x-axis<br>
labels, which will add the given amount of padding (in points)<br>
between the axes and the label. The x-direction is in data<br>
coordinates and the y-direction is in axis coordinates.<br>
Returns a 3-tuple of the form::<br>
<br>
(transform, valign, halign)<br>
<br>
where *valign* and *halign* are requested alignments for the<br>
text.<br>
<br>
.. note::<br>
This transformation is primarily used by the<br>
:class:`~matplotlib.axis.Axis` class, and is meant to be<br>
overridden by new kinds of projections that may need to<br>
place axis elements in different locations.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_xaxis_transform"><strong>get_xaxis_transform</strong></a>(self)</dt><dd><tt>Get the transformation used for drawing x-axis labels, ticks<br>
and gridlines. The x-direction is in data coordinates and the<br>
y-direction is in axis coordinates.<br>
<br>
.. note::<br>
This transformation is primarily used by the<br>
:class:`~matplotlib.axis.Axis` class, and is meant to be<br>
overridden by new kinds of projections that may need to<br>
place axis elements in different locations.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_xbound"><strong>get_xbound</strong></a>(self)</dt><dd><tt>Returns the x-axis numerical bounds where::<br>
<br>
lowerBound < upperBound</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_xgridlines"><strong>get_xgridlines</strong></a>(self)</dt><dd><tt>Get the x grid lines as a list of Line2D instances</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_xlabel"><strong>get_xlabel</strong></a>(self)</dt><dd><tt>Get the xlabel text string.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_xlim"><strong>get_xlim</strong></a>(self)</dt><dd><tt>Get the x-axis range [*xmin*, *xmax*]</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_xmajorticklabels"><strong>get_xmajorticklabels</strong></a>(self)</dt><dd><tt>Get the xtick labels as a list of Text instances</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_xminorticklabels"><strong>get_xminorticklabels</strong></a>(self)</dt><dd><tt>Get the xtick labels as a list of Text instances</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_xscale"><strong>get_xscale</strong></a>(self)</dt></dl>
<dl><dt><a name="AxesSubplot-get_xticklabels"><strong>get_xticklabels</strong></a>(self, minor<font color="#909090">=False</font>)</dt><dd><tt>Get the xtick labels as a list of Text instances</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_xticklines"><strong>get_xticklines</strong></a>(self)</dt><dd><tt>Get the xtick lines as a list of Line2D instances</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_xticks"><strong>get_xticks</strong></a>(self, minor<font color="#909090">=False</font>)</dt><dd><tt>Return the x ticks as a list of locations</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_yaxis"><strong>get_yaxis</strong></a>(self)</dt><dd><tt>Return the YAxis instance</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_yaxis_text1_transform"><strong>get_yaxis_text1_transform</strong></a>(self, pad_points)</dt><dd><tt>Get the transformation used for drawing y-axis labels, which<br>
will add the given amount of padding (in points) between the<br>
axes and the label. The x-direction is in axis coordinates<br>
and the y-direction is in data coordinates. Returns a 3-tuple<br>
of the form::<br>
<br>
(transform, valign, halign)<br>
<br>
where *valign* and *halign* are requested alignments for the<br>
text.<br>
<br>
.. note::<br>
This transformation is primarily used by the<br>
:class:`~matplotlib.axis.Axis` class, and is meant to be<br>
overridden by new kinds of projections that may need to<br>
place axis elements in different locations.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_yaxis_text2_transform"><strong>get_yaxis_text2_transform</strong></a>(self, pad_points)</dt><dd><tt>Get the transformation used for drawing the secondary y-axis<br>
labels, which will add the given amount of padding (in points)<br>
between the axes and the label. The x-direction is in axis<br>
coordinates and the y-direction is in data coordinates.<br>
Returns a 3-tuple of the form::<br>
<br>
(transform, valign, halign)<br>
<br>
where *valign* and *halign* are requested alignments for the<br>
text.<br>
<br>
.. note::<br>
<br>
This transformation is primarily used by the<br>
:class:`~matplotlib.axis.Axis` class, and is meant to be<br>
overridden by new kinds of projections that may need to<br>
place axis elements in different locations.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_yaxis_transform"><strong>get_yaxis_transform</strong></a>(self)</dt><dd><tt>Get the transformation used for drawing y-axis labels, ticks<br>
and gridlines. The x-direction is in axis coordinates and the<br>
y-direction is in data coordinates.<br>
<br>
.. note::<br>
This transformation is primarily used by the<br>
:class:`~matplotlib.axis.Axis` class, and is meant to be<br>
overridden by new kinds of projections that may need to<br>
place axis elements in different locations.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_ybound"><strong>get_ybound</strong></a>(self)</dt><dd><tt>Returns the y-axis numerical bounds in the form of lowerBound < upperBound</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_ygridlines"><strong>get_ygridlines</strong></a>(self)</dt><dd><tt>Get the y grid lines as a list of Line2D instances</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_ylabel"><strong>get_ylabel</strong></a>(self)</dt><dd><tt>Get the ylabel text string.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_ylim"><strong>get_ylim</strong></a>(self)</dt><dd><tt>Get the y-axis range [*ymin*, *ymax*]</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_ymajorticklabels"><strong>get_ymajorticklabels</strong></a>(self)</dt><dd><tt>Get the xtick labels as a list of Text instances</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_yminorticklabels"><strong>get_yminorticklabels</strong></a>(self)</dt><dd><tt>Get the xtick labels as a list of Text instances</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_yscale"><strong>get_yscale</strong></a>(self)</dt></dl>
<dl><dt><a name="AxesSubplot-get_yticklabels"><strong>get_yticklabels</strong></a>(self, minor<font color="#909090">=False</font>)</dt><dd><tt>Get the xtick labels as a list of Text instances</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_yticklines"><strong>get_yticklines</strong></a>(self)</dt><dd><tt>Get the ytick lines as a list of Line2D instances</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_yticks"><strong>get_yticks</strong></a>(self, minor<font color="#909090">=False</font>)</dt><dd><tt>Return the y ticks as a list of locations</tt></dd></dl>
<dl><dt><a name="AxesSubplot-grid"><strong>grid</strong></a>(self, b<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-grid">grid</a>(self, b=None, **kwargs)<br>
<br>
Set the axes grids on or off; *b* is a boolean<br>
<br>
If *b* is *None* and ``len(kwargs)==0``, toggle the grid state. If<br>
*kwargs* are supplied, it is assumed that you want a grid and *b*<br>
is thus set to *True*<br>
<br>
*kawrgs* are used to set the grid line properties, eg::<br>
<br>
ax.<a href="#Subplot-grid">grid</a>(color='r', linestyle='-', linewidth=2)<br>
<br>
Valid :class:`~matplotlib.lines.Line2D` kwargs are<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================</tt></dd></dl>
<dl><dt><a name="AxesSubplot-has_data"><strong>has_data</strong></a>(self)</dt><dd><tt>Return *True* if any artists have been added to axes.<br>
<br>
This should not be used to determine whether the *dataLim*<br>
need to be updated, and may not actually be useful for<br>
anything.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-hexbin"><strong>hexbin</strong></a>(self, x, y, C<font color="#909090">=None</font>, gridsize<font color="#909090">=100</font>, bins<font color="#909090">=None</font>, xscale<font color="#909090">='linear'</font>, yscale<font color="#909090">='linear'</font>, cmap<font color="#909090">=None</font>, norm<font color="#909090">=None</font>, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>, alpha<font color="#909090">=1.0</font>, linewidths<font color="#909090">=None</font>, edgecolors<font color="#909090">='none'</font>, reduce_C_function<font color="#909090">=<function mean at 0x1eebaa0></font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-hexbin">hexbin</a>(x, y, C = None, gridsize = 100, bins = None,<br>
xscale = 'linear', yscale = 'linear',<br>
cmap=None, norm=None, vmin=None, vmax=None,<br>
alpha=1.0, linewidths=None, edgecolors='none'<br>
reduce_C_function = np.mean,<br>
**kwargs)<br>
<br>
Make a hexagonal binning plot of *x* versus *y*, where *x*,<br>
*y* are 1-D sequences of the same length, *N*. If *C* is None<br>
(the default), this is a histogram of the number of occurences<br>
of the observations at (x[i],y[i]).<br>
<br>
If *C* is specified, it specifies values at the coordinate<br>
(x[i],y[i]). These values are accumulated for each hexagonal<br>
bin and then reduced according to *reduce_C_function*, which<br>
defaults to numpy's mean function (np.mean). (If *C* is<br>
specified, it must also be a 1-D sequence of the same length<br>
as *x* and *y*.)<br>
<br>
*x*, *y* and/or *C* may be masked arrays, in which case only<br>
unmasked points will be plotted.<br>
<br>
Optional keyword arguments:<br>
<br>
*gridsize*: [ 100 | integer ]<br>
The number of hexagons in the *x*-direction, default is<br>
100. The corresponding number of hexagons in the<br>
*y*-direction is chosen such that the hexagons are<br>
approximately regular. Alternatively, gridsize can be a<br>
tuple with two elements specifying the number of hexagons<br>
in the *x*-direction and the *y*-direction.<br>
<br>
*bins*: [ None | 'log' | integer | sequence ]<br>
If *None*, no binning is applied; the color of each hexagon<br>
directly corresponds to its count value.<br>
<br>
If 'log', use a logarithmic scale for the color<br>
map. Internally, :math:`log_{10}(i+1)` is used to<br>
determine the hexagon color.<br>
<br>
If an integer, divide the counts in the specified number<br>
of bins, and color the hexagons accordingly.<br>
<br>
If a sequence of values, the values of the lower bound of<br>
the bins to be used.<br>
<br>
*xscale*: [ 'linear' | 'log' ]<br>
Use a linear or log10 scale on the horizontal axis.<br>
<br>
*scale*: [ 'linear' | 'log' ]<br>
Use a linear or log10 scale on the vertical axis.<br>
<br>
Other keyword arguments controlling color mapping and normalization<br>
arguments:<br>
<br>
*cmap*: [ None | Colormap ]<br>
a :class:`matplotlib.cm.Colormap` instance. If *None*,<br>
defaults to rc ``image.cmap``.<br>
<br>
*norm*: [ None | Normalize ]<br>
:class:`matplotlib.colors.Normalize` instance is used to<br>
scale luminance data to 0,1.<br>
<br>
*vmin*/*vmax*: scalar<br>
*vmin* and *vmax* are used in conjunction with *norm* to normalize<br>
luminance data. If either are *None*, the min and max of the color<br>
array *C* is used. Note if you pass a norm instance, your settings<br>
for *vmin* and *vmax* will be ignored.<br>
<br>
*alpha*: scalar<br>
the alpha value for the patches<br>
<br>
*linewidths*: [ None | scalar ]<br>
If *None*, defaults to rc lines.linewidth. Note that this<br>
is a tuple, and if you set the linewidths argument you<br>
must set it as a sequence of floats, as required by<br>
:class:`~matplotlib.collections.RegularPolyCollection`.<br>
<br>
Other keyword arguments controlling the Collection properties:<br>
<br>
*edgecolors*: [ None | mpl color | color sequence ]<br>
If 'none', draws the edges in the same color as the fill color.<br>
This is the default, as it avoids unsightly unpainted pixels<br>
between the hexagons.<br>
<br>
If *None*, draws the outlines in the default color.<br>
<br>
If a matplotlib color arg or sequence of rgba tuples, draws the<br>
outlines in the specified color.<br>
<br>
Here are the standard descriptions of all the<br>
:class:`~matplotlib.collections.Collection` kwargs:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================<br>
<br>
<br>
The return value is a<br>
:class:`~matplotlib.collections.PolyCollection` instance; use<br>
:meth:`~matplotlib.collection.PolyCollection.get_array` on<br>
this :class:`~matplotlib.collections.PolyCollection` to get<br>
the counts in each hexagon.<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/hexbin_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-hist"><strong>hist</strong></a>(self, x, bins<font color="#909090">=10</font>, range<font color="#909090">=None</font>, normed<font color="#909090">=False</font>, cumulative<font color="#909090">=False</font>, bottom<font color="#909090">=None</font>, histtype<font color="#909090">='bar'</font>, align<font color="#909090">='mid'</font>, orientation<font color="#909090">='vertical'</font>, rwidth<font color="#909090">=None</font>, log<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-hist">hist</a>(x, bins=10, range=None, normed=False, cumulative=False,<br>
bottom=None, histtype='bar', align='mid',<br>
orientation='vertical', rwidth=None, log=False, **kwargs)<br>
<br>
Compute the histogram of *x*. The return value is a tuple<br>
(*n*, *bins*, *patches*) or ([*n0*, *n1*, ...], *bins*,<br>
[*patches0*, *patches1*,...]) if the input contains multiple<br>
data.<br>
<br>
Keyword arguments:<br>
<br>
*bins*:<br>
either an integer number of bins or a sequence giving the<br>
bins. *x* are the data to be binned. *x* can be an array or a<br>
2D array with multiple data in its columns. Note, if *bins*<br>
is an integer input argument=numbins, *bins* + 1 bin edges<br>
will be returned, compatible with the semantics of<br>
:func:`numpy.histogram` with the *new* = True argument.<br>
Unequally spaced bins are supported if *bins* is a sequence.<br>
<br>
*range*:<br>
The lower and upper range of the bins. Lower and upper outliers<br>
are ignored. If not provided, *range* is (x.min(), x.max()).<br>
Range has no effect if *bins* is a sequence.<br>
<br>
*normed*:<br>
If *True*, the first element of the return tuple will<br>
be the counts normalized to form a probability density, i.e.,<br>
``n/(len(x)*dbin)``. In a probability density, the integral of<br>
the histogram should be 1; you can verify that with a<br>
trapezoidal integration of the probability density function::<br>
<br>
pdf, bins, patches = ax.<a href="#Subplot-hist">hist</a>(...)<br>
print np.sum(pdf * np.diff(bins))<br>
<br>
*cumulative*:<br>
If *True*, then a histogram is computed where each bin<br>
gives the counts in that bin plus all bins for smaller values.<br>
The last bin gives the total number of datapoints. If *normed*<br>
is also *True* then the histogram is normalized such that the<br>
last bin equals one. If *cumulative* evaluates to less than 0<br>
(e.g. -1), the direction of accumulation is reversed. In this<br>
case, if *normed* is also *True*, then the histogram is normalized<br>
such that the first bin equals 1.<br>
<br>
*histtype*: [ 'bar' | 'barstacked' | 'step' | 'stepfilled' ]<br>
The type of histogram to draw.<br>
<br>
- 'bar' is a traditional bar-type histogram<br>
<br>
- 'barstacked' is a bar-type histogram where multiple<br>
data are stacked on top of each other.<br>
<br>
- 'step' generates a lineplot that is by default<br>
unfilled<br>
<br>
- 'stepfilled' generates a lineplot that this by default<br>
filled.<br>
<br>
*align*: ['left' | 'mid' | 'right' ]<br>
Controls how the histogram is plotted.<br>
<br>
- 'left': bars are centered on the left bin edges<br>
<br>
- 'mid': bars are centered between the bin edges<br>
<br>
- 'right': bars are centered on the right bin edges.<br>
<br>
*orientation*: [ 'horizontal' | 'vertical' ]<br>
If 'horizontal', :func:`~matplotlib.pyplot.barh` will be<br>
used for bar-type histograms and the *bottom* kwarg will be<br>
the left edges.<br>
<br>
*rwidth*:<br>
the relative width of the bars as a fraction of the bin<br>
width. If *None*, automatically compute the width. Ignored<br>
if *histtype* = 'step'.<br>
<br>
*log*:<br>
If *True*, the histogram axis will be set to a log scale.<br>
If *log* is *True* and *x* is a 1D array, empty bins will<br>
be filtered out and only the non-empty (*n*, *bins*,<br>
*patches*) will be returned.<br>
<br>
kwargs are used to update the properties of the hist<br>
:class:`~matplotlib.patches.Rectangle` instances:<br>
<br>
<br>
=========== ===========================================================<br>
Property Description <br>
=========== ===========================================================<br>
aa [True | False] or None for default <br>
alpha float <br>
animated [True | False] <br>
antialiased [True | False] or None for default <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
contains unknown <br>
ec mpl color spec, or None for default, or 'none' for no color<br>
edgecolor mpl color spec, or None for default, or 'none' for no color<br>
facecolor mpl color spec, or None for default, or 'none' for no color<br>
fc mpl color spec, or None for default, or 'none' for no color<br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fill [True | False] <br>
hatch unknown <br>
label any string <br>
linestyle ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
linewidth float or None for default <br>
lod [True | False] <br>
ls ['solid' | 'dashed' | 'dashdot' | 'dotted'] <br>
lw float or None for default <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
=========== ===========================================================<br>
<br>
<br>
You can use labels for your histogram, and only the first<br>
:class:`~matplotlib.patches.Rectangle` gets the label (the<br>
others get the magic string '_nolegend_'. This will make the<br>
histograms work in the intuitive way for bar charts::<br>
<br>
ax.<a href="#Subplot-hist">hist</a>(10+2*np.random.randn(1000), label='men')<br>
ax.<a href="#Subplot-hist">hist</a>(12+3*np.random.randn(1000), label='women', alpha=0.5)<br>
ax.<a href="#Subplot-legend">legend</a>()<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/histogram_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-hlines"><strong>hlines</strong></a>(self, y, xmin, xmax, colors<font color="#909090">='k'</font>, linestyles<font color="#909090">='solid'</font>, label<font color="#909090">=''</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-hlines">hlines</a>(y, xmin, xmax, colors='k', linestyle='solid', **kwargs)<br>
<br>
Plot horizontal lines at each *y* from *xmin* to *xmax*.<br>
<br>
Returns the :class:`~matplotlib.collections.LineCollection`<br>
that was added.<br>
<br>
Required arguments:<br>
<br>
*y*:<br>
a 1-D numpy array or iterable.<br>
<br>
*xmin* and *xmax*:<br>
can be scalars or ``len(x)`` numpy arrays. If they are<br>
scalars, then the respective values are constant, else the<br>
widths of the lines are determined by *xmin* and *xmax*.<br>
<br>
Optional keyword arguments:<br>
<br>
*colors*:<br>
a line collections color argument, either a single color<br>
or a ``len(y)`` list of colors<br>
<br>
*linestyle*:<br>
[ 'solid' | 'dashed' | 'dashdot' | 'dotted' ]<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/hline_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-hold"><strong>hold</strong></a>(self, b<font color="#909090">=None</font>)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-hold">hold</a>(b=None)<br>
<br>
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>
Examples:<br>
<br>
* toggle hold:<br>
>>> <a href="#Subplot-hold">hold</a>()<br>
* turn hold on:<br>
>>> <a href="#Subplot-hold">hold</a>(True)<br>
* turn hold off<br>
>>> <a href="#Subplot-hold">hold</a>(False)<br>
<br>
<br>
When hold is True, subsequent plot commands will be added to<br>
the current axes. When hold is False, the current axes and<br>
figure will be cleared on the next plot command</tt></dd></dl>
<dl><dt><a name="AxesSubplot-imshow"><strong>imshow</strong></a>(self, X, cmap<font color="#909090">=None</font>, norm<font color="#909090">=None</font>, aspect<font color="#909090">=None</font>, interpolation<font color="#909090">=None</font>, alpha<font color="#909090">=1.0</font>, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>, origin<font color="#909090">=None</font>, extent<font color="#909090">=None</font>, shape<font color="#909090">=None</font>, filternorm<font color="#909090">=1</font>, filterrad<font color="#909090">=4.0</font>, imlim<font color="#909090">=None</font>, resample<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-imshow">imshow</a>(X, cmap=None, norm=None, aspect=None, interpolation=None,<br>
alpha=1.0, vmin=None, vmax=None, origin=None, extent=None,<br>
**kwargs)<br>
<br>
Display the image in *X* to current axes. *X* may be a float<br>
array, a uint8 array or a PIL image. If *X* is an array, *X*<br>
can have the following shapes:<br>
<br>
* MxN -- luminance (grayscale, float array only)<br>
* MxNx3 -- RGB (float or uint8 array)<br>
* MxNx4 -- RGBA (float or uint8 array)<br>
<br>
The value for each component of MxNx3 and MxNx4 float arrays should be<br>
in the range 0.0 to 1.0; MxN float arrays may be normalised.<br>
<br>
An :class:`matplotlib.image.AxesImage` instance is returned.<br>
<br>
Keyword arguments:<br>
<br>
*cmap*: [ None | Colormap ]<br>
A :class:`matplotlib.cm.Colormap` instance, eg. cm.jet.<br>
If *None*, default to rc ``image.cmap`` value.<br>
<br>
*cmap* is ignored when *X* has RGB(A) information<br>
<br>
*aspect*: [ None | 'auto' | 'equal' | scalar ]<br>
If 'auto', changes the image aspect ratio to match that of the axes<br>
<br>
If 'equal', and *extent* is *None*, changes the axes<br>
aspect ratio to match that of the image. If *extent* is<br>
not *None*, the axes aspect ratio is changed to match that<br>
of the extent.<br>
<br>
If *None*, default to rc ``image.aspect`` value.<br>
<br>
*interpolation*:<br>
Acceptable values are *None*, 'nearest', 'bilinear', 'bicubic',<br>
'spline16', 'spline36', 'hanning', 'hamming', 'hermite', 'kaiser',<br>
'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell', 'sinc',<br>
'lanczos', 'blackman'<br>
<br>
If *interpolation* is *None*, default to rc<br>
``image.interpolation``. See also the *filternorm* and<br>
*filterrad* parameters<br>
<br>
*norm*: [ None | Normalize ]<br>
An :class:`matplotlib.colors.Normalize` instance; if<br>
*None*, default is ``normalization()``. This scales<br>
luminance -> 0-1<br>
<br>
*norm* is only used for an MxN float array.<br>
<br>
*vmin*/*vmax*: [ None | scalar ]<br>
Used to scale a luminance image to 0-1. If either is<br>
*None*, the min and max of the luminance values will be<br>
used. Note if *norm* is not *None*, the settings for<br>
*vmin* and *vmax* will be ignored.<br>
<br>
*alpha*: scalar<br>
The alpha blending value, between 0 (transparent) and 1 (opaque)<br>
<br>
*origin*: [ None | 'upper' | 'lower' ]<br>
Place the [0,0] index of the array in the upper left or lower left<br>
corner of the axes. If *None*, default to rc ``image.origin``.<br>
<br>
*extent*: [ None | scalars (left, right, bottom, top) ]<br>
Eata values of the axes. The default assigns zero-based row,<br>
column indices to the *x*, *y* centers of the pixels.<br>
<br>
*shape*: [ None | scalars (columns, rows) ]<br>
For raw buffer images<br>
<br>
*filternorm*:<br>
A parameter for the antigrain image resize filter. From the<br>
antigrain documentation, if *filternorm* = 1, the filter normalizes<br>
integer values and corrects the rounding errors. It doesn't do<br>
anything with the source floating point values, it corrects only<br>
integers according to the rule of 1.0 which means that any sum of<br>
pixel weights must be equal to 1.0. So, the filter function must<br>
produce a graph of the proper shape.<br>
<br>
*filterrad*:<br>
The filter radius for filters that have a radius<br>
parameter, i.e. when interpolation is one of: 'sinc',<br>
'lanczos' or 'blackman'<br>
<br>
Additional kwargs are :class:`~matplotlib.artist.<a href="matplotlib.artist.html#Artist">Artist</a>` properties:<br>
<br>
<br>
========= ===============================================<br>
Property Description <br>
========= ===============================================<br>
alpha float <br>
animated [True | False] <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a<br>
contains unknown <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
lod [True | False] <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
========= ===============================================<br>
<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/image_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-in_axes"><strong>in_axes</strong></a>(self, mouseevent)</dt><dd><tt>return *True* if the given *mouseevent* (in display coords)<br>
is in the <a href="#Axes">Axes</a></tt></dd></dl>
<dl><dt><a name="AxesSubplot-invert_xaxis"><strong>invert_xaxis</strong></a>(self)</dt><dd><tt>Invert the x-axis.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-invert_yaxis"><strong>invert_yaxis</strong></a>(self)</dt><dd><tt>Invert the y-axis.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-ishold"><strong>ishold</strong></a>(self)</dt><dd><tt>return the HOLD status of the axes</tt></dd></dl>
<dl><dt><a name="AxesSubplot-legend"><strong>legend</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-legend">legend</a>(*args, **kwargs)<br>
<br>
Place a legend on the current axes at location *loc*. Labels are a<br>
sequence of strings and *loc* can be a string or an integer specifying<br>
the legend location.<br>
<br>
To make a legend with existing lines::<br>
<br>
<a href="#Subplot-legend">legend</a>()<br>
<br>
:meth:`legend` by itself will try and build a legend using the label<br>
property of the lines/patches/collections. You can set the label of<br>
a line by doing::<br>
<br>
<a href="#Subplot-plot">plot</a>(x, y, label='my data')<br>
<br>
or::<br>
<br>
line.<a href="#Subplot-set_label">set_label</a>('my data').<br>
<br>
If label is set to '_nolegend_', the item will not be shown in<br>
legend.<br>
<br>
To automatically generate the legend from labels::<br>
<br>
<a href="#Subplot-legend">legend</a>( ('label1', 'label2', 'label3') )<br>
<br>
To make a legend for a list of lines and labels::<br>
<br>
<a href="#Subplot-legend">legend</a>( (line1, line2, line3), ('label1', 'label2', 'label3') )<br>
<br>
To make a legend at a given location, using a location argument::<br>
<br>
<a href="#Subplot-legend">legend</a>( ('label1', 'label2', 'label3'), loc='upper left')<br>
<br>
or::<br>
<br>
<a href="#Subplot-legend">legend</a>( (line1, line2, line3), ('label1', 'label2', 'label3'), loc=2)<br>
<br>
The location codes are<br>
<br>
=============== =============<br>
Location String Location Code<br>
=============== =============<br>
'best' 0<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>
<br>
If none of these are locations are suitable, loc can be a 2-tuple<br>
giving x,y in axes coords, ie::<br>
<br>
loc = 0, 1 # left top<br>
loc = 0.5, 0.5 # center<br>
<br>
Keyword arguments:<br>
<br>
*isaxes*: [ True | False ]<br>
Indicates that this is an axes legend<br>
<br>
*numpoints*: integer<br>
The number of points in the legend line, default is 4<br>
<br>
*prop*: [ None | FontProperties ]<br>
A :class:`matplotlib.font_manager.FontProperties`<br>
instance, or *None* to use rc settings.<br>
<br>
*pad*: [ None | scalar ]<br>
The fractional whitespace inside the legend border, between 0 and 1.<br>
If *None*, use rc settings.<br>
<br>
*markerscale*: [ None | scalar ]<br>
The relative size of legend markers vs. original. If *None*, use rc<br>
settings.<br>
<br>
*shadow*: [ None | False | True ]<br>
If *True*, draw a shadow behind legend. If *None*, use rc settings.<br>
<br>
*labelsep*: [ None | scalar ]<br>
The vertical space between the legend entries. If *None*, use rc<br>
settings.<br>
<br>
*handlelen*: [ None | scalar ]<br>
The length of the legend lines. If *None*, use rc settings.<br>
<br>
*handletextsep*: [ None | scalar ]<br>
The space between the legend line and legend text. If *None*, use rc<br>
settings.<br>
<br>
*axespad*: [ None | scalar ]<br>
The border between the axes and legend edge. If *None*, use rc<br>
settings.<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/api/legend_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-loglog"><strong>loglog</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-loglog">loglog</a>(*args, **kwargs)<br>
<br>
Make a plot with log scaling on the *x* and *y* axis.<br>
<br>
:func:`~matplotlib.pyplot.loglog` supports all the keyword<br>
arguments of :func:`~matplotlib.pyplot.plot` and<br>
:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.set_xscale`/:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.set_yscale`.<br>
<br>
Notable keyword arguments:<br>
<br>
*basex*/*basey*: scalar > 1<br>
base of the *x*/*y* logarithm<br>
<br>
*subsx*/*subsy*: [ None | sequence ]<br>
the location of the minor *x*/*y* ticks; *None* defaults<br>
to autosubs, which depend on the number of decades in the<br>
plot; see<br>
:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.set_xscale`/:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.set_yscale`<br>
for details<br>
<br>
The remaining valid kwargs are<br>
:class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/log_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-matshow"><strong>matshow</strong></a>(self, Z, **kwargs)</dt><dd><tt>Plot a matrix or array as an image.<br>
<br>
The matrix will be shown the way it would be printed,<br>
with the first row at the top. Row and column numbering<br>
is zero-based.<br>
<br>
Argument:<br>
*Z* anything that can be interpreted as a 2-D array<br>
<br>
kwargs all are passed to :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.imshow`.<br>
:meth:`matshow` sets defaults for *extent*, *origin*,<br>
*interpolation*, and *aspect*; use care in overriding the<br>
*extent* and *origin* kwargs, because they interact. (Also,<br>
if you want to change them, you probably should be using<br>
imshow directly in your own version of matshow.)<br>
<br>
Returns: an :class:`matplotlib.image.AxesImage` instance.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-pcolor"><strong>pcolor</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signatures::<br>
<br>
<a href="#Subplot-pcolor">pcolor</a>(C, **kwargs)<br>
<a href="#Subplot-pcolor">pcolor</a>(X, Y, C, **kwargs)<br>
<br>
Create a pseudocolor plot of a 2-D array.<br>
<br>
*C* is the array of color values.<br>
<br>
*X* and *Y*, if given, specify the (*x*, *y*) coordinates of<br>
the colored quadrilaterals; the quadrilateral for C[i,j] has<br>
corners at::<br>
<br>
(X[i, j], Y[i, j]),<br>
(X[i, j+1], Y[i, j+1]),<br>
(X[i+1, j], Y[i+1, j]),<br>
(X[i+1, j+1], Y[i+1, j+1]).<br>
<br>
Ideally the dimensions of *X* and *Y* should be one greater<br>
than those of *C*; if the dimensions are the same, then the<br>
last row and column of *C* will be ignored.<br>
<br>
Note that the the column index corresponds to the<br>
*x*-coordinate, and the row index corresponds to *y*; for<br>
details, see the :ref:`Grid Orientation<br>
<axes-pcolor-grid-orientation>` section below.<br>
<br>
If either or both of *X* and *Y* are 1-D arrays or column vectors,<br>
they will be expanded as needed into the appropriate 2-D arrays,<br>
making a rectangular grid.<br>
<br>
*X*, *Y* and *C* may be masked arrays. If either C[i, j], or one<br>
of the vertices surrounding C[i,j] (*X* or *Y* at [i, j], [i+1, j],<br>
[i, j+1],[i+1, j+1]) is masked, nothing is plotted.<br>
<br>
Keyword arguments:<br>
<br>
*cmap*: [ None | Colormap ]<br>
A :class:`matplotlib.cm.Colormap` instance. If *None*, use<br>
rc settings.<br>
<br>
norm: [ None | Normalize ]<br>
An :class:`matplotlib.colors.Normalize` instance is used<br>
to scale luminance data to 0,1. If *None*, defaults to<br>
:func:`normalize`.<br>
<br>
*vmin*/*vmax*: [ None | scalar ]<br>
*vmin* and *vmax* are used in conjunction with *norm* to<br>
normalize luminance data. If either are *None*, the min<br>
and max of the color array *C* is used. If you pass a<br>
*norm* instance, *vmin* and *vmax* will be ignored.<br>
<br>
*shading*: [ 'flat' | 'faceted' ]<br>
If 'faceted', a black grid is drawn around each rectangle; if<br>
'flat', edges are not drawn. Default is 'flat', contrary to<br>
Matlab(TM).<br>
<br>
This kwarg is deprecated; please use 'edgecolors' instead:<br>
* shading='flat' -- edgecolors='None'<br>
* shading='faceted -- edgecolors='k'<br>
<br>
*edgecolors*: [ None | 'None' | color | color sequence]<br>
If *None*, the rc setting is used by default.<br>
<br>
If 'None', edges will not be visible.<br>
<br>
An mpl color or sequence of colors will set the edge color<br>
<br>
*alpha*: 0 <= scalar <= 1<br>
the alpha blending value<br>
<br>
Return value is a :class:`matplotlib.collection.Collection`<br>
instance.<br>
<br>
.. _axes-pcolor-grid-orientation:<br>
<br>
The grid orientation follows the Matlab(TM) convention: an<br>
array *C* with shape (*nrows*, *ncolumns*) is plotted with<br>
the column number as *X* and the row number as *Y*, increasing<br>
up; hence it is plotted the way the array would be printed,<br>
except that the *Y* axis is reversed. That is, *C* is taken<br>
as *C*(*y*, *x*).<br>
<br>
Similarly for :func:`~matplotlib.pyplot.meshgrid`::<br>
<br>
x = np.arange(5)<br>
y = np.arange(3)<br>
X, Y = meshgrid(x,y)<br>
<br>
is equivalent to:<br>
<br>
X = array([[0, 1, 2, 3, 4],<br>
[0, 1, 2, 3, 4],<br>
[0, 1, 2, 3, 4]])<br>
<br>
Y = array([[0, 0, 0, 0, 0],<br>
[1, 1, 1, 1, 1],<br>
[2, 2, 2, 2, 2]])<br>
<br>
so if you have::<br>
<br>
C = rand( len(x), len(y))<br>
<br>
then you need::<br>
<br>
<a href="#Subplot-pcolor">pcolor</a>(X, Y, C.T)<br>
<br>
or::<br>
<br>
<a href="#Subplot-pcolor">pcolor</a>(C.T)<br>
<br>
Matlab :func:`pcolor` always discards the last row and column<br>
of *C*, but matplotlib displays the last row and column if *X* and<br>
*Y* are not specified, or if *X* and *Y* have one more row and<br>
column than *C*.<br>
<br>
kwargs can be used to control the<br>
:class:`~matplotlib.collection.PolyCollection` properties:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================</tt></dd></dl>
<dl><dt><a name="AxesSubplot-pcolorfast"><strong>pcolorfast</strong></a>(self, *args, **kwargs)</dt><dd><tt>pseudocolor plot of a 2-D array<br>
<br>
Experimental; this is a version of pcolor that<br>
does not draw lines, that provides the fastest<br>
possible rendering with the Agg backend, and that<br>
can handle any quadrilateral grid.<br>
<br>
Call signatures::<br>
<br>
<a href="#Subplot-pcolor">pcolor</a>(C, **kwargs)<br>
<a href="#Subplot-pcolor">pcolor</a>(xr, yr, C, **kwargs)<br>
<a href="#Subplot-pcolor">pcolor</a>(x, y, C, **kwargs)<br>
<a href="#Subplot-pcolor">pcolor</a>(X, Y, C, **kwargs)<br>
<br>
C is the 2D array of color values corresponding to quadrilateral<br>
cells. Let (nr, nc) be its shape. C may be a masked array.<br>
<br>
``<a href="#Subplot-pcolor">pcolor</a>(C, **kwargs)`` is equivalent to<br>
``<a href="#Subplot-pcolor">pcolor</a>([0,nc], [0,nr], C, **kwargs)``<br>
<br>
*xr*, *yr* specify the ranges of *x* and *y* corresponding to the<br>
rectangular region bounding *C*. If::<br>
<br>
xr = [x0, x1]<br>
<br>
and::<br>
<br>
yr = [y0,y1]<br>
<br>
then *x* goes from *x0* to *x1* as the second index of *C* goes<br>
from 0 to *nc*, etc. (*x0*, *y0*) is the outermost corner of<br>
cell (0,0), and (*x1*, *y1*) is the outermost corner of cell<br>
(*nr*-1, *nc*-1). All cells are rectangles of the same size.<br>
This is the fastest version.<br>
<br>
*x*, *y* are 1D arrays of length *nc* +1 and *nr* +1, respectively,<br>
giving the x and y boundaries of the cells. Hence the cells are<br>
rectangular but the grid may be nonuniform. The speed is<br>
intermediate. (The grid is checked, and if found to be<br>
uniform the fast version is used.)<br>
<br>
*X* and *Y* are 2D arrays with shape (*nr* +1, *nc* +1) that specify<br>
the (x,y) coordinates of the corners of the colored<br>
quadrilaterals; the quadrilateral for C[i,j] has corners at<br>
(X[i,j],Y[i,j]), (X[i,j+1],Y[i,j+1]), (X[i+1,j],Y[i+1,j]),<br>
(X[i+1,j+1],Y[i+1,j+1]). The cells need not be rectangular.<br>
This is the most general, but the slowest to render. It may<br>
produce faster and more compact output using ps, pdf, and<br>
svg backends, however.<br>
<br>
Note that the the column index corresponds to the x-coordinate,<br>
and the row index corresponds to y; for details, see<br>
the "Grid Orientation" section below.<br>
<br>
Optional keyword arguments:<br>
<br>
*cmap*: [ None | Colormap ]<br>
A cm Colormap instance from cm. If None, use rc settings.<br>
*norm*: [ None | Normalize ]<br>
An mcolors.Normalize instance is used to scale luminance data to<br>
0,1. If None, defaults to normalize()<br>
*vmin*/*vmax*: [ None | scalar ]<br>
*vmin* and *vmax* are used in conjunction with norm to normalize<br>
luminance data. If either are *None*, the min and max of the color<br>
array *C* is used. If you pass a norm instance, *vmin* and *vmax*<br>
will be *None*.<br>
*alpha*: 0 <= scalar <= 1<br>
the alpha blending value<br>
<br>
Return value is an image if a regular or rectangular grid<br>
is specified, and a QuadMesh collection in the general<br>
quadrilateral case.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-pcolormesh"><strong>pcolormesh</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signatures::<br>
<br>
<a href="#Subplot-pcolormesh">pcolormesh</a>(C)<br>
<a href="#Subplot-pcolormesh">pcolormesh</a>(X, Y, C)<br>
<a href="#Subplot-pcolormesh">pcolormesh</a>(C, **kwargs)<br>
<br>
*C* may be a masked array, but *X* and *Y* may not. Masked<br>
array support is implemented via *cmap* and *norm*; in<br>
contrast, :func:`~matplotlib.pyplot.pcolor` simply does not<br>
draw quadrilaterals with masked colors or vertices.<br>
<br>
Keyword arguments:<br>
<br>
*cmap*: [ None | Colormap ]<br>
A :class:`matplotlib.cm.Colormap` instance. If None, use<br>
rc settings.<br>
<br>
*norm*: [ None | Normalize ]<br>
A :class:`matplotlib.colors.Normalize` instance is used to<br>
scale luminance data to 0,1. If None, defaults to<br>
:func:`normalize`.<br>
<br>
*vmin*/*vmax*: [ None | scalar ]<br>
*vmin* and *vmax* are used in conjunction with *norm* to<br>
normalize luminance data. If either are *None*, the min<br>
and max of the color array *C* is used. If you pass a<br>
*norm* instance, *vmin* and *vmax* will be ignored.<br>
<br>
*shading*: [ 'flat' | 'faceted' ]<br>
If 'faceted', a black grid is drawn around each rectangle; if<br>
'flat', edges are not drawn. Default is 'flat', contrary to<br>
Matlab(TM).<br>
<br>
This kwarg is deprecated; please use 'edgecolors' instead:<br>
* shading='flat' -- edgecolors='None'<br>
* shading='faceted -- edgecolors='k'<br>
<br>
*edgecolors*: [ None | 'None' | color | color sequence]<br>
If None, the rc setting is used by default.<br>
<br>
If 'None', edges will not be visible.<br>
<br>
An mpl color or sequence of colors will set the edge color<br>
<br>
*alpha*: 0 <= scalar <= 1<br>
the alpha blending value<br>
<br>
Return value is a :class:`matplotlib.collection.QuadMesh`<br>
object.<br>
<br>
See :func:`~matplotlib.pyplot.pcolor` for an explanation of<br>
the grid orientation and the expansion of 1-D *X* and/or *Y*<br>
to 2-D arrays.<br>
<br>
kwargs can be used to control the<br>
:class:`matplotlib.collections.QuadMesh`<br>
properties:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================</tt></dd></dl>
<dl><dt><a name="AxesSubplot-pick"><strong>pick</strong></a>(self, *args)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-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="AxesSubplot-pie"><strong>pie</strong></a>(self, x, explode<font color="#909090">=None</font>, labels<font color="#909090">=None</font>, colors<font color="#909090">=None</font>, autopct<font color="#909090">=None</font>, pctdistance<font color="#909090">=0.59999999999999998</font>, shadow<font color="#909090">=False</font>, labeldistance<font color="#909090">=1.1000000000000001</font>)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-pie">pie</a>(x, explode=None, labels=None,<br>
colors=('b', 'g', 'r', 'c', 'm', 'y', 'k', 'w'),<br>
autopct=None, pctdistance=0.6, labeldistance=1.1, shadow=False)<br>
<br>
Make a pie chart of array *x*. The fractional area of each<br>
wedge is given by x/sum(x). If sum(x) <= 1, then the values<br>
of x give the fractional area directly and the array will not<br>
be normalized.<br>
<br>
Keyword arguments:<br>
<br>
*explode*: [ None | len(x) sequence ]<br>
If not *None*, is a len(*x*) array which specifies the<br>
fraction of the radius with which to offset each wedge.<br>
<br>
*colors*: [ None | color sequence ]<br>
A sequence of matplotlib color args through which the pie chart<br>
will cycle.<br>
<br>
*labels*: [ None | len(x) sequence of strings ]<br>
A sequence of strings providing the labels for each wedge<br>
<br>
*autopct*: [ None | format string | format function ]<br>
If not *None*, is a string or function used to label the<br>
wedges with their numeric value. The label will be placed inside<br>
the wedge. If it is a format string, the label will be ``fmt%pct``.<br>
If it is a function, it will be called.<br>
<br>
*pctdistance*: scalar<br>
The ratio between the center of each pie slice and the<br>
start of the text generated by *autopct*. Ignored if<br>
*autopct* is *None*; default is 0.6.<br>
<br>
*labeldistance*: scalar<br>
The radial distance at which the pie labels are drawn<br>
<br>
*shadow*: [ False | True ]<br>
Draw a shadow beneath the pie.<br>
<br>
The pie chart will probably look best if the figure and axes are<br>
square. Eg.::<br>
<br>
figure(figsize=(8,8))<br>
ax = axes([0.1, 0.1, 0.8, 0.8])<br>
<br>
Return value:<br>
If *autopct* is None, return the tuple (*patches*, *texts*):<br>
<br>
- *patches* is a sequence of<br>
:class:`matplotlib.patches.Wedge` instances<br>
<br>
- *texts* is a list of the label<br>
:class:`matplotlib.text.Text` instances.<br>
<br>
If *autopct* is not *None*, return the tuple (*patches*,<br>
*texts*, *autotexts*), where *patches* and *texts* are as<br>
above, and *autotexts* is a list of<br>
:class:`~matplotlib.text.Text` instances for the numeric<br>
labels.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-plot"><strong>plot</strong></a>(self, *args, **kwargs)</dt><dd><tt>Plot lines and/or markers to the<br>
:class:`~matplotlib.axes.<a href="#Axes">Axes</a>`. *args* is a variable length<br>
argument, allowing for multiple *x*, *y* pairs with an<br>
optional format string. For example, each of the following is<br>
legal::<br>
<br>
<a href="#Subplot-plot">plot</a>(x, y) # plot x and y using the default line style and color<br>
<a href="#Subplot-plot">plot</a>(x, y, 'bo') # plot x and y using blue circle markers<br>
<a href="#Subplot-plot">plot</a>(y) # plot y using x as index array 0..N-1<br>
<a href="#Subplot-plot">plot</a>(y, 'r+') # ditto, but with red plusses<br>
<br>
If *x* and/or *y* is 2-dimensional, then the corresponding columns<br>
will be plotted.<br>
<br>
An arbitrary number of *x*, *y*, *fmt* groups can be<br>
specified, as in::<br>
<br>
a.<a href="#Subplot-plot">plot</a>(x1, y1, 'g^', x2, y2, 'g-')<br>
<br>
Return value is a list of lines that were added.<br>
<br>
The following line styles are supported::<br>
<br>
- # solid line<br>
-- # dashed line<br>
-. # dash-dot line<br>
: # dotted line<br>
. # points<br>
, # pixels<br>
o # circle symbols<br>
^ # triangle up symbols<br>
v # triangle down symbols<br>
< # triangle left symbols<br>
> # triangle right symbols<br>
s # square symbols<br>
+ # plus symbols<br>
x # cross symbols<br>
D # diamond symbols<br>
d # thin diamond symbols<br>
1 # tripod down symbols<br>
2 # tripod up symbols<br>
3 # tripod left symbols<br>
4 # tripod right symbols<br>
h # hexagon symbols<br>
H # rotated hexagon symbols<br>
p # pentagon symbols<br>
| # vertical line symbols<br>
_ # horizontal line symbols<br>
steps # use gnuplot style 'steps' # kwarg only<br>
<br>
The following color abbreviations are supported::<br>
<br>
b # blue<br>
g # green<br>
r # red<br>
c # cyan<br>
m # magenta<br>
y # yellow<br>
k # black<br>
w # white<br>
<br>
In addition, you can specify colors in many weird and<br>
wonderful ways, including full names (``'green'``), hex<br>
strings (``'#008000'``), RGB or RGBA tuples (``(0,1,0,1)``) or<br>
grayscale intensities as a string (``'0.8'``). Of these, the<br>
string specifications can be used in place of a ``fmt`` group,<br>
but the tuple forms can be used only as ``kwargs``.<br>
<br>
Line styles and colors are combined in a single format string, as in<br>
``'bo'`` for blue circles.<br>
<br>
The *kwargs* can be used to set line properties (any property that has<br>
a ``set_*`` method). You can use this to set a line label (for auto<br>
legends), linewidth, anitialising, marker face color, etc. Here is an<br>
example::<br>
<br>
<a href="#Subplot-plot">plot</a>([1,2,3], [1,2,3], 'go-', label='line 1', linewidth=2)<br>
<a href="#Subplot-plot">plot</a>([1,2,3], [1,4,9], 'rs', label='line 2')<br>
<a href="#Subplot-axis">axis</a>([0, 4, 0, 10])<br>
<a href="#Subplot-legend">legend</a>()<br>
<br>
If you make multiple lines with one plot command, the kwargs<br>
apply to all those lines, e.g.::<br>
<br>
<a href="#Subplot-plot">plot</a>(x1, y1, x2, y2, antialised=False)<br>
<br>
Neither line will be antialiased.<br>
<br>
The kwargs are :class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
kwargs *scalex* and *scaley*, if defined, are passed on to<br>
:meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.autoscale_view` to determine<br>
whether the *x* and *y* axes are autoscaled; the default is<br>
*True*.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-plot_date"><strong>plot_date</strong></a>(self, x, y, fmt<font color="#909090">='bo'</font>, tz<font color="#909090">=None</font>, xdate<font color="#909090">=True</font>, ydate<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-plot_date">plot_date</a>(x, y, fmt='bo', tz=None, xdate=True, ydate=False, **kwargs)<br>
<br>
Similar to the :func:`~matplotlib.pyplot.plot` command, except<br>
the *x* or *y* (or both) data is considered to be dates, and the<br>
axis is labeled accordingly.<br>
<br>
*x* and/or *y* can be a sequence of dates represented as float days since<br>
0001-01-01 UTC.<br>
<br>
See :mod:`~matplotlib.dates` for helper functions<br>
:func:`~matplotlib.dates.date2num`,<br>
:func:`~matplotlib.dates.num2date` and<br>
:func:`~matplotlib.dates.drange` for help on creating the<br>
required floating point dates.<br>
<br>
Keyword arguments:<br>
<br>
*fmt*: string<br>
The plot format string.<br>
<br>
*tz*: [ None | timezone string ]<br>
The time zone to use in labeling dates. If *None*, defaults to rc<br>
value.<br>
<br>
*xdate*: [ True | False ]<br>
If *True*, the *x*-axis will be labeled with dates.<br>
<br>
*ydate*: [ False | True ]<br>
If *True*, the *y*-axis will be labeled with dates.<br>
<br>
Note if you are using custom date tickers and formatters, it<br>
may be necessary to set the formatters/locators after the call<br>
to :meth:`plot_date` since :meth:`plot_date` will set the<br>
default tick locator to<br>
:class:`matplotlib.ticker.AutoDateLocator` (if the tick<br>
locator is not already set to a<br>
:class:`matplotlib.ticker.DateLocator` instance) and the<br>
default tick formatter to<br>
:class:`matplotlib.ticker.AutoDateFormatter` (if the tick<br>
formatter is not already set to a<br>
:class:`matplotlib.ticker.DateFormatter` instance).<br>
<br>
Valid kwargs are :class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================</tt></dd></dl>
<dl><dt><a name="AxesSubplot-psd"><strong>psd</strong></a>(self, x, NFFT<font color="#909090">=256</font>, Fs<font color="#909090">=2</font>, Fc<font color="#909090">=0</font>, detrend<font color="#909090">=<function detrend_none at 0x26b5ed8></font>, window<font color="#909090">=<function window_hanning at 0x26b5578></font>, noverlap<font color="#909090">=0</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-psd">psd</a>(x, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,<br>
window=mlab.window_hanning, noverlap=0, **kwargs)<br>
<br>
The power spectral density by Welches average periodogram<br>
method. The vector *x* is divided into *NFFT* length<br>
segments. Each segment is detrended by function *detrend* and<br>
windowed by function *window*. *noperlap* gives the length of<br>
the overlap between segments. The :math:`|\mathrm{fft}(i)|^2`<br>
of each segment :math:`i` are averaged to compute *Pxx*, with a<br>
scaling to correct for power loss due to windowing. *Fs* is the<br>
sampling frequency.<br>
<br>
Keyword arguments:<br>
<br>
*NFFT*: integer<br>
The length of the fft segment, must be a power of 2<br>
<br>
*Fs*: integer<br>
The sampling frequency.<br>
<br>
*Fc*: integer<br>
The center frequency of *x* (defaults to 0), which offsets<br>
the yextents of the image to reflect the frequency range used<br>
when a signal is acquired and then filtered and downsampled to<br>
baseband.<br>
<br>
*detrend*:<br>
The function applied to each segment before fft-ing,<br>
designed to remove the mean or linear trend. Unlike in<br>
matlab, where the *detrend* parameter is a vector, in<br>
matplotlib is it a function. The :mod:`~matplotlib.pylab`<br>
module defines :func:`~matplotlib.pylab.detrend_none`,<br>
:func:`~matplotlib.pylab.detrend_mean`, and<br>
:func:`~matplotlib.pylab.detrend_linear`, but you can use<br>
a custom function as well.<br>
<br>
*window*:<br>
The function used to window the segments. *window* is a<br>
function, unlike in matlab where it is a vector.<br>
:mod:`~matplotlib.pylab` defines<br>
:func:`~matplotlib.pylab.window_none`, and<br>
:func:`~matplotlib.pylab.window_hanning`, but you can use<br>
a custom function as well.<br>
<br>
*noverlap*: integer<br>
Gives the length of the overlap between segments.<br>
<br>
Returns the tuple (*Pxx*, *freqs*).<br>
<br>
For plotting, the power is plotted as<br>
:math:`10\log_{10}(P_{xx})` for decibels, though *Pxx* itself<br>
is returned.<br>
<br>
References:<br>
Bendat & Piersol -- Random Data: Analysis and Measurement<br>
Procedures, John Wiley & Sons (1986)<br>
<br>
kwargs control the :class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================</tt></dd></dl>
<dl><dt><a name="AxesSubplot-quiver"><strong>quiver</strong></a>(self, *args, **kw)</dt><dd><tt>Plot a 2-D field of arrows.<br>
<br>
call signatures::<br>
<br>
<a href="#Subplot-quiver">quiver</a>(U, V, **kw)<br>
<a href="#Subplot-quiver">quiver</a>(U, V, C, **kw)<br>
<a href="#Subplot-quiver">quiver</a>(X, Y, U, V, **kw)<br>
<a href="#Subplot-quiver">quiver</a>(X, Y, U, V, C, **kw)<br>
<br>
Arguments:<br>
<br>
*X*, *Y*:<br>
The x and y coordinates of the arrow locations<br>
(default is tail of arrow; see *pivot* kwarg)<br>
<br>
*U*, *V*:<br>
give the *x* and *y* components of the arrow vectors<br>
<br>
*C*:<br>
an optional array used to map colors to the arrows<br>
<br>
All arguments may be 1-D or 2-D arrays or sequences. If *X* and *Y*<br>
are absent, they will be generated as a uniform grid. If *U* and *V*<br>
are 2-D arrays but *X* and *Y* are 1-D, and if len(*X*) and len(*Y*)<br>
match the column and row dimensions of *U*, then *X* and *Y* will be<br>
expanded with :func:`numpy.meshgrid`.<br>
<br>
*U*, *V*, *C* may be masked arrays, but masked *X*, ** are not<br>
supported at present.<br>
<br>
Keyword arguments:<br>
<br>
*units*: ['width' | 'height' | 'dots' | 'inches' | 'x' | 'y' ]<br>
arrow units; the arrow dimensions *except for length* are<br>
in multiples of this unit.<br>
<br>
* 'width' or 'height': the width or height of the axes<br>
* 'dots' or 'inches': pixels or inches, based on the figure dpi<br>
* 'x' or 'y': *X* or *Y* data units<br>
<br>
In all cases the arrow aspect ratio is 1, so that if *U*==*V* the<br>
angle of the arrow on the plot is 45 degrees CCW from the *x*-axis.<br>
<br>
The arrows scale differently depending on the units, however.<br>
For 'x' or 'y', the arrows get larger as one zooms in; for other<br>
units, the arrow size is independent of the zoom state. For<br>
'width or 'height', the arrow size increases with the width and<br>
height of the axes, respectively, when the the window is resized;<br>
for 'dots' or 'inches', resizing does not change the arrows.<br>
<br>
*scale*: [ None | float ]<br>
data units per arrow unit, e.g. m/s per plot width;<br>
a smaller scale parameter makes the arrow longer.<br>
If *None*, a simple autoscaling algorithm is used, based<br>
on the average vector length and the number of vectors.<br>
<br>
*width*:<br>
shaft width in arrow units; default depends on choice of units,<br>
above, and number of vectors; a typical starting value is about<br>
0.005 times the width of the plot.<br>
<br>
*headwidth*: scalar<br>
head width as multiple of shaft width, default is 3<br>
<br>
*headlength*: scalar<br>
head length as multiple of shaft width, default is 5<br>
<br>
*headaxislength*: scalar<br>
head length at shaft intersection, default is 4.5<br>
<br>
*minshaft*: scalar<br>
length below which arrow scales, in units of head length. Do not<br>
set this to less than 1, or small arrows will look terrible!<br>
Default is 1<br>
<br>
*minlength*: scalar<br>
minimum length as a multiple of shaft width; if an arrow length<br>
is less than this, plot a dot (hexagon) of this diameter instead.<br>
Default is 1.<br>
<br>
*pivot*: [ 'tail' | 'middle' | 'tip' ]<br>
The part of the arrow that is at the grid point; the arrow<br>
rotates about this point, hence the name *pivot*.<br>
<br>
*color*: [ color | color sequence ]<br>
This is a synonym for the<br>
:class:`~matplotlib.collections.PolyCollection` facecolor kwarg.<br>
If *C* has been set, *color* has no effect.<br>
<br>
The defaults give a slightly swept-back arrow; to make the head a<br>
triangle, make *headaxislength* the same as *headlength*. To make the<br>
arrow more pointed, reduce *headwidth* or increase *headlength* and<br>
*headaxislength*. To make the head smaller relative to the shaft,<br>
scale down all the head parameters. You will probably do best to leave<br>
minshaft alone.<br>
<br>
linewidths and edgecolors can be used to customize the arrow<br>
outlines. Additional :class:`~matplotlib.collections.PolyCollection`<br>
keyword arguments:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================</tt></dd></dl>
<dl><dt><a name="AxesSubplot-quiverkey"><strong>quiverkey</strong></a>(self, *args, **kw)</dt><dd><tt>Add a key to a quiver plot.<br>
<br>
call signature::<br>
<br>
<a href="#Subplot-quiverkey">quiverkey</a>(Q, X, Y, U, label, **kw)<br>
<br>
Arguments:<br>
<br>
*Q*:<br>
The Quiver instance returned by a call to quiver.<br>
<br>
*X*, *Y*:<br>
The location of the key; additional explanation follows.<br>
<br>
*U*:<br>
The length of the key<br>
<br>
*label*:<br>
a string with the length and units of the key<br>
<br>
Keyword arguments:<br>
<br>
*coordinates* = [ 'axes' | 'figure' | 'data' | 'inches' ]<br>
Coordinate system and units for *X*, *Y*: 'axes' and 'figure'<br>
are normalized coordinate systems with 0,0 in the lower<br>
left and 1,1 in the upper right; 'data' are the axes<br>
data coordinates (used for the locations of the vectors<br>
in the quiver plot itself); 'inches' is position in the<br>
figure in inches, with 0,0 at the lower left corner.<br>
<br>
*color*:<br>
overrides face and edge colors from *Q*.<br>
<br>
*labelpos* = [ 'N' | 'S' | 'E' | 'W' ]<br>
Position the label above, below, to the right, to the left<br>
of the arrow, respectively.<br>
<br>
*labelsep*:<br>
Distance in inches between the arrow and the label.<br>
Default is 0.1<br>
<br>
*labelcolor*:<br>
defaults to default :class:`~matplotlib.text.Text` color.<br>
<br>
*fontproperties*:<br>
A dictionary with keyword arguments accepted by the<br>
:class:`~matplotlib.font_manager.FontProperties` initializer:<br>
*family*, *style*, *variant*, *size*, *weight*<br>
<br>
Any additional keyword arguments are used to override vector<br>
properties taken from *Q*.<br>
<br>
The positioning of the key depends on *X*, *Y*, *coordinates*, and<br>
*labelpos*. If *labelpos* is 'N' or 'S', *X*, *Y* give the position<br>
of the middle of the key arrow. If *labelpos* is 'E', *X*, *Y*<br>
positions the head, and if *labelpos* is 'W', *X*, *Y* positions the<br>
tail; in either of these two cases, *X*, *Y* is somewhere in the<br>
middle of the arrow+label key object.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-redraw_in_frame"><strong>redraw_in_frame</strong></a>(self)</dt><dd><tt>This method can only be used after an initial draw which<br>
caches the renderer. It is used to efficiently update <a href="#Axes">Axes</a><br>
data (axis ticks, labels, etc are not updated)</tt></dd></dl>
<dl><dt><a name="AxesSubplot-relim"><strong>relim</strong></a>(self)</dt><dd><tt>recompute the data limits based on current artists</tt></dd></dl>
<dl><dt><a name="AxesSubplot-scatter"><strong>scatter</strong></a>(self, x, y, s<font color="#909090">=20</font>, c<font color="#909090">='b'</font>, marker<font color="#909090">='o'</font>, cmap<font color="#909090">=None</font>, norm<font color="#909090">=None</font>, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>, alpha<font color="#909090">=1.0</font>, linewidths<font color="#909090">=None</font>, faceted<font color="#909090">=True</font>, verts<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signatures::<br>
<br>
<a href="#Subplot-scatter">scatter</a>(x, y, s=20, c='b', marker='o', cmap=None, norm=None,<br>
vmin=None, vmax=None, alpha=1.0, linewidths=None,<br>
verts=None, **kwargs)<br>
<br>
Make a scatter plot of *x* versus *y*, where *x*, *y* are 1-D<br>
sequences of the same length, *N*.<br>
<br>
Keyword arguments:<br>
<br>
*s*:<br>
size in points^2. It is a scalar or an array of the same<br>
length as *x* and *y*.<br>
<br>
*c*:<br>
a color. *c* can be a single color format string, or a<br>
sequence of color specifications of length *N*, or a<br>
sequence of *N* numbers to be mapped to colors using the<br>
*cmap* and *norm* specified via kwargs (see below). Note<br>
that *c* should not be a single numeric RGB or RGBA<br>
sequence because that is indistinguishable from an array<br>
of values to be colormapped. *c* can be a 2-D array in<br>
which the rows are RGB or RGBA, however.<br>
<br>
*marker*:<br>
can be one of:<br>
<br>
===== ==============<br>
Value Description<br>
===== ==============<br>
's' square<br>
'o' circle<br>
'^' triangle up<br>
'>' triangle right<br>
'v' triangle down<br>
'<' triangle left<br>
'd' diamond<br>
'p' pentagram<br>
'h' hexagon<br>
'8' octagon<br>
'+' plus<br>
'x' cross<br>
===== ==============<br>
<br>
The marker can also be a tuple (*numsides*, *style*,<br>
*angle*), which will create a custom, regular symbol.<br>
<br>
*numsides*:<br>
the number of sides<br>
<br>
*style*:<br>
the style of the regular symbol:<br>
<br>
===== =============================================<br>
Value Description<br>
===== =============================================<br>
0 a regular polygon<br>
1 a star-like symbol<br>
2 an asterisk<br>
3 a circle (*numsides* and *angle* is ignored)<br>
===== =============================================<br>
<br>
*angle*:<br>
the angle of rotation of the symbol<br>
<br>
Finally, *marker* can be (*verts*, 0): *verts* is a<br>
sequence of (*x*, *y*) vertices for a custom scatter<br>
symbol. Alternatively, use the kwarg combination<br>
*marker* = *None*, *verts* = *verts*.<br>
<br>
Any or all of *x*, *y*, *s*, and *c* may be masked arrays, in<br>
which case all masks will be combined and only unmasked points<br>
will be plotted.<br>
<br>
Other keyword arguments: the color mapping and normalization<br>
arguments will be used only if *c* is an array of floats.<br>
<br>
*cmap*: [ None | Colormap ]<br>
A :class:`matplotlib.colors.Colormap` instance. If *None*,<br>
defaults to rc ``image.cmap``. *cmap* is only used if *c*<br>
is an array of floats.<br>
<br>
*norm*: [ None | Normalize ]<br>
A :class:`matplotlib.colors.Normalize` instance is used to<br>
scale luminance data to 0, 1. If *None*, use the default<br>
:func:`normalize`. *norm* is only used if *c* is an array<br>
of floats.<br>
<br>
*vmin*/*vmax*:<br>
*vmin* and *vmax* are used in conjunction with norm to<br>
normalize luminance data. If either are None, the min and<br>
max of the color array *C* is used. Note if you pass a<br>
*norm* instance, your settings for *vmin* and *vmax* will<br>
be ignored.<br>
<br>
*alpha*: 0 <= scalar <= 1<br>
The alpha value for the patches<br>
<br>
*linewidths*: [ None | scalar | sequence ]<br>
If *None*, defaults to (lines.linewidth,). Note that this<br>
is a tuple, and if you set the linewidths argument you<br>
must set it as a sequence of floats, as required by<br>
:class:`~matplotlib.collections.RegularPolyCollection`.<br>
<br>
Optional kwargs control the<br>
:class:`~matplotlib.collections.Collection` properties; in<br>
particular:<br>
<br>
*edgecolors*:<br>
'none' to plot faces with no outlines<br>
<br>
*facecolors*:<br>
'none' to plot unfilled outlines<br>
<br>
Here are the standard descriptions of all the<br>
:class:`~matplotlib.collections.Collection` kwargs:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================<br>
<br>
<br>
A :class:`~matplotlib.collections.Collection` instance is<br>
returned.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-semilogx"><strong>semilogx</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-semilogx">semilogx</a>(*args, **kwargs)<br>
<br>
Make a plot with log scaling on the *x* axis.<br>
<br>
:func:`semilogx` supports all the keyword arguments of<br>
:func:`~matplotlib.pyplot.plot` and<br>
:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.set_xscale`.<br>
<br>
Notable keyword arguments:<br>
<br>
*basex*: scalar > 1<br>
base of the *x* logarithm<br>
<br>
*subsx*: [ None | sequence ]<br>
The location of the minor xticks; *None* defaults to<br>
autosubs, which depend on the number of decades in the<br>
plot; see :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.set_xscale` for<br>
details.<br>
<br>
The remaining valid kwargs are<br>
:class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
See :meth:`loglog` for example code and figure</tt></dd></dl>
<dl><dt><a name="AxesSubplot-semilogy"><strong>semilogy</strong></a>(self, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-semilogy">semilogy</a>(*args, **kwargs)<br>
<br>
Make a plot with log scaling on the *y* axis.<br>
<br>
:func:`semilogy` supports all the keyword arguments of<br>
:func:`~matplotlib.pylab.plot` and<br>
:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.set_yscale`.<br>
<br>
Notable keyword arguments:<br>
<br>
*basey*: scalar > 1<br>
Base of the *y* logarithm<br>
<br>
*subsy*: [ None | sequence ]<br>
The location of the minor yticks; *None* defaults to<br>
autosubs, which depend on the number of decades in the<br>
plot; see :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.set_yscale` for<br>
details.<br>
<br>
The remaining valid kwargs are<br>
:class:`~matplotlib.lines.Line2D` properties:<br>
<br>
<br>
====================== ====================================================================================================<br>
Property Description <br>
====================== ====================================================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased or aa [True | False] <br>
axes unknown <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color or c any matplotlib color <br>
contains unknown <br>
dash_capstyle ['butt' | 'round' | 'projecting'] <br>
dash_joinstyle ['miter' | 'round' | 'bevel'] <br>
dashes sequence of on/off ink in points <br>
data (np.array xdata, np.array ydata) <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle or ls [ '-' | '--' | '-.' | ':' | 'steps' | 'steps-pre' | 'steps-mid' | 'steps-post' | 'None' | ' ' | '' ]<br>
linewidth or lw float value in points <br>
lod [True | False] <br>
marker [ '+' | ',' | '.' | '1' | '2' | '3' | '4' <br>
markeredgecolor or mec any matplotlib color <br>
markeredgewidth or mew float value in points <br>
markerfacecolor or mfc any matplotlib color <br>
markersize or ms float <br>
picker unknown <br>
pickradius unknown <br>
solid_capstyle ['butt' | 'round' | 'projecting'] <br>
solid_joinstyle ['miter' | 'round' | 'bevel'] <br>
transform a matplotlib.transforms.Transform instance <br>
visible [True | False] <br>
xdata np.array <br>
ydata np.array <br>
zorder any number <br>
====================== ====================================================================================================<br>
<br>
<br>
See :meth:`loglog` for example code and figure</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_adjustable"><strong>set_adjustable</strong></a>(self, adjustable)</dt><dd><tt>ACCEPTS: [ 'box' | 'datalim' ]</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_anchor"><strong>set_anchor</strong></a>(self, anchor)</dt><dd><tt>*anchor*<br>
<br>
===== ============<br>
value description<br>
===== ============<br>
'C' Center<br>
'SW' bottom left<br>
'S' bottom<br>
'SE' bottom right<br>
'E' right<br>
'NE' top right<br>
'N' top<br>
'NW' top left<br>
'W' left<br>
===== ============</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_aspect"><strong>set_aspect</strong></a>(self, aspect, adjustable<font color="#909090">=None</font>, anchor<font color="#909090">=None</font>)</dt><dd><tt>*aspect*<br>
<br>
======== ================================================<br>
value description<br>
======== ================================================<br>
'auto' automatic; fill position rectangle with data<br>
'normal' same as 'auto'; deprecated<br>
'equal' same scaling from data to plot units for x and y<br>
num a circle will be stretched such that the height<br>
is num times the width. aspect=1 is the same as<br>
aspect='equal'.<br>
======== ================================================<br>
<br>
*adjustable*<br>
<br>
========= ============================<br>
value description<br>
========= ============================<br>
'box' change physical size of axes<br>
'datalim' change xlim or ylim<br>
========= ============================<br>
<br>
*anchor*<br>
<br>
===== =====================<br>
value description<br>
===== =====================<br>
'C' centered<br>
'SW' lower left corner<br>
'S' middle of bottom edge<br>
'SE' lower right corner<br>
etc.<br>
===== =====================</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_autoscale_on"><strong>set_autoscale_on</strong></a>(self, b)</dt><dd><tt>Set whether autoscaling is applied on plot commands<br>
<br>
accepts: [ *True* | *False* ]</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_axis_bgcolor"><strong>set_axis_bgcolor</strong></a>(self, color)</dt><dd><tt>set the axes background color<br>
<br>
ACCEPTS: any matplotlib color - see<br>
:func:`~matplotlib.pyplot.colors`</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_axis_off"><strong>set_axis_off</strong></a>(self)</dt><dd><tt>turn off the axis</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_axis_on"><strong>set_axis_on</strong></a>(self)</dt><dd><tt>turn on the axis</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_axisbelow"><strong>set_axisbelow</strong></a>(self, b)</dt><dd><tt>Set whether the axis ticks and gridlines are above or below most artists<br>
<br>
ACCEPTS: [ *True* | *False* ]</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_color_cycle"><strong>set_color_cycle</strong></a>(self, clist)</dt><dd><tt>Set the color cycle for any future plot commands on this <a href="#Axes">Axes</a>.<br>
<br>
clist is a list of mpl color specifiers.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_cursor_props"><strong>set_cursor_props</strong></a>(self, *args)</dt><dd><tt>Set the cursor property as::<br>
<br>
ax.<a href="#Subplot-set_cursor_props">set_cursor_props</a>(linewidth, color)<br>
<br>
or::<br>
<br>
ax.<a href="#Subplot-set_cursor_props">set_cursor_props</a>((linewidth, color))<br>
<br>
ACCEPTS: a (*float*, *color*) tuple</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the class:`~matplotlib.axes.<a href="#Axes">Axes</a>` figure<br>
<br>
accepts a class:`~matplotlib.figure.Figure` instance</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_frame_on"><strong>set_frame_on</strong></a>(self, b)</dt><dd><tt>Set whether the axes rectangle patch is drawn<br>
<br>
ACCEPTS: [ *True* | *False* ]</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_navigate"><strong>set_navigate</strong></a>(self, b)</dt><dd><tt>Set whether the axes responds to navigation toolbar commands<br>
<br>
ACCEPTS: [ True | False ]</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_navigate_mode"><strong>set_navigate_mode</strong></a>(self, b)</dt><dd><tt>Set the navigation toolbar button status;<br>
<br>
.. warning::<br>
this is not a user-API function.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_position"><strong>set_position</strong></a>(self, pos, which<font color="#909090">='both'</font>)</dt><dd><tt>Set the axes position with::<br>
<br>
pos = [left, bottom, width, height]<br>
<br>
in relative 0,1 coords, or *pos* can be a<br>
:class:`~matplotlib.transforms.Bbox`<br>
<br>
There are two position variables: one which is ultimately<br>
used, but which may be modified by :meth:`apply_aspect`, and a<br>
second which is the starting point for :meth:`apply_aspect`.<br>
<br>
<br>
Optional keyword arguments:<br>
*which*<br>
<br>
========== ====================<br>
value description<br>
========== ====================<br>
'active' to change the first<br>
'original' to change the second<br>
'both' to change both<br>
========== ====================</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_title"><strong>set_title</strong></a>(self, label, fontdict<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-set_title">set_title</a>(label, fontdict=None, **kwargs):<br>
<br>
Set the title for the axes. See the :meth:`text` for<br>
information of how override and the optional args work<br>
<br>
kwargs are Text properties:<br>
<br>
========================= =====================================================================<br>
Property Description <br>
========================= =====================================================================<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 :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color any matplotlib color <br>
contains unknown <br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br>
figure a :class:`matplotlib.figure.Figure` 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 unknown <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 <br>
========================= =====================================================================<br>
<br>
<br>
ACCEPTS: str</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_xbound"><strong>set_xbound</strong></a>(self, lower<font color="#909090">=None</font>, upper<font color="#909090">=None</font>)</dt><dd><tt>Set the lower and upper numerical bounds of the x-axis.<br>
This method will honor axes inversion regardless of parameter order.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_xlabel"><strong>set_xlabel</strong></a>(self, xlabel, fontdict<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-set_xlabel">set_xlabel</a>(xlabel, fontdict=None, **kwargs)<br>
<br>
Set the label for the xaxis. See the :meth:`text` docstring<br>
for information of how override and the optional args work.<br>
<br>
Valid kwargs are Text properties:<br>
<br>
========================= =====================================================================<br>
Property Description <br>
========================= =====================================================================<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 :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color any matplotlib color <br>
contains unknown <br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br>
figure a :class:`matplotlib.figure.Figure` 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 unknown <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 <br>
========================= =====================================================================<br>
<br>
ACCEPTS: str</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_xlim"><strong>set_xlim</strong></a>(self, xmin<font color="#909090">=None</font>, xmax<font color="#909090">=None</font>, emit<font color="#909090">=True</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-set_xlim">set_xlim</a>(self, *args, **kwargs)<br>
<br>
Set the limits for the xaxis<br>
<br>
Returns the current xlimits as a length 2 tuple: [*xmin*, *xmax*]<br>
<br>
Examples::<br>
<br>
<a href="#Subplot-set_xlim">set_xlim</a>((valmin, valmax))<br>
<a href="#Subplot-set_xlim">set_xlim</a>(valmin, valmax)<br>
<a href="#Subplot-set_xlim">set_xlim</a>(xmin=1) # xmax unchanged<br>
<a href="#Subplot-set_xlim">set_xlim</a>(xmax=1) # xmin unchanged<br>
<br>
Keyword arguments:<br>
<br>
*ymin*: scalar<br>
the min of the ylim<br>
*ymax*: scalar<br>
the max of the ylim<br>
*emit*: [ True | False ]<br>
notify observers of lim change<br>
<br>
ACCEPTS: len(2) sequence of floats</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_xscale"><strong>set_xscale</strong></a>(self, value, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-set_xscale">set_xscale</a>(value)<br>
<br>
Set the scaling of the x-axis: 'linear' | 'log' | 'symlog'<br>
<br>
ACCEPTS: ['linear' | 'log' | 'symlog']<br>
<br>
Different kwargs are accepted, depending on the scale:<br>
'linear'<br>
<br>
<br>
<br>
<br>
<br>
'log'<br>
<br>
*basex*/*basey*:<br>
The base of the logarithm<br>
<br>
*subsx*/*subsy*:<br>
Where to place the subticks between each major tick.<br>
Should be a sequence of integers. For example, in a log10<br>
scale: ``[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]``<br>
<br>
will place 10 logarithmically spaced minor ticks between<br>
each major tick.<br>
<br>
<br>
'symlog'<br>
<br>
*basex*/*basey*:<br>
The base of the logarithm<br>
<br>
*linthreshx*/*linthreshy*:<br>
The range (-*x*, *x*) within which the plot is linear (to<br>
avoid having the plot go to infinity around zero).<br>
<br>
*subsx*/*subsy*:<br>
Where to place the subticks between each major tick.<br>
Should be a sequence of integers. For example, in a log10<br>
scale: ``[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]``<br>
<br>
will place 10 logarithmically spaced minor ticks between<br>
each major tick.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_xticklabels"><strong>set_xticklabels</strong></a>(self, labels, fontdict<font color="#909090">=None</font>, minor<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-set_xticklabels">set_xticklabels</a>(labels, fontdict=None, minor=False, **kwargs)<br>
<br>
Set the xtick labels with list of strings *labels*. Return a<br>
list of axis text instances.<br>
<br>
*kwargs* set the :class:`~matplotlib.text.Text` properties.<br>
Valid properties are<br>
<br>
========================= =====================================================================<br>
Property Description <br>
========================= =====================================================================<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 :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color any matplotlib color <br>
contains unknown <br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br>
figure a :class:`matplotlib.figure.Figure` 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 unknown <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 <br>
========================= =====================================================================<br>
<br>
<br>
ACCEPTS: sequence of strings</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_xticks"><strong>set_xticks</strong></a>(self, ticks, minor<font color="#909090">=False</font>)</dt><dd><tt>Set the x ticks with list of *ticks*<br>
<br>
ACCEPTS: sequence of floats</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_ybound"><strong>set_ybound</strong></a>(self, lower<font color="#909090">=None</font>, upper<font color="#909090">=None</font>)</dt><dd><tt>Set the lower and upper numerical bounds of the y-axis.<br>
This method will honor axes inversion regardless of parameter order.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_ylabel"><strong>set_ylabel</strong></a>(self, ylabel, fontdict<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-set_ylabel">set_ylabel</a>(ylabel, fontdict=None, **kwargs)<br>
<br>
Set the label for the yaxis<br>
<br>
See the :meth:`text` doctstring for information of how<br>
override and the optional args work<br>
<br>
Valid kwargs are Text properties:<br>
<br>
========================= =====================================================================<br>
Property Description <br>
========================= =====================================================================<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 :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color any matplotlib color <br>
contains unknown <br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br>
figure a :class:`matplotlib.figure.Figure` 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 unknown <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 <br>
========================= =====================================================================<br>
<br>
ACCEPTS: str</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_ylim"><strong>set_ylim</strong></a>(self, ymin<font color="#909090">=None</font>, ymax<font color="#909090">=None</font>, emit<font color="#909090">=True</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-set_ylim">set_ylim</a>(self, *args, **kwargs):<br>
<br>
Set the limits for the yaxis; v = [ymin, ymax]::<br>
<br>
<a href="#Subplot-set_ylim">set_ylim</a>((valmin, valmax))<br>
<a href="#Subplot-set_ylim">set_ylim</a>(valmin, valmax)<br>
<a href="#Subplot-set_ylim">set_ylim</a>(ymin=1) # ymax unchanged<br>
<a href="#Subplot-set_ylim">set_ylim</a>(ymax=1) # ymin unchanged<br>
<br>
Keyword arguments:<br>
<br>
*ymin*: scalar<br>
the min of the ylim<br>
*ymax*: scalar<br>
the max of the ylim<br>
*emit*: [ True | False ]<br>
notify observers of lim change<br>
<br>
Returns the current ylimits as a length 2 tuple<br>
<br>
ACCEPTS: len(2) sequence of floats</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_yscale"><strong>set_yscale</strong></a>(self, value, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-set_yscale">set_yscale</a>(value)<br>
<br>
Set the scaling of the y-axis: 'linear' | 'log' | 'symlog'<br>
<br>
ACCEPTS: ['linear' | 'log' | 'symlog']<br>
<br>
Different kwargs are accepted, depending on the scale:<br>
'linear'<br>
<br>
<br>
<br>
<br>
<br>
'log'<br>
<br>
*basex*/*basey*:<br>
The base of the logarithm<br>
<br>
*subsx*/*subsy*:<br>
Where to place the subticks between each major tick.<br>
Should be a sequence of integers. For example, in a log10<br>
scale: ``[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]``<br>
<br>
will place 10 logarithmically spaced minor ticks between<br>
each major tick.<br>
<br>
<br>
'symlog'<br>
<br>
*basex*/*basey*:<br>
The base of the logarithm<br>
<br>
*linthreshx*/*linthreshy*:<br>
The range (-*x*, *x*) within which the plot is linear (to<br>
avoid having the plot go to infinity around zero).<br>
<br>
*subsx*/*subsy*:<br>
Where to place the subticks between each major tick.<br>
Should be a sequence of integers. For example, in a log10<br>
scale: ``[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]``<br>
<br>
will place 10 logarithmically spaced minor ticks between<br>
each major tick.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_yticklabels"><strong>set_yticklabels</strong></a>(self, labels, fontdict<font color="#909090">=None</font>, minor<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-set_yticklabels">set_yticklabels</a>(labels, fontdict=None, minor=False, **kwargs)<br>
<br>
Set the ytick labels with list of strings *labels*. Return a list of<br>
:class:`~matplotlib.text.Text` instances.<br>
<br>
*kwargs* set :class:`~matplotlib.text.Text` properties for the labels.<br>
Valid properties are<br>
<br>
========================= =====================================================================<br>
Property Description <br>
========================= =====================================================================<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 :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color any matplotlib color <br>
contains unknown <br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br>
figure a :class:`matplotlib.figure.Figure` 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 unknown <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 <br>
========================= =====================================================================<br>
<br>
<br>
ACCEPTS: sequence of strings</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_yticks"><strong>set_yticks</strong></a>(self, ticks, minor<font color="#909090">=False</font>)</dt><dd><tt>Set the y ticks with list of *ticks*<br>
<br>
ACCEPTS: sequence of floats<br>
<br>
Keyword arguments:<br>
<br>
*minor*: [ False | True ]<br>
Sets the minor ticks if True</tt></dd></dl>
<dl><dt><a name="AxesSubplot-specgram"><strong>specgram</strong></a>(self, x, NFFT<font color="#909090">=256</font>, Fs<font color="#909090">=2</font>, Fc<font color="#909090">=0</font>, detrend<font color="#909090">=<function detrend_none at 0x26b5ed8></font>, window<font color="#909090">=<function window_hanning at 0x26b5578></font>, noverlap<font color="#909090">=128</font>, cmap<font color="#909090">=None</font>, xextent<font color="#909090">=None</font>)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-specgram">specgram</a>(x, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,<br>
window = mlab.window_hanning, noverlap=128,<br>
cmap=None, xextent=None)<br>
<br>
Compute a spectrogram of data in *x*. Data are split into<br>
*NFFT* length segments and the PSD of each section is<br>
computed. The windowing function *window* is applied to each<br>
segment, and the amount of overlap of each segment is<br>
specified with *noverlap*.<br>
<br>
Keyword arguments:<br>
<br>
*cmap*:<br>
A :class:`matplotlib.cm.Colormap` instance; if *None* use<br>
default determined by rc<br>
<br>
*xextent*:<br>
The image extent in the xaxes xextent=xmin, xmax<br>
default 0, max(bins), 0, max(freqs) where bins is the return<br>
value from mlab.specgram<br>
<br>
See :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.psd` for information on the<br>
other keyword arguments.<br>
<br>
Return value is (*Pxx*, *freqs*, *bins*, *im*):<br>
<br>
- *bins* are the time points the spectrogram is calculated over<br>
- *freqs* is an array of frequencies<br>
- *Pxx* is a len(times) x len(freqs) array of power<br>
- *im* is a :class:`matplotlib.image.AxesImage` instance<br>
<br>
Note: If *x* is real (i.e. non-complex), only the positive<br>
spectrum is shown. If *x* is complex, both positive and<br>
negative parts of the spectrum are shown.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-spy"><strong>spy</strong></a>(self, Z, precision<font color="#909090">=None</font>, marker<font color="#909090">=None</font>, markersize<font color="#909090">=None</font>, aspect<font color="#909090">='equal'</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-spy">spy</a>(Z, precision=None, marker=None, markersize=None,<br>
aspect='equal', **kwargs)<br>
<br>
``<a href="#Subplot-spy">spy</a>(Z)`` plots the sparsity pattern of the 2-D array *Z*.<br>
<br>
If *precision* is *None*, any non-zero value will be plotted;<br>
else, values of :math:`|Z| > precision` will be plotted.<br>
<br>
The array will be plotted as it would be printed, with<br>
the first index (row) increasing down and the second<br>
index (column) increasing to the right.<br>
<br>
By default aspect is 'equal', so that each array element<br>
occupies a square space; set the aspect kwarg to 'auto'<br>
to allow the plot to fill the plot box, or to any scalar<br>
number to specify the aspect ratio of an array element<br>
directly.<br>
<br>
Two plotting styles are available: image or marker. Both<br>
are available for full arrays, but only the marker style<br>
works for :class:`scipy.sparse.spmatrix` instances.<br>
<br>
If *marker* and *markersize* are *None*, an image will be<br>
returned and any remaining kwargs are passed to<br>
:func:`~matplotlib.pyplot.imshow`; else, a<br>
:class:`~matplotlib.lines.Line2D` object will be returned with<br>
the value of marker determining the marker type, and any<br>
remaining kwargs passed to the<br>
:meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.plot` method.<br>
<br>
If *marker* and *markersize* are *None*, useful kwargs include:<br>
<br>
* *cmap*<br>
* *alpha*<br>
<br>
See documentation for :func:`~matplotlib.pyplot.imshow` for details.<br>
<br>
For controlling colors, e.g. cyan background and red marks,<br>
use::<br>
<br>
cmap = mcolors.ListedColormap(['c','r'])<br>
<br>
If *marker* or *markersize* is not *None*, useful kwargs include:<br>
<br>
* *marker*<br>
* *markersize*<br>
* *color*<br>
<br>
See documentation for :func:`~matplotlib.pyplot.plot` for details.<br>
<br>
Useful values for *marker* include:<br>
<br>
* 's' square (default)<br>
* 'o' circle<br>
* '.' point<br>
* ',' pixel</tt></dd></dl>
<dl><dt><a name="AxesSubplot-start_pan"><strong>start_pan</strong></a>(self, x, y, button)</dt><dd><tt>Called when a pan operation has started.<br>
<br>
*x*, *y* are the mouse coordinates in display coords.<br>
button is the mouse button number:<br>
<br>
* 1: LEFT<br>
* 2: MIDDLE<br>
* 3: RIGHT<br>
<br>
.. note::<br>
Intended to be overridden by new projection types.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-stem"><strong>stem</strong></a>(self, x, y, linefmt<font color="#909090">='b-'</font>, markerfmt<font color="#909090">='bo'</font>, basefmt<font color="#909090">='r-'</font>)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-stem">stem</a>(x, y, linefmt='b-', markerfmt='bo', basefmt='r-')<br>
<br>
A stem plot plots vertical lines (using *linefmt*) at each *x*<br>
location from the baseline to *y*, and places a marker there<br>
using *markerfmt*. A horizontal line at 0 is is plotted using<br>
*basefmt*.<br>
<br>
Return value is a tuple (*markerline*, *stemlines*,<br>
*baseline*).<br>
<br>
See `this document<br>
<<a href="http://www.mathworks.com/access/helpdesk/help/techdoc/ref/stem.html>`_">http://www.mathworks.com/access/helpdesk/help/techdoc/ref/stem.html>`_</a><br>
for details and :file:`examples/pylab_examples/stem_plot.py` for a demo.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-step"><strong>step</strong></a>(self, x, y, *args, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-step">step</a>(x, y, *args, **kwargs)<br>
<br>
Make a step plot. Additional keyword args to :func:`step` are the same<br>
as those for :func:`~matplotlib.pyplot.plot`.<br>
<br>
*x* and *y* must be 1-D sequences, and it is assumed, but not checked,<br>
that *x* is uniformly increasing.<br>
<br>
Keyword arguments:<br>
<br>
*where*: [ 'pre' | 'post' | 'mid' ]<br>
If 'pre', the interval from x[i] to x[i+1] has level y[i]<br>
<br>
If 'post', that interval has level y[i+1]<br>
<br>
If 'mid', the jumps in *y* occur half-way between the<br>
*x*-values.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-table"><strong>table</strong></a>(self, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-table">table</a>(cellText=None, cellColours=None,<br>
cellLoc='right', colWidths=None,<br>
rowLabels=None, rowColours=None, rowLoc='left',<br>
colLabels=None, colColours=None, colLoc='center',<br>
loc='bottom', bbox=None):<br>
<br>
Add a table to the current axes. Returns a<br>
:class:`matplotlib.table.Table` instance. For finer grained<br>
control over tables, use the :class:`~matplotlib.table.Table`<br>
class and add it to the axes with<br>
:meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.add_table`.<br>
<br>
Thanks to John Gill for providing the class and table.<br>
<br>
kwargs control the :class:`~matplotlib.table.Table`<br>
properties:<br>
<br>
<br>
========= ===============================================<br>
Property Description <br>
========= ===============================================<br>
alpha float <br>
animated [True | False] <br>
axes an axes instance <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a<br>
contains unknown <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
fontsize a float in points <br>
label any string <br>
lod [True | False] <br>
picker [None|float|boolean|callable] <br>
transform unknown <br>
visible [True | False] <br>
zorder any number <br>
========= ===============================================</tt></dd></dl>
<dl><dt><a name="AxesSubplot-text"><strong>text</strong></a>(self, x, y, s, fontdict<font color="#909090">=None</font>, withdash<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-text">text</a>(x, y, s, fontdict=None, **kwargs)<br>
<br>
Add text in string *s* to axis at location *x*, *y*, data<br>
coordinates.<br>
<br>
Keyword arguments:<br>
<br>
*fontdict*:<br>
A dictionary to override the default text properties.<br>
If *fontdict* is *None*, the defaults are determined by your rc<br>
parameters.<br>
<br>
*withdash*: [ False | True ]<br>
Creates a :class:`~matplotlib.text.TextWithDash` instance<br>
instead of a :class:`~matplotlib.text.Text` instance.<br>
<br>
Individual keyword arguments can be used to override any given<br>
parameter::<br>
<br>
<a href="#Subplot-text">text</a>(x, y, s, fontsize=12)<br>
<br>
The default transform specifies that text is in data coords,<br>
alternatively, you can specify text in axis coords (0,0 is<br>
lower-left and 1,1 is upper-right). The example below places<br>
text in the center of the axes::<br>
<br>
<a href="#Subplot-text">text</a>(0.5, 0.5,'matplotlib',<br>
horizontalalignment='center',<br>
verticalalignment='center',<br>
transform = ax.transAxes)<br>
<br>
You can put a rectangular box around the text instance (eg. to<br>
set a background color) by using the keyword *bbox*. *bbox* is<br>
a dictionary of :class:`matplotlib.patches.Rectangle`<br>
properties. For example::<br>
<br>
<a href="#Subplot-text">text</a>(x, y, s, bbox=dict(facecolor='red', alpha=0.5))<br>
<br>
Valid kwargs are :class:`matplotlib.text.Text` properties:<br>
<br>
<br>
========================= =====================================================================<br>
Property Description <br>
========================= =====================================================================<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 :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
color any matplotlib color <br>
contains unknown <br>
family [ 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br>
figure a :class:`matplotlib.figure.Figure` 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 unknown <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 <br>
========================= =====================================================================</tt></dd></dl>
<dl><dt><a name="AxesSubplot-ticklabel_format"><strong>ticklabel_format</strong></a>(self, **kwargs)</dt><dd><tt>Convenience method for manipulating the ScalarFormatter<br>
used by default for linear axes.<br>
<br>
Optional keyword arguments:<br>
<br>
======= =====================================<br>
Keyword Description<br>
======= =====================================<br>
*style* [ 'sci' (or 'scientific') | 'plain' ]<br>
plain turns off scientific notation<br>
*axis* [ 'x' | 'y' | 'both' ]<br>
======= =====================================<br>
<br>
Only the major ticks are affected.<br>
If the method is called when the<br>
:class:`~matplotlib.ticker.ScalarFormatter` is not the<br>
:class:`~matplotlib.ticker.Formatter` being used, an<br>
:exc:`AttributeError` will be raised with no additional error<br>
message.<br>
<br>
Additional capabilities and/or friendlier error checking may<br>
be added.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-twinx"><strong>twinx</strong></a>(self)</dt><dd><tt>call signature::<br>
<br>
ax = <a href="#Subplot-twinx">twinx</a>()<br>
<br>
create a twin of <a href="#Axes">Axes</a> for generating a plot with a sharex<br>
x-axis but independent y axis. The y-axis of self will have<br>
ticks on left and the returned axes will have ticks on the<br>
right</tt></dd></dl>
<dl><dt><a name="AxesSubplot-twiny"><strong>twiny</strong></a>(self)</dt><dd><tt>call signature::<br>
<br>
ax = <a href="#Subplot-twiny">twiny</a>()<br>
<br>
create a twin of <a href="#Axes">Axes</a> for generating a plot with a shared<br>
y-axis but independent x axis. The x-axis of self will have<br>
ticks on bottom and the returned axes will have ticks on the<br>
top</tt></dd></dl>
<dl><dt><a name="AxesSubplot-update_datalim"><strong>update_datalim</strong></a>(self, xys)</dt><dd><tt>Update the data lim bbox with seq of xy tups or equiv. 2-D array</tt></dd></dl>
<dl><dt><a name="AxesSubplot-update_datalim_bounds"><strong>update_datalim_bounds</strong></a>(self, bounds)</dt><dd><tt>Update the datalim to include the given<br>
:class:`~matplotlib.transforms.Bbox` *bounds*</tt></dd></dl>
<dl><dt><a name="AxesSubplot-update_datalim_numerix"><strong>update_datalim_numerix</strong></a>(self, x, y)</dt><dd><tt>Update the data lim bbox with seq of xy tups</tt></dd></dl>
<dl><dt><a name="AxesSubplot-vlines"><strong>vlines</strong></a>(self, x, ymin, ymax, colors<font color="#909090">='k'</font>, linestyles<font color="#909090">='solid'</font>, label<font color="#909090">=''</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-vlines">vlines</a>(x, ymin, ymax, color='k')<br>
<br>
Plot vertical lines at each *x* from *ymin* to *ymax*. *ymin*<br>
or *ymax* can be scalars or len(*x*) numpy arrays. If they are<br>
scalars, then the respective values are constant, else the<br>
heights of the lines are determined by *ymin* and *ymax*.<br>
<br>
*colors* is a line collections color args, either a single color<br>
or a len(*x*) list of colors<br>
<br>
*linestyle* is one of [ 'solid' | 'dashed' | 'dashdot' | 'dotted' ]<br>
<br>
Returns the :class:`matplotlib.collections.LineCollection`<br>
that was added.<br>
<br>
kwargs are :class:`~matplotlib.collections.LineCollection` properties:<br>
<br>
<br>
============ ======================================================================<br>
Property Description <br>
============ ======================================================================<br>
alpha float <br>
animated [True | False] <br>
antialiased Boolean or sequence of booleans <br>
antialiaseds Boolean or sequence of booleans <br>
array unknown <br>
axes an axes instance <br>
clim a length 2 sequence of floats <br>
clip_box a :class:`matplotlib.transform.Bbox` instance <br>
clip_on [True | False] <br>
clip_path a :class:`~matplotlib.path.Path` instance and a <br>
cmap a colormap <br>
color matplotlib color arg or sequence of rgba tuples <br>
colorbar unknown <br>
contains unknown <br>
dashes ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
edgecolor matplotlib color arg or sequence of rgba tuples <br>
edgecolors matplotlib color arg or sequence of rgba tuples <br>
facecolor matplotlib color arg or sequence of rgba tuples <br>
facecolors matplotlib color arg or sequence of rgba tuples <br>
figure a :class:`matplotlib.figure.Figure` instance <br>
label any string <br>
linestyle ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linestyles ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]<br>
linewidth float or sequence of floats <br>
linewidths float or sequence of floats <br>
lod [True | False] <br>
lw float or sequence of floats <br>
norm unknown <br>
offsets float or sequence of floats <br>
picker [None|float|boolean|callable] <br>
pickradius unknown <br>
segments unknown <br>
transform unknown <br>
verts unknown <br>
visible [True | False] <br>
zorder any number <br>
============ ======================================================================</tt></dd></dl>
<dl><dt><a name="AxesSubplot-xaxis_date"><strong>xaxis_date</strong></a>(self, tz<font color="#909090">=None</font>)</dt><dd><tt>Sets up x-axis ticks and labels that treat the x data as dates.<br>
<br>
*tz* is the time zone to use in labeling dates. Defaults to rc value.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-xaxis_inverted"><strong>xaxis_inverted</strong></a>(self)</dt><dd><tt>Returns True if the x-axis is inverted.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-xcorr"><strong>xcorr</strong></a>(self, x, y, normed<font color="#909090">=False</font>, detrend<font color="#909090">=<function detrend_none at 0x26b5ed8></font>, usevlines<font color="#909090">=False</font>, maxlags<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>call signature::<br>
<br>
<a href="#Subplot-xcorr">xcorr</a>(x, y, normed=False, detrend=mlab.detrend_none,<br>
usevlines=False, **kwargs):<br>
<br>
Plot the cross correlation between *x* and *y*. If *normed* =<br>
*True*, normalize the data but the cross correlation at 0-th<br>
lag. *x* and y are detrended by the *detrend* callable<br>
(default no normalization). *x* and *y* must be equal length.<br>
<br>
Data are plotted as ``<a href="#Subplot-plot">plot</a>(lags, c, **kwargs)``<br>
<br>
Return value is a tuple (*lags*, *c*, *line*) where:<br>
<br>
- *lags* are a length ``2*maxlags+1`` lag vector<br>
<br>
- *c* is the ``2*maxlags+1`` auto correlation vector<br>
<br>
- *line* is a :class:`~matplotlib.lines.Line2D` instance<br>
returned by :func:`~matplotlib.pyplot.plot`.<br>
<br>
The default *linestyle* is *None* and the default *marker* is<br>
'o', though these can be overridden with keyword args. The<br>
cross correlation is performed with :func:`numpy.correlate`<br>
with *mode* = 2.<br>
<br>
If *usevlines* is *True*:<br>
<br>
:func:`~matplotlib.pyplot.vlines`<br>
rather than :func:`~matplotlib.pyplot.plot` is used to draw<br>
vertical lines from the origin to the xcorr. Otherwise the<br>
plotstyle is determined by the kwargs, which are<br>
:class:`~matplotlib.lines.Line2D` properties.<br>
<br>
The return value is a tuple (*lags*, *c*, *linecol*, *b*)<br>
where *linecol* is the<br>
:class:`matplotlib.collections.LineCollection` instance and<br>
*b* is the *x*-axis.<br>
<br>
*maxlags* is a positive integer detailing the number of lags to show.<br>
The default value of *None* will return all ``(2*len(x)-1)`` lags.<br>
<br>
**Example:**<br>
<br>
:func:`~matplotlib.pyplot.xcorr` above, and<br>
:func:`~matplotlib.pyplot.acorr` below.<br>
<br>
**Example:**<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/xcorr_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-yaxis_date"><strong>yaxis_date</strong></a>(self, tz<font color="#909090">=None</font>)</dt><dd><tt>Sets up y-axis ticks and labels that treat the y data as dates.<br>
<br>
*tz* is the time zone to use in labeling dates. Defaults to rc value.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-yaxis_inverted"><strong>yaxis_inverted</strong></a>(self)</dt><dd><tt>Returns True if the y-axis is inverted.</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.axes.html#Axes">Axes</a>:<br>
<dl><dt><strong>name</strong> = 'rectilinear'</dl>
<dl><dt><strong>x</strong> = 'symlog'</dl>
<hr>
Methods inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><a name="AxesSubplot-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="AxesSubplot-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="AxesSubplot-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="AxesSubplot-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Subplot-findobj">findobj</a>(o=gcf(), match=None) <br>
<br>
recursively find all :class:matplotlib.artist.<a href="matplotlib.artist.html#Artist">Artist</a> instances<br>
contained in self<br>
<br>
*match* can be<br>
<br>
- None: return all objects contained in artist (including artist)<br>
<br>
- function with signature ``boolean = match(artist)`` used to filter matches<br>
<br>
- class instance: eg Line2D. Only return artists of class type<br>
<br>
.. plot:: ../mpl_examples/pylab_examples/findobj_demo.py</tt></dd></dl>
<dl><dt><a name="AxesSubplot-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="AxesSubplot-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_axes"><strong>get_axes</strong></a>(self)</dt><dd><tt>return the axes instance the artist resides in, or *None*</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="AxesSubplot-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="AxesSubplot-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="AxesSubplot-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="AxesSubplot-get_figure"><strong>get_figure</strong></a>(self)</dt><dd><tt>Return the :class:`~matplotlib.figure.Figure` instance the<br>
artist belongs to.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="AxesSubplot-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="AxesSubplot-get_transform"><strong>get_transform</strong></a>(self)</dt><dd><tt>Return the :class:`~matplotlib.transforms.Transform`<br>
instance used by this artist.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_transformed_clip_path_and_affine"><strong>get_transformed_clip_path_and_affine</strong></a>(self)</dt><dd><tt>Return the clip path with the non-affine part of its<br>
transformation applied, and the remaining affine part of its<br>
transformation.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="AxesSubplot-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="AxesSubplot-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="AxesSubplot-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="AxesSubplot-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="AxesSubplot-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="AxesSubplot-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="AxesSubplot-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="AxesSubplot-remove"><strong>remove</strong></a>(self)</dt><dd><tt>Remove the artist from the figure if possible. The effect<br>
will not be visible until the figure is redrawn, e.g., with<br>
:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.draw_idle`. Call<br>
:meth:`matplotlib.axes.<a href="#Axes">Axes</a>.relim` to update the axes limits<br>
if desired.<br>
<br>
Note: :meth:`~matplotlib.axes.<a href="#Axes">Axes</a>.relim` will not see<br>
collections even if the collection was added to axes with<br>
*autolim* = True.<br>
<br>
Note: there is no support for removing the artist's legend entry.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="AxesSubplot-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="AxesSubplot-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="AxesSubplot-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="AxesSubplot-set_axes"><strong>set_axes</strong></a>(self, axes)</dt><dd><tt>set the axes instance in which the artist resides, if any<br>
<br>
ACCEPTS: an axes instance</tt></dd></dl>
<dl><dt><a name="AxesSubplot-set_clip_box"><strong>set_clip_box</strong></a>(self, clipbox)</dt><dd><tt>Set the artist's clip Bbox<br>
<br>
ACCEPTS: a :class:`matplotlib.transform.Bbox` instance</tt></dd></dl>
<dl><dt><a name="AxesSubplot-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="AxesSubplot-set_clip_path"><strong>set_clip_path</strong></a>(self, path, transform<font color="#909090">=None</font>)</dt><dd><tt>Set the artist's clip path, which may be:<br>
<br>
* a :class:`~matplotlib.patches.Patch` (or subclass) instance<br>
<br>
* a :class:`~matplotlib.path.Path` instance, in which case<br>
an optional :class:`~matplotlib.transforms.Transform`<br>
instance may be provided, which will be applied to the<br>
path before using it for clipping.<br>
<br>
* *None*, to remove the clipping path<br>
<br>
For efficiency, if the path happens to be an axis-aligned<br>
rectangle, this method will set the clipping box to the<br>
corresponding rectangle and set the clipping path to *None*.<br>
<br>
ACCEPTS: a :class:`~matplotlib.path.Path` instance and a<br>
:class:`~matplotlib.transforms.Transform` instance, a<br>
:class:`~matplotlib.patches.Patch` instance, or *None*.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-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="AxesSubplot-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="AxesSubplot-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="AxesSubplot-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>
* A 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>
* A float: if picker is a number it is interpreted as an<br>
epsilon tolerance in points and 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, e.g. the indices of the data within<br>
epsilon of the pick event<br>
<br>
* A 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="AxesSubplot-set_transform"><strong>set_transform</strong></a>(self, t)</dt><dd><tt>Set the :class:`~matplotlib.transforms.Transform` instance<br>
used by this artist.</tt></dd></dl>
<dl><dt><a name="AxesSubplot-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="AxesSubplot-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="AxesSubplot-update"><strong>update</strong></a>(self, props)</dt></dl>
<dl><dt><a name="AxesSubplot-update_from"><strong>update_from</strong></a>(self, other)</dt><dd><tt>Copy properties from *other* to *self*.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</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="SubplotBase">class <strong>SubplotBase</strong></a></font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Base class for subplots, which are <a href="#Axes">Axes</a> instances with additional<br>
methods to facilitate generating and manipulating a set of <a href="#Axes">Axes</a><br>
within a figure.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="SubplotBase-__init__"><strong>__init__</strong></a>(self, fig, *args, **kwargs)</dt><dd><tt>fig is a figure instance<br>
<br>
args is numRows, numCols, plotNum<br>
where the array of subplots in the figure has dimensions<br>
numRows, numCols, and where plotNum is the number of the<br>
subplot being created. plotNum starts at 1 in the upper<br>
right corner and increases to the right.<br>
<br>
If numRows<=numCols<=plotNum<10, args can be the decimal<br>
integer numRows*100 + numCols*10 + plotNum.</tt></dd></dl>
<dl><dt><a name="SubplotBase-change_geometry"><strong>change_geometry</strong></a>(self, numrows, numcols, num)</dt><dd><tt>change subplot geometry, eg from 1,1,1 to 2,2,3</tt></dd></dl>
<dl><dt><a name="SubplotBase-get_geometry"><strong>get_geometry</strong></a>(self)</dt><dd><tt>get the subplot geometry, eg 2,2,3</tt></dd></dl>
<dl><dt><a name="SubplotBase-is_first_col"><strong>is_first_col</strong></a>(self)</dt></dl>
<dl><dt><a name="SubplotBase-is_first_row"><strong>is_first_row</strong></a>(self)</dt></dl>
<dl><dt><a name="SubplotBase-is_last_col"><strong>is_last_col</strong></a>(self)</dt></dl>
<dl><dt><a name="SubplotBase-is_last_row"><strong>is_last_row</strong></a>(self)</dt></dl>
<dl><dt><a name="SubplotBase-label_outer"><strong>label_outer</strong></a>(self)</dt><dd><tt>set the visible property on ticklabels so xticklabels are<br>
visible only if the subplot is in the last row and yticklabels<br>
are visible only if the subplot is in the first column</tt></dd></dl>
<dl><dt><a name="SubplotBase-update_params"><strong>update_params</strong></a>(self)</dt><dd><tt>update the subplot position from fig.subplotpars</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="-set_default_color_cycle"><strong>set_default_color_cycle</strong></a>(clist)</dt><dd><tt>Change the default cycle of colors that will be used by the plot<br>
command. This must be called before creating the<br>
:class:`<a href="#Axes">Axes</a>` to which it will apply; it will<br>
apply to all future axes.<br>
<br>
*clist* is a sequence of mpl color specifiers</tt></dd></dl>
<dl><dt><a name="-subplot_class_factory"><strong>subplot_class_factory</strong></a>(axes_class<font color="#909090">=None</font>)</dt></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>division</strong> = _Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)<br>
<strong>generators</strong> = _Feature((2, 2, 0, 'alpha', 1), (2, 3, 0, 'final', 0), 0)<br>
<strong>rcParams</strong> = {'figure.subplot.right': 0.90000000000000002, 'm...persize': 'letter', 'svg.embed_char_paths': True}</td></tr></table>
@footer@
