{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [], "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": "circmeandev", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Circular mean (absolute) deviation, restricted to the range " }, { "__type": "InlineCode", "__tag": 4051, "value": "[low, high]" }, { "__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 circular mean (absolute) deviation of an angular sample." } ] } ], "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": "sample", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input array of angle observations." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "alpha", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The reference angle with respect to which the mean deviation is computed." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "high", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Upper boundary of the principal value of an angle. Default is " }, { "__type": "InlineCode", "__tag": 4051, "value": "2*pi" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "low", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Lower boundary of the principal value of an angle. Default is " }, { "__type": "InlineCode", "__tag": 4051, "value": "0" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Given " }, { "__type": "InlineMath", "__tag": 4057, "value": "n" }, { "__type": "Text", "__tag": 4046, "value": " angle observations " }, { "__type": "InlineMath", "__tag": 4057, "value": "x_1, \\cdots, x_n" }, { "__type": "Text", "__tag": 4046, "value": " measured in radians, the " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "circular mean (absolute) deviation" } ] }, { "__type": "Text", "__tag": 4046, "value": " about a given angle " }, { "__type": "InlineMath", "__tag": 4057, "value": "\\alpha" }, { "__type": "Text", "__tag": 4046, "value": " is defined by (" }, { "__type": "FootnoteReference", "__tag": 4066, "label": "1" }, { "__type": "Text", "__tag": 4046, "value": ", Eq. 2.3.14)" } ] }, { "__type": "Math", "__tag": 4058, "value": "d_0(\\alpha) = \\frac{1}{n} \\sum_{i=1}^n\n \\min \\left(x_i - \\alpha, 2 \\pi - (x_i - \\alpha) \\right)." }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For greater generality, this function computes:" } ] }, { "__type": "Math", "__tag": 4058, "value": "d_0(\\alpha) = \\frac{1}{n} \\sum_{i=1}^n \\min(y_i, T - y_i)," }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "where " }, { "__type": "InlineMath", "__tag": 4057, "value": "y_i = (x_i - \\alpha) \\mod T" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineMath", "__tag": 4057, "value": "T" }, { "__type": "Text", "__tag": 4046, "value": " is the period of a full revolution (e.g. " }, { "__type": "InlineMath", "__tag": 4057, "value": "360" }, { "__type": "Text", "__tag": 4046, "value": " when working in degrees)." } ] } ], "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": "build-install/usr/lib/python3.14/site-packages/scipy/stats/_circstats.py", "item_line": 13, "item_type": "function", "aliases": [ "scipy.stats._circstats._circmeandev" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.stats._circstats import _circmeandev\nimport matplotlib.pyplot as plt\nsample = np.array([20, 30, 330])\n", "execution_status": "success", "out": "" }, { "__type": "Code", "__tag": 4050, "value": "dev = _circmeandev(sample, sample, high=360, low=0)\n", "execution_status": "failure", "out": "" }, { "__type": "Text", "__tag": 4046, "value": "\nAmong all the observations, the circular mean deviation is minimized about 20\ndegrees, so 20 degrees is the circular median." } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "circmean", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._circstats:circmean" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Circular mean." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "circstd", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._circstats:circstd" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Circular standard deviation." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "circvar", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.stats._circstats:circvar" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Circular variance." } ] } ], "type": null } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "sample", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "alpha", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "high", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "6.283185307179586" }, { "__type": "SigParam", "__tag": 4030, "name": "low", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "0" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "_circmeandev" }, "references": [ ".. [1] Mardia, K. V. and Jupp, P. E. *Directional Statistics*.", " John Wiley & Sons, 1999." ], "qa": "scipy.stats._circstats:_circmeandev", "arbitrary": [], "local_refs": [ "alpha", "circmeandev", "high", "low", "sample" ] }