{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Binedges: 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": "InlineCode", "__tag": 4051, "value": "[1, 2, 3, 4]" }, { "__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." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "binnumber", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "binnumber" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": ": This returned argument assigns to each element of " }, { "__type": "InlineRole", "__tag": 4003, "value": "sample", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " an integer that represents the bin in which it belongs. The representation depends on the " }, { "__type": "ParamRef", "__tag": 4071, "name": "expand_binnumbers" }, { "__type": "Text", "__tag": 4046, "value": " argument. If 'False' (default): The returned " }, { "__type": "CrossRef", "__tag": 4002, "value": "binnumber", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "binnumber" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " is a shape (N,) array of linearized indices mapping each element of " }, { "__type": "InlineRole", "__tag": 4003, "value": "sample", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " to its corresponding bin (using row-major ordering). Note that the returned linearized bin indices are used for an array with extra bins on the outer binedges to capture values outside of the defined bin bounds. If 'True': The returned " }, { "__type": "CrossRef", "__tag": 4002, "value": "binnumber", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "binnumber" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " is a shape (2,N) ndarray where each row indicates bin placements for each dimension respectively. In each dimension, a binnumber of " }, { "__type": "InlineRole", "__tag": 4003, "value": "i", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " means the corresponding value is between (D_edge[i-1], D_edge[i]), where 'D' is either 'x' or 'y'." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.11.0" } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "Array API Standard Support" } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "binned_statistic_2d", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._binned_statistic:binned_statistic_2d" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable " }, { "__type": "InlineCode", "__tag": 4051, "value": "SCIPY_ARRAY_API=1" }, { "__type": "Text", "__tag": 4046, "value": " and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported." } ] }, { "__type": "Code", "__tag": 4050, "value": "==================== ==================== ====================\nLibrary CPU GPU\n==================== ==================== ====================\nNumPy ✅ n/a \nCuPy n/a ⛔ \nPyTorch ⛔ ⛔ \nJAX ⛔ ⛔ \nDask ⛔ n/a \n==================== ==================== ====================", "execution_status": null }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "See " }, { "__type": "InlineRole", "__tag": 4003, "value": "dev-arrayapi", "domain": null, "role": "ref", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for more information." } ] } ] } ], "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": "statistic", "annotation": "(nx, ny) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The values of the selected statistic in each two-dimensional bin." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "x_edge", "annotation": "(nx + 1) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The bin edges along the first dimension." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "y_edge", "annotation": "(ny + 1) ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The bin edges along the second dimension." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "binnumber", "annotation": "(N,) array of ints or (2,N) ndarray of ints", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This assigns to each element of " }, { "__type": "InlineRole", "__tag": 4003, "value": "sample", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " an integer that represents the bin in which this observation falls. The representation depends on the " }, { "__type": "ParamRef", "__tag": 4071, "name": "expand_binnumbers" }, { "__type": "Text", "__tag": 4046, "value": " argument. See " }, { "__type": "InlineRole", "__tag": 4003, "value": "Notes", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for details." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compute a bidimensional binned statistic for one or more sets of data." } ] } ], "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": "x", "annotation": "(N,) array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A sequence of values to be binned along the first dimension." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "y", "annotation": "(N,) array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A sequence of values to be binned along the second dimension." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "values", "annotation": "(N,) array_like or list of (N,) array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The data on which the statistic will be computed. This must be the same shape as " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": ", or a list of sequences - each with the same shape as " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": ". If " }, { "__type": "ParamRef", "__tag": 4071, "name": "values" }, { "__type": "Text", "__tag": 4046, "value": " is such a list, the statistic will be computed on each independently." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "statistic", "annotation": "string or callable, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The statistic to compute (default is 'mean'). The following statistics are available:" } ] }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'mean'compute the mean of values for points within each bin. Empty bins will be represented by NaN." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'std'compute the standard deviation within each bin. This is implicitly calculated with ddof=0." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'median'compute the median of values for points within each bin. Empty bins will be represented by NaN." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'count'compute the count of points within each bin. This is identical to an unweighted histogram. " }, { "__type": "ParamRef", "__tag": 4071, "name": "values" }, { "__type": "Text", "__tag": 4046, "value": " array is not referenced." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'sum'compute the sum of values for points within each bin. This is identical to a weighted histogram." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'min'compute the minimum of values for points within each bin. Empty bins will be represented by NaN." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'max'compute the maximum of values for point within each bin. Empty bins will be represented by NaN." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "functiona user-defined function which takes a 1D array of values, and outputs a single numerical statistic. This function will be called on the values in each bin. Empty bins will be represented by function([]), or NaN if this returns an error." } ] } ] } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "bins", "annotation": "int or [int, int] or array_like or [array, array], optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The bin specification:" } ] }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "the number of bins for the two dimensions (nx = ny = bins)," } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "the number of bins in each dimension (nx, ny = bins)," } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "the bin edges for the two dimensions (x_edge = y_edge = bins)," } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "the bin edges in each dimension (x_edge, y_edge = bins)." } ] } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If the bin edges are specified, the number of bins will be, (nx = len(x_edge)-1, ny = len(y_edge)-1)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "range", "annotation": "(2,2) array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The leftmost and rightmost edges of the bins along each dimension (if not specified explicitly in the " }, { "__type": "ParamRef", "__tag": 4071, "name": "bins" }, { "__type": "Text", "__tag": 4046, "value": " parameters): [[xmin, xmax], [ymin, ymax]]. All values outside of this range will be considered outliers and not tallied in the histogram." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "expand_binnumbers", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'False' (default): the returned " }, { "__type": "CrossRef", "__tag": 4002, "value": "binnumber", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "binnumber" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " is a shape (N,) array of linearized bin indices. 'True': the returned " }, { "__type": "CrossRef", "__tag": 4002, "value": "binnumber", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "binnumber" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " is 'unraveled' into a shape (2,N) ndarray, where each row gives the bin numbers in the corresponding dimension. See the " }, { "__type": "CrossRef", "__tag": 4002, "value": "binnumber", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "binnumber" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " returned value, and the " }, { "__type": "InlineRole", "__tag": 4003, "value": "Examples", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " section." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.17.0" } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This is a generalization of a histogram2d function. A histogram divides the space into bins, and returns the count of the number of points in each bin. This function allows the computation of the sum, mean, median, or other statistic of the values (or set of values) within each bin." } ] } ], "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": "/scipy/stats/_binned_statistic.py", "item_line": 198, "item_type": "function", "aliases": [ "scipy.stats.binned_statistic_2d" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from scipy import stats\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nCalculate the counts with explicit bin-edges:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "x = [0.1, 0.1, 0.1, 0.6]\ny = [2.1, 2.6, 2.1, 2.1]\nbinx = [0.0, 0.5, 1.0]\nbiny = [2.0, 2.5, 3.0]\nret = stats.binned_statistic_2d(x, y, None, 'count', bins=[binx, biny])\nret.statistic\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nThe bin in which each sample is placed is given by the `binnumber`\nreturned parameter. By default, these are the linearized bin indices:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "ret.binnumber\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nThe bin indices can also be expanded into separate entries for each\ndimension using the `expand_binnumbers` parameter:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "ret = stats.binned_statistic_2d(x, y, None, 'count', bins=[binx, biny],\n expand_binnumbers=True)\nret.binnumber\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nWhich shows that the first three elements belong in the xbin 1, and the\nfourth into xbin 2; and so on for y." } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "binned_statistic", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._binned_statistic:binned_statistic" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "binned_statistic_dd", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._binned_statistic:binned_statistic_dd" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "numpy.digitize", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "numpy.digitize" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "numpy.histogram2d", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "numpy.histogram2d" }, "kind": "module" }, "descriptions": [], "type": "func" } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "x", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "y", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "values", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "statistic", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "mean" }, { "__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": "expand_binnumbers", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "binned_statistic_2d" }, "references": null, "qa": "scipy.stats._binned_statistic:binned_statistic_2d", "arbitrary": [], "local_refs": [ "binnumber", "bins", "expand_binnumbers", "range", "statistic", "values", "x", "x_edge", "y", "y_edge" ] }