{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This function iteratively " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "removes" } ] }, { "__type": "Text", "__tag": 4046, "value": " observations. Once observations are removed, they are not re-added in subsequent iterations. Consequently, although it is often the case that " }, { "__type": "InlineCode", "__tag": 4051, "value": "clipped" }, { "__type": "Text", "__tag": 4046, "value": " is identical to " }, { "__type": "InlineCode", "__tag": 4051, "value": "a[(a >= lower) & (a <= upper)]" }, { "__type": "Text", "__tag": 4046, "value": ", this property is not guaranteed to be satisfied; " }, { "__type": "InlineCode", "__tag": 4051, "value": "clipped" }, { "__type": "Text", "__tag": 4046, "value": " may have fewer elements." } ] }, { "__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": "sigmaclip", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._stats_py:sigmaclip" }, "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 ⚠️ no JIT \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": "clipped", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input array with clipped elements removed." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "lower", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Lower threshold value use for clipping." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "upper", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Upper threshold value use for clipping." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Perform iterative sigma-clipping of array elements." } ] } ], "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": "Data array, will be raveled if not 1-D." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "low", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Lower bound factor of sigma clipping. Default is 4." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "high", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Upper bound factor of sigma clipping. Default is 4." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Starting from the full sample, all elements outside the critical range are removed, i.e. all elements of the input array " }, { "__type": "InlineRole", "__tag": 4003, "value": "c", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " that satisfy either of the following conditions " } ] }, { "__type": "Code", "__tag": 4050, "value": "c < mean(c) - std(c)*low\nc > mean(c) + std(c)*high", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The iteration continues with the updated sample until no elements are outside the (updated) range." } ] } ], "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/_stats_py.py", "item_line": 3382, "item_type": "function", "aliases": [ "scipy.stats.sigmaclip" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.stats import sigmaclip\na = np.concatenate((np.linspace(9.5, 10.5, 31),\n np.linspace(0, 20, 5)))\nfact = 1.5\nc, low, upp = sigmaclip(a, fact, fact)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "c\nc.var(), c.std()\nlow, c.mean() - fact*c.std(), c.min()\nupp, c.mean() + fact*c.std(), c.max()\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "a = np.concatenate((np.linspace(9.5, 10.5, 11),\n np.linspace(-100, -50, 3)))\nc, low, upp = sigmaclip(a, 1.8, 1.8)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "(c == np.linspace(9.5, 10.5, 11)).all()\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [], "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": "low", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "4.0" }, { "__type": "SigParam", "__tag": 4030, "name": "high", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "4.0" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "sigmaclip" }, "references": null, "qa": "scipy.stats._stats_py:sigmaclip", "arbitrary": [], "local_refs": [ "a", "clipped", "high", "low", "lower", "upper" ] }