{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "It is designed to be suitable for use with the modified discrete cosine transform (MDCT) and is mainly used in audio signal processing and audio coding." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 1.9.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": "kaiser_bessel_derived", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal.windows._windows:kaiser_bessel_derived" }, "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": "w", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The window, normalized to fulfil the Princen-Bradley condition." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Return a Kaiser-Bessel derived window." } ] } ], "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": "M", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of points in the output window. If zero, an empty array is returned. An exception is thrown when it is negative. Note that this window is only defined for an even number of points." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "beta", "annotation": "float", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Kaiser window shape parameter." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "sym", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This parameter only exists to comply with the interface offered by the other window functions and to be callable by " }, { "__type": "CrossRef", "__tag": 4002, "value": "get_window", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal.windows._windows:get_window" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ". When True (default), generates a symmetric window, for use in filter design." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "xp", "annotation": "array_namespace, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Optional array namespace. Should be compatible with the array API standard, or supported by array-api-compat. Default: " }, { "__type": "InlineCode", "__tag": 4051, "value": "numpy" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "device: any", "annotation": "", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "optional device specification for output. Should match one of the supported device specification in " }, { "__type": "InlineCode", "__tag": 4051, "value": "xp" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "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/windows/_windows.py", "item_line": 1325, "item_type": "function", "aliases": [ "scipy.signal.windows.kaiser_bessel_derived" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "Plot the Kaiser-Bessel derived window based on the wikipedia\nreference [2]_:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy import signal\nimport matplotlib.pyplot as plt\nfig, ax = plt.subplots()\nN = 50\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "for alpha in [0.64, 2.55, 7.64, 31.83]:\n ax.plot(signal.windows.kaiser_bessel_derived(2*N, np.pi*alpha),\n label=f\"{alpha=}\")\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "ax.grid(True)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "ax.set_title(\"Kaiser-Bessel derived window\")\nax.set_ylabel(\"Amplitude\")\nax.set_xlabel(\"Sample\")\nax.set_xticks([0, N, 2*N-1])\nax.set_yticks([0.0, 0.2, 0.4, 0.6, 0.707, 0.8, 1.0])\nfig.legend(loc=\"center\")\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "fig.tight_layout()\nfig.show()\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "kaiser", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal.windows._windows:kaiser" }, "kind": "module" }, "descriptions": [], "type": "func" } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "M", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "beta", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "sym", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "True" }, { "__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": "kaiser_bessel_derived" }, "references": [ ".. [1] Bosi, Marina, and Richard E. Goldberg. Introduction to Digital", " Audio Coding and Standards. Dordrecht: Kluwer, 2003.", ".. [2] Wikipedia, \"Kaiser window\",", " https://en.wikipedia.org/wiki/Kaiser_window" ], "qa": "scipy.signal.windows._windows:kaiser_bessel_derived", "arbitrary": [], "local_refs": [ "M", "beta", "device: any", "sym", "w", "xp" ] }