Added Barbs polygon collection (similar to Quiver) for plotting wind barbs. Added corresponding helpers to Axes and pyplot as well. (examples/pylab_examples/barb_demo.py shows it off.)

svn path=/trunk/matplotlib/; revision=5819

Author: dopplershift

CHANGELOG

@@ -1,3 +1,7 @@
+2008-07-22 Added Barbs polygon collection (similar to Quiver) for plotting
+           wind barbs.  Added corresponding helpers to Axes and pyplot as
+           well. (examples/pylab_examples/barb_demo.py shows it off.) - RMM
+
 2008-07-21 Added scikits.delaunay as matplotlib.delaunay.  Added griddata
            function in matplotlib.mlab, with example (griddata_demo.py) in
            pylab_examples. griddata function will use mpl_toolkits._natgrid 

boilerplate.py

@@ -86,6 +86,7 @@ def %(func)s(*args, **kwargs):
     'step',
     'vlines',
     'xcorr',
+    'barbs',
     )
 
 _misccommands = (

examples/pylab_examples/barb_demo.py

@@ -0,0 +1,33 @@
+'''
+Demonstration of wind barb plots
+'''
+import matplotlib.pyplot as plt
+import numpy as np
+
+x = np.linspace(-5, 5, 5)
+X,Y = np.meshgrid(x, x)
+U, V = 12*X, 12*Y
+
+data = [(-1.5,.5,-6,-6),
+        (1,-1,-46,46),
+        (-3,-1,11,-11),
+        (1,1.5,80,80)]
+
+#Default parameters for arbitrary set of vectors
+ax = plt.subplot(2,2,1)
+ax.barbs(*zip(*data))
+
+#Default parameters, uniform grid
+ax = plt.subplot(2,2,2)
+ax.barbs(X, Y, U, V)
+
+#Change parameters for arbitrary set of vectors
+ax = plt.subplot(2,2,3)
+ax.barbs(flagcolor='r', barbcolor=['b','g'], barb_increments=dict(half=10,
+    full=20, flag=100), *zip(*data))
+
+#Showing colormapping with uniform grid. 
+ax = plt.subplot(2,2,4)
+ax.barbs(X, Y, U, V, np.sqrt(U*U + V*V), fill_empty=True, rounding=False)
+
+plt.show()

examples/tests/backend_driver.py

@@ -33,6 +33,7 @@
     'axhspan_demo.py',
     'bar_stacked.py',
     'barchart_demo.py',
+    'barb_demo.py',
     'boxplot_demo.py',
     'broken_barh.py',
     'barh_demo.py',

lib/matplotlib/axes.py

@@ -5224,6 +5224,15 @@ def quiver(self, *args, **kw):
         return q
     quiver.__doc__ = mquiver.Quiver.quiver_doc
 
+    def barbs(self, *args, **kw):
+        if not self._hold: self.cla()
+        b = mquiver.Barbs(self, *args, **kw)
+        self.add_collection(b)
+        self.update_datalim(b.get_offsets())
+        self.autoscale_view()
+        return b
+    barbs.__doc__ = mquiver.Barbs.barbs_doc
+
     def fill(self, *args, **kwargs):
         """
         call signature::

lib/matplotlib/pyplot.py

@@ -2340,6 +2340,28 @@ def xcorr(*args, **kwargs):
 
 Additional kwargs: hold = [True|False] overrides default hold state"""
 
+# This function was autogenerated by boilerplate.py.  Do not edit as
+# changes will be lost
+def barbs(*args, **kwargs):
+    # allow callers to override the hold state by passing hold=True|False
+    b = ishold()
+    h = kwargs.pop('hold', None)
+    if h is not None:
+        hold(h)
+    try:
+        ret =  gca().barbs(*args, **kwargs)
+        draw_if_interactive()
+    except:
+        hold(b)
+        raise
+    
+    hold(b)
+    return ret
+if Axes.barbs.__doc__ is not None:
+    barbs.__doc__ = dedent(Axes.barbs.__doc__) + """
+
+Additional kwargs: hold = [True|False] overrides default hold state"""
+
 # This function was autogenerated by boilerplate.py.  Do not edit as
 # changes will be lost
 def cla(*args, **kwargs):