Menu
▾
▴
[r8989]: / trunk / htdocs / matplotlib.quiver.html.template Maximize Restore History
1516 lines (1266 with data), 132.5 kB
@header@
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="matplotlib.html"><font color="#ffffff">matplotlib</font></a>.quiver</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/quiver.py">/home/jdhunter/dev/lib64/python2.5/site-packages/matplotlib/quiver.py</a></font></td></tr></table>
<p><tt>Support for plotting vector fields.<br>
<br>
Presently this contains <a href="#Quiver">Quiver</a> and Barb. <a href="#Quiver">Quiver</a> plots an arrow in the<br>
direction of the vector, with the size of the arrow related to the<br>
magnitude of the vector.<br>
<br>
<a href="#Barbs">Barbs</a> are like quiver in that they point along a vector, but<br>
the magnitude of the vector is given schematically by the presence of barbs<br>
or flags on the barb.<br>
<br>
This will also become a home for things such as standard<br>
deviation ellipses, which can and will be derived very easily from<br>
the <a href="#Quiver">Quiver</a> code.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="matplotlib.collections.html">matplotlib.collections</a><br>
<a href="matplotlib.font_manager.html">matplotlib.font_manager</a><br>
</td><td width="25%" valign=top><a href="numpy.ma.html">numpy.ma</a><br>
<a href="matplotlib.artist.html">matplotlib.artist</a><br>
</td><td width="25%" valign=top><a href="math.html">math</a><br>
<a href="matplotlib.text.html">matplotlib.text</a><br>
</td><td width="25%" valign=top><a href="numpy.html">numpy</a><br>
<a href="matplotlib.transforms.html">matplotlib.transforms</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.quiver.html#QuiverKey">QuiverKey</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="matplotlib.collections.html#PolyCollection">matplotlib.collections.PolyCollection</a>(<a href="matplotlib.collections.html#Collection">matplotlib.collections.Collection</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="matplotlib.quiver.html#Barbs">Barbs</a>
</font></dt><dt><font face="helvetica, arial"><a href="matplotlib.quiver.html#Quiver">Quiver</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="Barbs">class <strong>Barbs</strong></a>(<a href="matplotlib.collections.html#PolyCollection">matplotlib.collections.PolyCollection</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Specialized <a href="matplotlib.collections.html#PolyCollection">PolyCollection</a> for barbs.<br>
<br>
The only API method is <a href="#Barbs-set_UVC">set_UVC</a>(), which can be used<br>
to change the size, orientation, and color of the<br>
arrows. Locations are changed using the <a href="#Barbs-set_offsets">set_offsets</a>() collection<br>
method.Possibly this method will be useful in animations.<br>
<br>
There is one internal function _find_tails() which finds exactly<br>
what should be put on the barb given the vector magnitude. From there<br>
_make_barbs() is used to find the vertices of the polygon to represent the<br>
barb based on this information.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.quiver.html#Barbs">Barbs</a></dd>
<dd><a href="matplotlib.collections.html#PolyCollection">matplotlib.collections.PolyCollection</a></dd>
<dd><a href="matplotlib.collections.html#Collection">matplotlib.collections.Collection</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
<dd><a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Barbs-__init__"><strong>__init__</strong></a>(self, ax, *args, **kw)</dt><dd><tt> The constructor takes one required argument, an Axes<br>
instance, followed by the args and kwargs described<br>
by the following pylab interface documentation:<br>
<br>
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>
<a href="#Barbs">Barbs</a> 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.<a href="matplotlib.collections.html#PolyCollection">PolyCollection</a>`<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="Barbs-set_UVC"><strong>set_UVC</strong></a>(self, U, V, C<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="Barbs-set_offsets"><strong>set_offsets</strong></a>(self, xy)</dt><dd><tt>Set the offsets for the collection. *offsets* can be a scalar<br>
or a sequence.<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>barbs_doc</strong> = '<font color="#c040c0">\n</font>Plot a 2-D field of barbs.<font color="#c040c0">\n\n</font>call signatures::<font color="#c040c0">\n\n</font>...===============================================<font color="#c040c0">\n\n</font>'</dl>
<hr>
Methods inherited from <a href="matplotlib.collections.html#PolyCollection">matplotlib.collections.PolyCollection</a>:<br>
<dl><dt><a name="Barbs-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Barbs-get_paths"><strong>get_paths</strong></a>(self)</dt></dl>
<dl><dt><a name="Barbs-set_verts"><strong>set_verts</strong></a>(self, verts, closed<font color="#909090">=True</font>)</dt><dd><tt>This allows one to delay initialization of the vertices.</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.collections.html#Collection">matplotlib.collections.Collection</a>:<br>
<dl><dt><a name="Barbs-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the collection.<br>
<br>
Returns True | False, ``dict(ind=itemlist)``, where every<br>
item in itemlist contains the event.</tt></dd></dl>
<dl><dt><a name="Barbs-get_dashes"><strong>get_dashes</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="Barbs-get_datalim"><strong>get_datalim</strong></a>(self, transData)</dt></dl>
<dl><dt><a name="Barbs-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Barbs-get_edgecolors"><strong>get_edgecolors</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="Barbs-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Barbs-get_facecolors"><strong>get_facecolors</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="Barbs-get_linestyle"><strong>get_linestyle</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="Barbs-get_linestyles"><strong>get_linestyles</strong></a>(self)</dt></dl>
<dl><dt><a name="Barbs-get_linewidth"><strong>get_linewidth</strong></a> = get_linewidths(self)</dt></dl>
<dl><dt><a name="Barbs-get_linewidths"><strong>get_linewidths</strong></a>(self)</dt></dl>
<dl><dt><a name="Barbs-get_offsets"><strong>get_offsets</strong></a>(self)</dt><dd><tt>Return the offsets for the collection.</tt></dd></dl>
<dl><dt><a name="Barbs-get_pickradius"><strong>get_pickradius</strong></a>(self)</dt></dl>
<dl><dt><a name="Barbs-get_transforms"><strong>get_transforms</strong></a>(self)</dt></dl>
<dl><dt><a name="Barbs-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha tranparencies of the collection. *alpha* must be<br>
a float.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Barbs-set_antialiased"><strong>set_antialiased</strong></a>(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="Barbs-set_antialiaseds"><strong>set_antialiaseds</strong></a> = set_antialiased(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="Barbs-set_color"><strong>set_color</strong></a>(self, c)</dt><dd><tt>Set both the edgecolor and the facecolor.<br>
See :meth:`set_facecolor` and :meth:`set_edgecolor`.<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="Barbs-set_dashes"><strong>set_dashes</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="Barbs-set_edgecolor"><strong>set_edgecolor</strong></a>(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. *c* can be a<br>
matplotlib color arg (all patches have same color), or a<br>
sequence or rgba tuples; if it is a sequence the patches will<br>
cycle through the sequence.<br>
<br>
If *c* is 'face', the edge color will always be the same as<br>
the face color.<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="Barbs-set_edgecolors"><strong>set_edgecolors</strong></a> = set_edgecolor(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. *c* can be a<br>
matplotlib color arg (all patches have same color), or a<br>
sequence or rgba tuples; if it is a sequence the patches will<br>
cycle through the sequence.<br>
<br>
If *c* is 'face', the edge color will always be the same as<br>
the face color.<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="Barbs-set_facecolor"><strong>set_facecolor</strong></a>(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. *c* can be a<br>
matplotlib color arg (all patches have same color), or a<br>
sequence or rgba tuples; if it is a sequence the patches will<br>
cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="Barbs-set_facecolors"><strong>set_facecolors</strong></a> = set_facecolor(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. *c* can be a<br>
matplotlib color arg (all patches have same color), or a<br>
sequence or rgba tuples; if it is a sequence the patches will<br>
cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="Barbs-set_linestyle"><strong>set_linestyle</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="Barbs-set_linestyles"><strong>set_linestyles</strong></a>(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="Barbs-set_linewidth"><strong>set_linewidth</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. *lw* can be a scalar<br>
or a sequence; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="Barbs-set_linewidths"><strong>set_linewidths</strong></a>(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. *lw* can be a scalar<br>
or a sequence; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="Barbs-set_lw"><strong>set_lw</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. *lw* can be a scalar<br>
or a sequence; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="Barbs-set_pickradius"><strong>set_pickradius</strong></a>(self, pickradius)</dt></dl>
<dl><dt><a name="Barbs-update_scalarmappable"><strong>update_scalarmappable</strong></a>(self)</dt><dd><tt>If the scalar mappable array is not none, update colors<br>
from scalar data</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.collections.html#Collection">matplotlib.collections.Collection</a>:<br>
<dl><dt><strong>zorder</strong> = 1</dl>
<hr>
Methods inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><a name="Barbs-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Barbs-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="Barbs-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="Barbs-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Barbs-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="Barbs-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="Barbs-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Barbs-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="Barbs-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Barbs-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="Barbs-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Barbs-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="Barbs-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="Barbs-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Barbs-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="Barbs-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="Barbs-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="Barbs-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Barbs-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Barbs-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="Barbs-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="Barbs-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Barbs-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="Barbs-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Barbs-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#Barbs-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="Barbs-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Barbs-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.Axes.draw_idle`. Call<br>
:meth:`matplotlib.axes.Axes.relim` to update the axes limits<br>
if desired.<br>
<br>
Note: :meth:`~matplotlib.axes.Axes.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="Barbs-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Barbs-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="Barbs-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="Barbs-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="Barbs-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="Barbs-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="Barbs-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="Barbs-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="Barbs-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the :class:`~matplotlib.figure.Figure` instance the artist<br>
belongs to.<br>
<br>
ACCEPTS: a :class:`matplotlib.figure.Figure` instance</tt></dd></dl>
<dl><dt><a name="Barbs-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="Barbs-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="Barbs-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="Barbs-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="Barbs-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="Barbs-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="Barbs-update"><strong>update</strong></a>(self, props)</dt></dl>
<dl><dt><a name="Barbs-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>
<hr>
Methods inherited from <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>:<br>
<dl><dt><a name="Barbs-add_checker"><strong>add_checker</strong></a>(self, checker)</dt><dd><tt>Add an entry to a dictionary of boolean flags<br>
that are set to True when the mappable is changed.</tt></dd></dl>
<dl><dt><a name="Barbs-autoscale"><strong>autoscale</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array</tt></dd></dl>
<dl><dt><a name="Barbs-autoscale_None"><strong>autoscale_None</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array, changing only limits that are None</tt></dd></dl>
<dl><dt><a name="Barbs-changed"><strong>changed</strong></a>(self)</dt><dd><tt>Call this whenever the mappable is changed to notify all the<br>
callbackSM listeners to the 'changed' signal</tt></dd></dl>
<dl><dt><a name="Barbs-check_update"><strong>check_update</strong></a>(self, checker)</dt><dd><tt>If mappable has changed since the last check,<br>
return True; else return False</tt></dd></dl>
<dl><dt><a name="Barbs-get_array"><strong>get_array</strong></a>(self)</dt><dd><tt>Return the array</tt></dd></dl>
<dl><dt><a name="Barbs-get_clim"><strong>get_clim</strong></a>(self)</dt><dd><tt>return the min, max of the color limits for image scaling</tt></dd></dl>
<dl><dt><a name="Barbs-get_cmap"><strong>get_cmap</strong></a>(self)</dt><dd><tt>return the colormap</tt></dd></dl>
<dl><dt><a name="Barbs-set_array"><strong>set_array</strong></a>(self, A)</dt><dd><tt>Set the image array from numpy array *A*</tt></dd></dl>
<dl><dt><a name="Barbs-set_clim"><strong>set_clim</strong></a>(self, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>)</dt><dd><tt>set the norm limits for image scaling; if *vmin* is a length2<br>
sequence, interpret it as ``(vmin, vmax)`` which is used to<br>
support setp<br>
<br>
ACCEPTS: a length 2 sequence of floats</tt></dd></dl>
<dl><dt><a name="Barbs-set_cmap"><strong>set_cmap</strong></a>(self, cmap)</dt><dd><tt>set the colormap for luminance data<br>
<br>
ACCEPTS: a colormap</tt></dd></dl>
<dl><dt><a name="Barbs-set_colorbar"><strong>set_colorbar</strong></a>(self, im, ax)</dt><dd><tt>set the colorbar image and axes associated with mappable</tt></dd></dl>
<dl><dt><a name="Barbs-set_norm"><strong>set_norm</strong></a>(self, norm)</dt><dd><tt>set the normalization instance</tt></dd></dl>
<dl><dt><a name="Barbs-to_rgba"><strong>to_rgba</strong></a>(self, x, alpha<font color="#909090">=1.0</font>, bytes<font color="#909090">=False</font>)</dt><dd><tt>Return a normalized rgba array corresponding to *x*. If *x*<br>
is already an rgb array, insert *alpha*; if it is already<br>
rgba, return it unchanged. If *bytes* is True, return rgba as<br>
4 uint8s instead of 4 floats.</tt></dd></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="Quiver">class <strong>Quiver</strong></a>(<a href="matplotlib.collections.html#PolyCollection">matplotlib.collections.PolyCollection</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Specialized <a href="matplotlib.collections.html#PolyCollection">PolyCollection</a> for arrows.<br>
<br>
The only API method is <a href="#Quiver-set_UVC">set_UVC</a>(), which can be used<br>
to change the size, orientation, and color of the<br>
arrows; their locations are fixed when the class is<br>
instantiated. Possibly this method will be useful<br>
in animations.<br>
<br>
Much of the work in this class is done in the <a href="#Quiver-draw">draw</a>()<br>
method so that as much information as possible is available<br>
about the plot. In subsequent <a href="#Quiver-draw">draw</a>() calls, recalculation<br>
is limited to things that might have changed, so there<br>
should be no performance penalty from putting the calculations<br>
in the <a href="#Quiver-draw">draw</a>() method.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.quiver.html#Quiver">Quiver</a></dd>
<dd><a href="matplotlib.collections.html#PolyCollection">matplotlib.collections.PolyCollection</a></dd>
<dd><a href="matplotlib.collections.html#Collection">matplotlib.collections.Collection</a></dd>
<dd><a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
<dd><a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Quiver-__init__"><strong>__init__</strong></a>(self, ax, *args, **kw)</dt><dd><tt> The constructor takes one required argument, an Axes<br>
instance, followed by the args and kwargs described<br>
by the following pylab interface documentation:<br>
<br>
Plot a 2-D field of arrows.<br>
<br>
call signatures::<br>
<br>
quiver(U, V, **kw)<br>
quiver(U, V, C, **kw)<br>
quiver(X, Y, U, V, **kw)<br>
quiver(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.<a href="matplotlib.collections.html#PolyCollection">PolyCollection</a>` 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.<a href="matplotlib.collections.html#PolyCollection">PolyCollection</a>`<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="Quiver-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="Quiver-set_UVC"><strong>set_UVC</strong></a>(self, U, V, C<font color="#909090">=None</font>)</dt></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>quiver_doc</strong> = '<font color="#c040c0">\n</font>Plot a 2-D field of arrows.<font color="#c040c0">\n\n</font>call signatures::<font color="#c040c0">\n</font>...===============================================<font color="#c040c0">\n\n</font>'</dl>
<hr>
Methods inherited from <a href="matplotlib.collections.html#PolyCollection">matplotlib.collections.PolyCollection</a>:<br>
<dl><dt><a name="Quiver-get_paths"><strong>get_paths</strong></a>(self)</dt></dl>
<dl><dt><a name="Quiver-set_verts"><strong>set_verts</strong></a>(self, verts, closed<font color="#909090">=True</font>)</dt><dd><tt>This allows one to delay initialization of the vertices.</tt></dd></dl>
<hr>
Methods inherited from <a href="matplotlib.collections.html#Collection">matplotlib.collections.Collection</a>:<br>
<dl><dt><a name="Quiver-contains"><strong>contains</strong></a>(self, mouseevent)</dt><dd><tt>Test whether the mouse event occurred in the collection.<br>
<br>
Returns True | False, ``dict(ind=itemlist)``, where every<br>
item in itemlist contains the event.</tt></dd></dl>
<dl><dt><a name="Quiver-get_dashes"><strong>get_dashes</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="Quiver-get_datalim"><strong>get_datalim</strong></a>(self, transData)</dt></dl>
<dl><dt><a name="Quiver-get_edgecolor"><strong>get_edgecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Quiver-get_edgecolors"><strong>get_edgecolors</strong></a> = get_edgecolor(self)</dt></dl>
<dl><dt><a name="Quiver-get_facecolor"><strong>get_facecolor</strong></a>(self)</dt></dl>
<dl><dt><a name="Quiver-get_facecolors"><strong>get_facecolors</strong></a> = get_facecolor(self)</dt></dl>
<dl><dt><a name="Quiver-get_linestyle"><strong>get_linestyle</strong></a> = get_linestyles(self)</dt></dl>
<dl><dt><a name="Quiver-get_linestyles"><strong>get_linestyles</strong></a>(self)</dt></dl>
<dl><dt><a name="Quiver-get_linewidth"><strong>get_linewidth</strong></a> = get_linewidths(self)</dt></dl>
<dl><dt><a name="Quiver-get_linewidths"><strong>get_linewidths</strong></a>(self)</dt></dl>
<dl><dt><a name="Quiver-get_offsets"><strong>get_offsets</strong></a>(self)</dt><dd><tt>Return the offsets for the collection.</tt></dd></dl>
<dl><dt><a name="Quiver-get_pickradius"><strong>get_pickradius</strong></a>(self)</dt></dl>
<dl><dt><a name="Quiver-get_transforms"><strong>get_transforms</strong></a>(self)</dt></dl>
<dl><dt><a name="Quiver-set_alpha"><strong>set_alpha</strong></a>(self, alpha)</dt><dd><tt>Set the alpha tranparencies of the collection. *alpha* must be<br>
a float.<br>
<br>
ACCEPTS: float</tt></dd></dl>
<dl><dt><a name="Quiver-set_antialiased"><strong>set_antialiased</strong></a>(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="Quiver-set_antialiaseds"><strong>set_antialiaseds</strong></a> = set_antialiased(self, aa)</dt><dd><tt>Set the antialiasing state for rendering.<br>
<br>
ACCEPTS: Boolean or sequence of booleans</tt></dd></dl>
<dl><dt><a name="Quiver-set_color"><strong>set_color</strong></a>(self, c)</dt><dd><tt>Set both the edgecolor and the facecolor.<br>
See :meth:`set_facecolor` and :meth:`set_edgecolor`.<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="Quiver-set_dashes"><strong>set_dashes</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="Quiver-set_edgecolor"><strong>set_edgecolor</strong></a>(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. *c* can be a<br>
matplotlib color arg (all patches have same color), or a<br>
sequence or rgba tuples; if it is a sequence the patches will<br>
cycle through the sequence.<br>
<br>
If *c* is 'face', the edge color will always be the same as<br>
the face color.<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="Quiver-set_edgecolors"><strong>set_edgecolors</strong></a> = set_edgecolor(self, c)</dt><dd><tt>Set the edgecolor(s) of the collection. *c* can be a<br>
matplotlib color arg (all patches have same color), or a<br>
sequence or rgba tuples; if it is a sequence the patches will<br>
cycle through the sequence.<br>
<br>
If *c* is 'face', the edge color will always be the same as<br>
the face color.<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="Quiver-set_facecolor"><strong>set_facecolor</strong></a>(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. *c* can be a<br>
matplotlib color arg (all patches have same color), or a<br>
sequence or rgba tuples; if it is a sequence the patches will<br>
cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="Quiver-set_facecolors"><strong>set_facecolors</strong></a> = set_facecolor(self, c)</dt><dd><tt>Set the facecolor(s) of the collection. *c* can be a<br>
matplotlib color arg (all patches have same color), or a<br>
sequence or rgba tuples; if it is a sequence the patches will<br>
cycle through the sequence<br>
<br>
ACCEPTS: matplotlib color arg or sequence of rgba tuples</tt></dd></dl>
<dl><dt><a name="Quiver-set_linestyle"><strong>set_linestyle</strong></a> = set_linestyles(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="Quiver-set_linestyles"><strong>set_linestyles</strong></a>(self, ls)</dt><dd><tt>Set the linestyles(s) for the collection.<br>
ACCEPTS: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) ]</tt></dd></dl>
<dl><dt><a name="Quiver-set_linewidth"><strong>set_linewidth</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. *lw* can be a scalar<br>
or a sequence; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="Quiver-set_linewidths"><strong>set_linewidths</strong></a>(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. *lw* can be a scalar<br>
or a sequence; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="Quiver-set_lw"><strong>set_lw</strong></a> = set_linewidths(self, lw)</dt><dd><tt>Set the linewidth(s) for the collection. *lw* can be a scalar<br>
or a sequence; if it is a sequence the patches will cycle<br>
through the sequence<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="Quiver-set_offsets"><strong>set_offsets</strong></a>(self, offsets)</dt><dd><tt>Set the offsets for the collection. *offsets* can be a scalar<br>
or a sequence.<br>
<br>
ACCEPTS: float or sequence of floats</tt></dd></dl>
<dl><dt><a name="Quiver-set_pickradius"><strong>set_pickradius</strong></a>(self, pickradius)</dt></dl>
<dl><dt><a name="Quiver-update_scalarmappable"><strong>update_scalarmappable</strong></a>(self)</dt><dd><tt>If the scalar mappable array is not none, update colors<br>
from scalar data</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="matplotlib.collections.html#Collection">matplotlib.collections.Collection</a>:<br>
<dl><dt><strong>zorder</strong> = 1</dl>
<hr>
Methods inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><a name="Quiver-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="Quiver-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="Quiver-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="Quiver-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#Quiver-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="Quiver-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="Quiver-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="Quiver-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="Quiver-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="Quiver-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="Quiver-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="Quiver-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="Quiver-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="Quiver-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="Quiver-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="Quiver-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="Quiver-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="Quiver-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="Quiver-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="Quiver-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="Quiver-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="Quiver-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="Quiver-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="Quiver-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="Quiver-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#Quiver-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="Quiver-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="Quiver-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.Axes.draw_idle`. Call<br>
:meth:`matplotlib.axes.Axes.relim` to update the axes limits<br>
if desired.<br>
<br>
Note: :meth:`~matplotlib.axes.Axes.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="Quiver-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="Quiver-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="Quiver-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="Quiver-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="Quiver-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="Quiver-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="Quiver-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="Quiver-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="Quiver-set_figure"><strong>set_figure</strong></a>(self, fig)</dt><dd><tt>Set the :class:`~matplotlib.figure.Figure` instance the artist<br>
belongs to.<br>
<br>
ACCEPTS: a :class:`matplotlib.figure.Figure` instance</tt></dd></dl>
<dl><dt><a name="Quiver-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="Quiver-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="Quiver-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="Quiver-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="Quiver-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="Quiver-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="Quiver-update"><strong>update</strong></a>(self, props)</dt></dl>
<dl><dt><a name="Quiver-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>
<hr>
Methods inherited from <a href="matplotlib.cm.html#ScalarMappable">matplotlib.cm.ScalarMappable</a>:<br>
<dl><dt><a name="Quiver-add_checker"><strong>add_checker</strong></a>(self, checker)</dt><dd><tt>Add an entry to a dictionary of boolean flags<br>
that are set to True when the mappable is changed.</tt></dd></dl>
<dl><dt><a name="Quiver-autoscale"><strong>autoscale</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array</tt></dd></dl>
<dl><dt><a name="Quiver-autoscale_None"><strong>autoscale_None</strong></a>(self)</dt><dd><tt>Autoscale the scalar limits on the norm instance using the<br>
current array, changing only limits that are None</tt></dd></dl>
<dl><dt><a name="Quiver-changed"><strong>changed</strong></a>(self)</dt><dd><tt>Call this whenever the mappable is changed to notify all the<br>
callbackSM listeners to the 'changed' signal</tt></dd></dl>
<dl><dt><a name="Quiver-check_update"><strong>check_update</strong></a>(self, checker)</dt><dd><tt>If mappable has changed since the last check,<br>
return True; else return False</tt></dd></dl>
<dl><dt><a name="Quiver-get_array"><strong>get_array</strong></a>(self)</dt><dd><tt>Return the array</tt></dd></dl>
<dl><dt><a name="Quiver-get_clim"><strong>get_clim</strong></a>(self)</dt><dd><tt>return the min, max of the color limits for image scaling</tt></dd></dl>
<dl><dt><a name="Quiver-get_cmap"><strong>get_cmap</strong></a>(self)</dt><dd><tt>return the colormap</tt></dd></dl>
<dl><dt><a name="Quiver-set_array"><strong>set_array</strong></a>(self, A)</dt><dd><tt>Set the image array from numpy array *A*</tt></dd></dl>
<dl><dt><a name="Quiver-set_clim"><strong>set_clim</strong></a>(self, vmin<font color="#909090">=None</font>, vmax<font color="#909090">=None</font>)</dt><dd><tt>set the norm limits for image scaling; if *vmin* is a length2<br>
sequence, interpret it as ``(vmin, vmax)`` which is used to<br>
support setp<br>
<br>
ACCEPTS: a length 2 sequence of floats</tt></dd></dl>
<dl><dt><a name="Quiver-set_cmap"><strong>set_cmap</strong></a>(self, cmap)</dt><dd><tt>set the colormap for luminance data<br>
<br>
ACCEPTS: a colormap</tt></dd></dl>
<dl><dt><a name="Quiver-set_colorbar"><strong>set_colorbar</strong></a>(self, im, ax)</dt><dd><tt>set the colorbar image and axes associated with mappable</tt></dd></dl>
<dl><dt><a name="Quiver-set_norm"><strong>set_norm</strong></a>(self, norm)</dt><dd><tt>set the normalization instance</tt></dd></dl>
<dl><dt><a name="Quiver-to_rgba"><strong>to_rgba</strong></a>(self, x, alpha<font color="#909090">=1.0</font>, bytes<font color="#909090">=False</font>)</dt><dd><tt>Return a normalized rgba array corresponding to *x*. If *x*<br>
is already an rgb array, insert *alpha*; if it is already<br>
rgba, return it unchanged. If *bytes* is True, return rgba as<br>
4 uint8s instead of 4 floats.</tt></dd></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="QuiverKey">class <strong>QuiverKey</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>Labelled arrow for use as a quiver plot scale key.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="matplotlib.quiver.html#QuiverKey">QuiverKey</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="QuiverKey-__init__"><strong>__init__</strong></a>(self, Q, X, Y, U, label, **kw)</dt><dd><tt>Add a key to a quiver plot.<br>
<br>
call signature::<br>
<br>
quiverkey(Q, X, Y, U, label, **kw)<br>
<br>
Arguments:<br>
<br>
*Q*:<br>
The <a href="#Quiver">Quiver</a> 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="QuiverKey-contains"><strong>contains</strong></a>(self, mouseevent)</dt></dl>
<dl><dt><a name="QuiverKey-draw"><strong>draw</strong></a>(self, renderer)</dt></dl>
<dl><dt><a name="QuiverKey-set_figure"><strong>set_figure</strong></a>(self, fig)</dt></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>halign</strong> = {'E': 'left', 'N': 'center', 'S': 'center', 'W': 'right'}</dl>
<dl><dt><strong>pivot</strong> = {'E': 'tip', 'N': 'mid', 'S': 'mid', 'W': 'tail'}</dl>
<dl><dt><strong>quiverkey_doc</strong> = '<font color="#c040c0">\n</font>Add a key to a quiver plot.<font color="#c040c0">\n\n</font>call signature::<font color="#c040c0">\n\n</font>...ere in the<font color="#c040c0">\n</font>middle of the arrow+label key object.<font color="#c040c0">\n</font>'</dl>
<dl><dt><strong>valign</strong> = {'E': 'center', 'N': 'bottom', 'S': 'top', 'W': 'center'}</dl>
<hr>
Methods inherited from <a href="matplotlib.artist.html#Artist">matplotlib.artist.Artist</a>:<br>
<dl><dt><a name="QuiverKey-add_callback"><strong>add_callback</strong></a>(self, func)</dt></dl>
<dl><dt><a name="QuiverKey-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="QuiverKey-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="QuiverKey-findobj"><strong>findobj</strong></a>(self, match<font color="#909090">=None</font>)</dt><dd><tt>pyplot signature:<br>
<a href="#QuiverKey-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="QuiverKey-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="QuiverKey-get_animated"><strong>get_animated</strong></a>(self)</dt><dd><tt>return the artist's animated state</tt></dd></dl>
<dl><dt><a name="QuiverKey-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="QuiverKey-get_clip_box"><strong>get_clip_box</strong></a>(self)</dt><dd><tt>Return artist clipbox</tt></dd></dl>
<dl><dt><a name="QuiverKey-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="QuiverKey-get_clip_path"><strong>get_clip_path</strong></a>(self)</dt><dd><tt>Return artist clip path</tt></dd></dl>
<dl><dt><a name="QuiverKey-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="QuiverKey-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="QuiverKey-get_label"><strong>get_label</strong></a>(self)</dt></dl>
<dl><dt><a name="QuiverKey-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="QuiverKey-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="QuiverKey-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="QuiverKey-get_visible"><strong>get_visible</strong></a>(self)</dt><dd><tt>return the artist's visiblity</tt></dd></dl>
<dl><dt><a name="QuiverKey-get_zorder"><strong>get_zorder</strong></a>(self)</dt></dl>
<dl><dt><a name="QuiverKey-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="QuiverKey-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="QuiverKey-is_figure_set"><strong>is_figure_set</strong></a>(self)</dt></dl>
<dl><dt><a name="QuiverKey-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="QuiverKey-pchanged"><strong>pchanged</strong></a>(self)</dt><dd><tt>fire event when property changed</tt></dd></dl>
<dl><dt><a name="QuiverKey-pick"><strong>pick</strong></a>(self, mouseevent)</dt><dd><tt>call signature::<br>
<br>
<a href="#QuiverKey-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="QuiverKey-pickable"><strong>pickable</strong></a>(self)</dt><dd><tt>return *True* if self is pickable</tt></dd></dl>
<dl><dt><a name="QuiverKey-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.Axes.draw_idle`. Call<br>
:meth:`matplotlib.axes.Axes.relim` to update the axes limits<br>
if desired.<br>
<br>
Note: :meth:`~matplotlib.axes.Axes.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="QuiverKey-remove_callback"><strong>remove_callback</strong></a>(self, oid)</dt></dl>
<dl><dt><a name="QuiverKey-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="QuiverKey-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="QuiverKey-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="QuiverKey-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="QuiverKey-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="QuiverKey-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="QuiverKey-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="QuiverKey-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="QuiverKey-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="QuiverKey-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="QuiverKey-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="QuiverKey-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="QuiverKey-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="QuiverKey-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="QuiverKey-update"><strong>update</strong></a>(self, props)</dt></dl>
<dl><dt><a name="QuiverKey-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></td></tr></table>
@footer@
