add hist2d

Author: piti118

boilerplate.py

@@ -71,6 +71,7 @@ def %(func)s(%(argspec)s):
     'fill_betweenx',
     'hexbin',
     'hist',
+    'hist2d',
     'hlines',
     'imshow',
     'loglog',
@@ -120,6 +121,7 @@ def %(func)s(%(argspec)s):
     'scatter' : 'sci(%(ret)s)',
     'pcolor'  : 'sci(%(ret)s)',
     'pcolormesh': 'sci(%(ret)s)',
+    'hist2d' : 'sci(%(ret)s[-1])',
     'imshow'  : 'sci(%(ret)s)',
     #'spy'    :  'sci(%(ret)s)',  ### may return image or Line2D
     'quiver' :  'sci(%(ret)s)',

examples/pylab_examples/hist2d_demo.py

@@ -0,0 +1,7 @@
+from pylab import *
+x = randn(1000)
+y = randn(1000)+5
+
+#normal distribution center at x=0 and y=5
+hist2d(x,y,bins=40)
+show()

lib/matplotlib/axes.py

@@ -7931,6 +7931,66 @@ def hist(x, bins=10, range=None, normed=False, weights=None,
         else:
             return n, bins, cbook.silent_list('Lists of Patches', patches)
 
+
+    @docstring.dedent_interpd
+    def hist2d(self, x, y, bins = 10, range=None, weights=None, cmin=None, cmax=None, **kwargs):
+        """
+        Call signature::
+
+        hist2d(x, y, bins = None, range=None, weights=None, cmin=None, cmax=None **kwargs)
+        Make a 2d histogram plot of *x* versus *y*, where *x*,
+        *y* are 1-D sequences of the same length
+
+        The return value is (counts,xedges,yedges,im)
+
+        Optional keyword arguments:
+        *bins*: [None | int | [int, int] | array_like | [array, array]]
+            The bin specification:
+                 If int, the number of bins for the two dimensions (nx=ny=bins).
+                 If [int, int], the number of bins in each dimension (nx, ny = bins).
+                 If array_like, the bin edges for the two dimensions (x_edges=y_edges=bins).
+                 If [array, array], the bin edges in each dimension (x_edges, y_edges = bins).
+            The default value is 10.
+
+        *range*: [*None* | array_like shape(2,2)]
+             The leftmost and rightmost edges of the bins along each dimension (if not specified 
+             explicitly in the bins parameters): [[xmin, xmax], [ymin, ymax]]. All values outside of 
+             this range will be considered outliers and not tallied in the histogram.
+
+        *weights*: [*None* | array]
+            An array of values w_i weighing each sample (x_i, y_i).
+
+        *cmin* : [None| scalar]
+             All bins that has count less than cmin will not be displayed 
+             and these count values in the return value count histogram will also be set to nan upon return
+
+        *cmax* : [None| scalar]
+             All bins that has count more than cmax will not be displayed (set to none before passing to imshow)
+             and these count values in the return value count histogram will also be set to nan upon return
+
+        Remaining keyword arguments are passed directly to :meth:imshow
+
+        **Example:**
+
+        .. plot:: mpl_examples/pylab_examples/hist2d_demo.py
+        """
+
+        # xrange becomes range after 2to3
+        bin_range = range
+        range = __builtins__["range"]
+        h,xedges,yedges = np.histogram2d(x, y, bins=bins, range=bin_range, normed=False, weights=weights)
+
+        if 'origin' not in kwargs: kwargs['origin']='lower'
+        if 'extent' not in kwargs: kwargs['extent']=[xedges[0], xedges[-1], yedges[0], yedges[-1]]
+        if 'interpolation' not in kwargs: kwargs['interpolation']='nearest'
+        if 'aspect' not in kwargs: kwargs['aspect']='auto'
+        if cmin is not None: h[h<cmin]=None
+        if cmax is not None: h[h>cmax]=None
+
+        im = self.imshow(h.T,**kwargs)
+
+        return h,xedges,yedges,im
+
     @docstring.dedent_interpd
     def psd(self, x, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
             window=mlab.window_hanning, noverlap=0, pad_to=None,

lib/matplotlib/pyplot.py

@@ -1532,6 +1532,7 @@ def plotting():
     gci             get the current image, or None
     getp            get a graphics property
     hist            make a histogram
+    hist2d          make a 2d histogram
     hold            set the hold state on current axes
     legend          add a legend to the axes
     loglog          a log log plot
@@ -1588,7 +1589,7 @@ def plotting():
 def get_plot_commands(): return ( 'axes', 'axis', 'bar', 'boxplot', 'cla', 'clf',
     'close', 'colorbar', 'cohere', 'csd', 'draw', 'errorbar',
     'figlegend', 'figtext', 'figimage', 'figure', 'fill', 'gca',
-    'gcf', 'gci', 'get', 'gray', 'barh', 'jet', 'hist', 'hold', 'imread', 'imsave',
+    'gcf', 'gci', 'get', 'gray', 'barh', 'jet', 'hist', 'hist2d', 'hold', 'imread', 'imsave',
     'imshow', 'legend', 'loglog', 'quiver', 'rc', 'pcolor', 'pcolormesh', 'plot', 'psd',
     'savefig', 'scatter', 'set', 'semilogx', 'semilogy', 'show',
     'specgram', 'stem', 'subplot', 'table', 'text', 'title', 'xlabel',
@@ -1937,17 +1938,16 @@ def getname_val(identifier):
 
     draw_if_interactive()
 
-
 def autogen_docstring(base):
     """Autogenerated wrappers will get their docstring from a base function
     with an addendum."""
     msg = "\n\nAdditional kwargs: hold = [True|False] overrides default hold state"
     addendum = docstring.Appender(msg, '\n\n')
     return lambda func: addendum(docstring.copy_dedent(base)(func))
 
-
 # This function cannot be generated by boilerplate.py because it may
 # return an image or a line.
+
 @autogen_docstring(Axes.spy)
 def spy(Z, precision=0, marker=None, markersize=None, aspect='equal', hold=None, **kwargs):
     ax = gca()
@@ -1965,9 +1965,6 @@ def spy(Z, precision=0, marker=None, markersize=None, aspect='equal', hold=None,
         sci(ret)
     return ret
 
-
-## Plotting part 2: autogenerated wrappers for axes methods ##
-
 # This function was autogenerated by boilerplate.py.  Do not edit as
 # changes will be lost
 @autogen_docstring(Axes.acorr)
@@ -2079,7 +2076,7 @@ def axvspan(xmin, xmax, ymin=0, ymax=1, hold=None, **kwargs):
 # This function was autogenerated by boilerplate.py.  Do not edit as
 # changes will be lost
 @autogen_docstring(Axes.bar)
-def bar(left, height, width=0.80000000000000004, bottom=None, hold=None, **kwargs):
+def bar(left, height, width=0.8, bottom=None, hold=None, **kwargs):
     ax = gca()
     # allow callers to override the hold state by passing hold=True|False
     washold = ax.ishold()
@@ -2097,7 +2094,7 @@ def bar(left, height, width=0.80000000000000004, bottom=None, hold=None, **kwarg
 # This function was autogenerated by boilerplate.py.  Do not edit as
 # changes will be lost
 @autogen_docstring(Axes.barh)
-def barh(bottom, width, height=0.80000000000000004, left=None, hold=None, **kwargs):
+def barh(bottom, width, height=0.8, left=None, hold=None, **kwargs):
     ax = gca()
     # allow callers to override the hold state by passing hold=True|False
     washold = ax.ishold()
@@ -2346,6 +2343,24 @@ def hist(x, bins=10, range=None, normed=False, weights=None, cumulative=False, b
 
     return ret
 
+# This function was autogenerated by boilerplate.py.  Do not edit as
+# changes will be lost
+@autogen_docstring(Axes.hist2d)
+def hist2d(x, y, bins=10, range=None, weights=None, cmin=None, cmax=None, hold=None, **kwargs):
+    ax = gca()
+    # allow callers to override the hold state by passing hold=True|False
+    washold = ax.ishold()
+
+    if hold is not None:
+        ax.hold(hold)
+    try:
+        ret = ax.hist2d(x, y, bins, range, weights, cmin, cmax, **kwargs)
+        draw_if_interactive()
+    finally:
+        ax.hold(washold)
+    sci(ret[-1])
+    return ret
+
 # This function was autogenerated by boilerplate.py.  Do not edit as
 # changes will be lost
 @autogen_docstring(Axes.hlines)
@@ -2439,7 +2454,7 @@ def pcolormesh(*args, **kwargs):
 # This function was autogenerated by boilerplate.py.  Do not edit as
 # changes will be lost
 @autogen_docstring(Axes.pie)
-def pie(x, explode=None, labels=None, colors=None, autopct=None, pctdistance=0.59999999999999998, shadow=False, labeldistance=1.1000000000000001, hold=None):
+def pie(x, explode=None, labels=None, colors=None, autopct=None, pctdistance=0.6, shadow=False, labeldistance=1.1, hold=None):
     ax = gca()
     # allow callers to override the hold state by passing hold=True|False
     washold = ax.ishold()
@@ -2655,7 +2670,7 @@ def step(x, y, *args, **kwargs):
 # This function was autogenerated by boilerplate.py.  Do not edit as
 # changes will be lost
 @autogen_docstring(Axes.streamplot)
-def streamplot(x, y, u, v, density=1, linewidth=None, color=None, cmap=None, arrowsize=1, arrowstyle='-|>', minlength=0.10000000000000001, hold=None):
+def streamplot(x, y, u, v, density=1, linewidth=None, color=None, cmap=None, arrowsize=1, arrowstyle='-|>', minlength=0.1, hold=None):
     ax = gca()
     # allow callers to override the hold state by passing hold=True|False
     washold = ax.ishold()