{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.14.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": "savgol_coeffs", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._savitzky_golay:savgol_coeffs" }, "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": "coeffs", "annotation": "1-D ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The filter coefficients." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compute the coefficients for a 1-D Savitzky-Golay FIR filter." } ] } ], "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": "window_length", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The length of the filter window (i.e., the number of coefficients)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "polyorder", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The order of the polynomial used to fit the samples. " }, { "__type": "ParamRef", "__tag": 4071, "name": "polyorder" }, { "__type": "Text", "__tag": 4046, "value": " must be less than " }, { "__type": "ParamRef", "__tag": 4071, "name": "window_length" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "deriv", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The order of the derivative to compute. This must be a nonnegative integer. The default is 0, which means to filter the data without differentiating." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "delta", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The spacing of the samples to which the filter will be applied. This is only used if deriv > 0." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "pos", "annotation": "int or None, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If pos is not None, it specifies evaluation position within the window. The default is the middle of the window." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "use", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Either 'conv' or 'dot'. This argument chooses the order of the coefficients. The default is 'conv', which means that the coefficients are ordered to be used in a convolution. With use='dot', the order is reversed, so the filter is applied by dotting the coefficients with the data set." } ] } ] } ] } ], "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": "/scipy/signal/_savitzky_golay.py", "item_line": 11, "item_type": "function", "aliases": [ "scipy.signal.savgol_coeffs" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.signal import savgol_coeffs\nsavgol_coeffs(5, 2)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "savgol_coeffs(5, 2, deriv=1)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nNote that use='dot' simply reverses the coefficients.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "savgol_coeffs(5, 2, pos=3)\nsavgol_coeffs(5, 2, pos=3, use='dot')\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "savgol_coeffs(4, 2, pos=3, deriv=1, use='dot')\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\n`x` contains data from the parabola x = t**2, sampled at\nt = -1, 0, 1, 2, 3. `c` holds the coefficients that will compute the\nderivative at the last position. When dotted with `x` the result should\nbe 6.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "x = np.array([1, 0, 1, 4, 9])\nc = savgol_coeffs(5, 2, pos=4, deriv=1, use='dot')\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "c.dot(x)\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "savgol_filter", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._savitzky_golay:savgol_filter" }, "kind": "module" }, "descriptions": [], "type": "func" } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "window_length", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "polyorder", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "deriv", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0" }, { "__type": "SigParam", "__tag": 4030, "name": "delta", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1.0" }, { "__type": "SigParam", "__tag": 4030, "name": "pos", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "use", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "conv" }, { "__type": "SigParam", "__tag": 4030, "name": "xp", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "device", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "savgol_coeffs" }, "references": [ "A. Savitzky, M. J. E. Golay, Smoothing and Differentiation of Data by", "Simplified Least Squares Procedures. Analytical Chemistry, 1964, 36 (8),", "pp 1627-1639.", "Jianwen Luo, Kui Ying, and Jing Bai. 2005. Savitzky-Golay smoothing and", "differentiation filter for even number data. Signal Process.", "85, 7 (July 2005), 1429-1434." ], "qa": "scipy.signal._savitzky_golay:savgol_coeffs", "arbitrary": [], "local_refs": [ "coeffs", "delta", "deriv", "polyorder", "pos", "use", "window_length" ] }