{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "All but the last (righthand-most) bin is half-open. In other words, if " }, { "__type": "ParamRef", "__tag": 4071, "name": "bins" }, { "__type": "Text", "__tag": 4046, "value": " is " } ] }, { "__type": "Code", "__tag": 4050, "value": "[1, 2, 3, 4]", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "then the first bin is " }, { "__type": "InlineCode", "__tag": 4051, "value": "[1, 2)" }, { "__type": "Text", "__tag": 4046, "value": " (including 1, but excluding 2) and the second " }, { "__type": "InlineCode", "__tag": 4051, "value": "[2, 3)" }, { "__type": "Text", "__tag": 4046, "value": ". The last bin, however, is " }, { "__type": "InlineCode", "__tag": 4051, "value": "[3, 4]" }, { "__type": "Text", "__tag": 4046, "value": ", which " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "includes" } ] }, { "__type": "Text", "__tag": 4046, "value": " 4." } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "hist", "annotation": "array", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The values of the histogram. See " }, { "__type": "ParamRef", "__tag": 4071, "name": "density" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "weights" }, { "__type": "Text", "__tag": 4046, "value": " for a description of the possible semantics. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "weights" }, { "__type": "Text", "__tag": 4046, "value": " are given, " }, { "__type": "InlineCode", "__tag": 4051, "value": "hist.dtype" }, { "__type": "Text", "__tag": 4046, "value": " will be taken from " }, { "__type": "ParamRef", "__tag": 4071, "name": "weights" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "bin_edges", "annotation": "array of dtype float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Return the bin edges " }, { "__type": "InlineCode", "__tag": 4051, "value": "(length(hist)+1)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compute the histogram of a dataset." } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "a", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input data. The histogram is computed over the flattened array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "bins", "annotation": "int or sequence of scalars or str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "bins" }, { "__type": "Text", "__tag": 4046, "value": " is an int, it defines the number of equal-width bins in the given range (10, by default). If " }, { "__type": "ParamRef", "__tag": 4071, "name": "bins" }, { "__type": "Text", "__tag": 4046, "value": " is a sequence, it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "bins" }, { "__type": "Text", "__tag": 4046, "value": " is a string, it defines the method used to calculate the optimal bin width, as defined by " }, { "__type": "CrossRef", "__tag": 4002, "value": "histogram_bin_edges", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:histogram_bin_edges" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "range", "annotation": "(float, float), optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The lower and upper range of the bins. If not provided, range is simply " }, { "__type": "InlineCode", "__tag": 4051, "value": "(a.min(), a.max())" }, { "__type": "Text", "__tag": 4046, "value": ". Values outside the range are ignored. The first element of the range must be less than or equal to the second. " }, { "__type": "ParamRef", "__tag": 4071, "name": "range" }, { "__type": "Text", "__tag": 4046, "value": " affects the automatic bin computation as well. While bin width is computed to be optimal based on the actual data within " }, { "__type": "ParamRef", "__tag": 4071, "name": "range" }, { "__type": "Text", "__tag": 4046, "value": ", the bin count will fill the entire range including portions containing no data." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "weights", "annotation": "array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "An array of weights, of the same shape as " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ". Each value in " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " only contributes its associated weight towards the bin count (instead of 1). If " }, { "__type": "ParamRef", "__tag": 4071, "name": "density" }, { "__type": "Text", "__tag": 4046, "value": " is True, the weights are normalized, so that the integral of the density over the range remains 1. Please note that the " }, { "__type": "InlineCode", "__tag": 4051, "value": "dtype" }, { "__type": "Text", "__tag": 4046, "value": " of " }, { "__type": "ParamRef", "__tag": 4071, "name": "weights" }, { "__type": "Text", "__tag": 4046, "value": " will also become the " }, { "__type": "InlineCode", "__tag": 4051, "value": "dtype" }, { "__type": "Text", "__tag": 4046, "value": " of the returned accumulator (" }, { "__type": "CrossRef", "__tag": 4002, "value": "hist", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "hist" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": "), so it must be large enough to hold accumulated values as well." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "density", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "InlineCode", "__tag": 4051, "value": "False" }, { "__type": "Text", "__tag": 4046, "value": ", the result will contain the number of samples in each bin. If " }, { "__type": "InlineCode", "__tag": 4051, "value": "True" }, { "__type": "Text", "__tag": 4046, "value": ", the result is the value of the probability " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "density" } ] }, { "__type": "Text", "__tag": 4046, "value": " function at the bin, normalized such that the " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "integral" } ] }, { "__type": "Text", "__tag": 4046, "value": " over the range is 1. Note that the sum of the histogram values will not be equal to 1 unless bins of unity width are chosen; it is not a probability " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "mass" } ] }, { "__type": "Text", "__tag": 4046, "value": " function." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": "/numpy/lib/_histograms_impl.py", "item_line": 685, "item_type": "_ArrayFunctionDispatcher", "aliases": [ "numpy.histogram" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nnp.histogram([1, 2, 1], bins=[0, 1, 2, 3])\nnp.histogram(np.arange(4), bins=np.arange(5), density=True)\nnp.histogram([[1, 2, 1], [1, 0, 1]], bins=[0,1,2,3])\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "a = np.arange(5)\nhist, bin_edges = np.histogram(a, density=True)\nhist\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "hist.sum()\nnp.sum(hist * np.diff(bin_edges))\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nAutomated Bin Selection Methods example, using 2 peak random data\nwith 2000 points.\n\n.. plot::\n :include-source:\n\n import matplotlib.pyplot as plt\n import numpy as np\n\n rng = np.random.RandomState(10) # deterministic random data\n a = np.hstack((rng.normal(size=1000),\n rng.normal(loc=5, scale=2, size=1000)))\n plt.hist(a, bins='auto') # arguments are passed to np.histogram\n plt.title(\"Histogram with 'auto' bins\")\n plt.show()" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "bincount", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "bincount" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "digitize", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "digitize" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "histogram_bin_edges", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:histogram_bin_edges" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "histogramdd", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:histogramdd" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "searchsorted", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "searchsorted" }, "kind": "module" }, "descriptions": [], "type": null } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "a", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "bins", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "10" }, { "__type": "SigParam", "__tag": 4030, "name": "range", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "density", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "weights", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "histogram" }, "references": null, "qa": "numpy:histogram", "arbitrary": [], "local_refs": [ "a", "bin_edges", "bins", "density", "hist", "range", "weights" ] }