{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__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": "labeled_comprehension", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.ndimage._measurements:labeled_comprehension" }, "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 ⚠️ no JIT ⛔ \nDask ⚠️ computes graph 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": "result", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Result of applying " }, { "__type": "ParamRef", "__tag": 4071, "name": "func" }, { "__type": "Text", "__tag": 4046, "value": " to each of " }, { "__type": "ParamRef", "__tag": 4071, "name": "labels" }, { "__type": "Text", "__tag": 4046, "value": " to " }, { "__type": "ParamRef", "__tag": 4071, "name": "input" }, { "__type": "Text", "__tag": 4046, "value": " in " }, { "__type": "ParamRef", "__tag": 4071, "name": "index" }, { "__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": "Roughly equivalent to [func(input[labels == i]) for i in index]." } ] } ], "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": "input", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Data from which to select " }, { "__type": "ParamRef", "__tag": 4071, "name": "labels" }, { "__type": "Text", "__tag": 4046, "value": " to process." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "labels", "annotation": "array_like or None", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Labels to objects in " }, { "__type": "ParamRef", "__tag": 4071, "name": "input" }, { "__type": "Text", "__tag": 4046, "value": ". If not None, array must be same shape as " }, { "__type": "ParamRef", "__tag": 4071, "name": "input" }, { "__type": "Text", "__tag": 4046, "value": ". If None, " }, { "__type": "ParamRef", "__tag": 4071, "name": "func" }, { "__type": "Text", "__tag": 4046, "value": " is applied to raveled " }, { "__type": "ParamRef", "__tag": 4071, "name": "input" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "index", "annotation": "int, sequence of ints or None", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Subset of " }, { "__type": "ParamRef", "__tag": 4071, "name": "labels" }, { "__type": "Text", "__tag": 4046, "value": " to which to apply " }, { "__type": "ParamRef", "__tag": 4071, "name": "func" }, { "__type": "Text", "__tag": 4046, "value": ". If a scalar, a single value is returned. If None, " }, { "__type": "ParamRef", "__tag": 4071, "name": "func" }, { "__type": "Text", "__tag": 4046, "value": " is applied to all non-zero values of " }, { "__type": "ParamRef", "__tag": 4071, "name": "labels" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "func", "annotation": "callable", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Python function to apply to " }, { "__type": "ParamRef", "__tag": 4071, "name": "labels" }, { "__type": "Text", "__tag": 4046, "value": " from " }, { "__type": "ParamRef", "__tag": 4071, "name": "input" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "out_dtype", "annotation": "dtype", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Dtype to use for " }, { "__type": "CrossRef", "__tag": 4002, "value": "result", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "result" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "default", "annotation": "int, float or None", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Default return value when an element of " }, { "__type": "ParamRef", "__tag": 4071, "name": "index" }, { "__type": "Text", "__tag": 4046, "value": " does not exist in " }, { "__type": "ParamRef", "__tag": 4071, "name": "labels" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "pass_positions", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, pass linear indices to " }, { "__type": "ParamRef", "__tag": 4071, "name": "func" }, { "__type": "Text", "__tag": 4046, "value": " as a second argument. Default is False." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Sequentially applies an arbitrary function (that works on array_like input) to subsets of an N-D image array specified by " }, { "__type": "ParamRef", "__tag": 4071, "name": "labels" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "index" }, { "__type": "Text", "__tag": 4046, "value": ". The option exists to provide the function with positional parameters as the second argument." } ] } ], "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/ndimage/_measurements.py", "item_line": 426, "item_type": "function", "aliases": [ "scipy.ndimage.labeled_comprehension" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\na = np.array([[1, 2, 0, 0],\n [5, 3, 0, 4],\n [0, 0, 0, 7],\n [9, 3, 0, 0]])\nfrom scipy import ndimage\nlbl, nlbl = ndimage.label(a)\nlbls = np.arange(1, nlbl+1)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "ndimage.labeled_comprehension(a, lbl, lbls, np.mean, float, 0)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nFalling back to `default`:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "lbls = np.arange(1, nlbl+2)\nndimage.labeled_comprehension(a, lbl, lbls, np.mean, float, -1)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nPassing positions:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "def fn(val, pos):\n print(\"fn says: %s : %s\" % (val, pos))\n return (val.sum()) if (pos.sum() % 2 == 0) else (-val.sum())\nndimage.labeled_comprehension(a, lbl, lbls, fn, float, 0, True)\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "input", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "labels", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "index", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "func", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "out_dtype", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "default", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "pass_positions", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "labeled_comprehension" }, "references": null, "qa": "scipy.ndimage._measurements:labeled_comprehension", "arbitrary": [], "local_refs": [ "default", "func", "index", "input", "labels", "out_dtype", "pass_positions", "result" ] }