{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In order to enable inversion of an STFT via the inverse STFT in " }, { "__type": "InlineRole", "__tag": 4003, "value": "istft", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", the signal windowing must obey the constraint of \"nonzero overlap add\" (NOLA):" } ] }, { "__type": "Math", "__tag": 4058, "value": "\\sum_{t}w^{2}[n-tH] \\ne 0" }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "for all " }, { "__type": "InlineMath", "__tag": 4057, "value": "n" }, { "__type": "Text", "__tag": 4046, "value": ", where " }, { "__type": "InlineMath", "__tag": 4057, "value": "w" }, { "__type": "Text", "__tag": 4046, "value": " is the window function, " }, { "__type": "InlineMath", "__tag": 4057, "value": "t" }, { "__type": "Text", "__tag": 4046, "value": " is the frame index, and " }, { "__type": "InlineMath", "__tag": 4057, "value": "H" }, { "__type": "Text", "__tag": 4046, "value": " is the hop size (" }, { "__type": "InlineMath", "__tag": 4057, "value": "H" }, { "__type": "Text", "__tag": 4046, "value": " = " }, { "__type": "ParamRef", "__tag": 4071, "name": "nperseg" }, { "__type": "Text", "__tag": 4046, "value": " - " }, { "__type": "ParamRef", "__tag": 4071, "name": "noverlap" }, { "__type": "Text", "__tag": 4046, "value": ")." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This ensures that the normalization factors in the denominator of the overlap-add inversion equation are not zero. Only very pathological windows will fail the NOLA constraint." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 1.2.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": "check_NOLA", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._spectral_py:check_NOLA" }, "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": "verdict", "annotation": "bool", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineRole", "__tag": 4003, "value": "True", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " if chosen combination satisfies the NOLA constraint within " }, { "__type": "ParamRef", "__tag": 4071, "name": "tol" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "False", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " otherwise" } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Check whether the Nonzero Overlap Add (NOLA) constraint is met." } ] } ], "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", "annotation": "str or tuple or array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Desired window to use. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "window" }, { "__type": "Text", "__tag": 4046, "value": " is a string or tuple, it is passed to " }, { "__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": " to generate the window values, which are DFT-even by default. See " }, { "__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": " for a list of windows and required parameters. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "window" }, { "__type": "Text", "__tag": 4046, "value": " is array_like it will be used directly as the window and its length must be nperseg." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "nperseg", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Length of each segment." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "noverlap", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of points to overlap between segments." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "tol", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The allowed variance of a bin's weighted sum from the median bin sum." } ] } ] } ] } ], "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/_spectral_py.py", "item_line": 1304, "item_type": "function", "aliases": [ "scipy.signal.check_NOLA" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy import signal\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nConfirm NOLA condition for rectangular window of 75% (3/4) overlap:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.check_NOLA(signal.windows.boxcar(100), 100, 75)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nNOLA is also true for 25% (1/4) overlap:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.check_NOLA(signal.windows.boxcar(100), 100, 25)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\n\"Symmetrical\" Hann window (for filter design) is also NOLA:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.check_NOLA(signal.windows.hann(120, sym=True), 120, 60)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nAs long as there is overlap, it takes quite a pathological window to fail\nNOLA:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "w = np.ones(64, dtype=\"float\")\nw[::2] = 0\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "signal.check_NOLA(w, 64, 32)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nIf there is not enough overlap, a window with zeros at the ends will not\nwork:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.check_NOLA(signal.windows.hann(64), 64, 0)\nsignal.check_NOLA(signal.windows.hann(64), 64, 1)\nsignal.check_NOLA(signal.windows.hann(64), 64, 2)\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "check_COLA", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._spectral_py:check_COLA" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Check whether the Constant OverLap Add (COLA) constraint is met" } ] } ], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "istft", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "istft" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Inverse Short Time Fourier Transform" } ] } ], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "stft", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "stft" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Short Time Fourier Transform" } ] } ], "type": "func" } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "window", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "nperseg", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "noverlap", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "tol", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1e-10" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "check_NOLA" }, "references": [ ".. [1] Julius O. Smith III, \"Spectral Audio Signal Processing\", W3K", " Publishing, 2011,ISBN 978-0-9745607-3-1.", ".. [2] G. Heinzel, A. Ruediger and R. Schilling, \"Spectrum and", " spectral density estimation by the Discrete Fourier transform", " (DFT), including a comprehensive list of window functions and", " some new at-top windows\", 2002,", " http://hdl.handle.net/11858/00-001M-0000-0013-557A-5" ], "qa": "scipy.signal._spectral_py:check_NOLA", "arbitrary": [], "local_refs": [ "noverlap", "nperseg", "tol", "verdict", "window" ] }