diff options
author | Stefan van der Walt <stefan@sun.ac.za> | 2012-11-26 11:19:17 -0800 |
---|---|---|
committer | Stefan van der Walt <stefan@sun.ac.za> | 2012-11-26 11:19:17 -0800 |
commit | 840cbbe04023f99b1e4235152e06a16dfd8a0879 (patch) | |
tree | 903c2c2f85dde80e867ec84d228c0432735d84eb /numpy/lib/twodim_base.py | |
parent | 02447200226894e15ee6bd61ca94e28fedf3e4a4 (diff) | |
download | numpy-840cbbe04023f99b1e4235152e06a16dfd8a0879.tar.gz |
DOC: Further tweaks to histogram2d docstring.
Diffstat (limited to 'numpy/lib/twodim_base.py')
-rw-r--r-- | numpy/lib/twodim_base.py | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/numpy/lib/twodim_base.py b/numpy/lib/twodim_base.py index c1f75c630..ce147965c 100644 --- a/numpy/lib/twodim_base.py +++ b/numpy/lib/twodim_base.py @@ -521,17 +521,19 @@ def histogram2d(x, y, bins=10, range=None, normed=False, weights=None): Parameters ---------- - x : array_like, shape(N,) - A sequence of values to be histogrammed along the first dimension. - y : array_like, shape(M,) - A sequence of values to be histogrammed along the second dimension. + x : array_like, shape (N,) + An array containing the x coordinates of the points to be histogrammed. + y : array_like, shape (N,) + An array containing the y coordinates of the points to be histogrammed. bins : int or [int, int] or array_like or [array, array], optional 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). + * 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). range : array_like, shape(2,2), optional The leftmost and rightmost edges of the bins along each dimension @@ -560,8 +562,8 @@ def histogram2d(x, y, bins=10, range=None, normed=False, weights=None): See Also -------- - histogram: 1D histogram - histogramdd: Multidimensional histogram + histogram : 1D histogram + histogramdd : Multidimensional histogram Notes ----- @@ -572,7 +574,7 @@ def histogram2d(x, y, bins=10, range=None, normed=False, weights=None): \\sum_{i=0}^{nx-1} \\sum_{j=0}^{ny-1} H_{i,j} \\Delta x_i \\Delta y_j = 1 where `H` is the histogram array and :math:`\\Delta x_i \\Delta y_i` - the area of bin `{i,j}`. + the area of bin ``{i,j}``. Please note that the histogram does not follow the Cartesian convention where `x` values are on the abcissa and `y` values on the ordinate axis. |