{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In order to invert a short-time Fourier transfrom (STFT) with the so-called \"overlap-add method\", the signal windowing must obey the constraint of \"Constant OverLap Add\" (COLA). This ensures that every point in the input data is equally weighted, thereby avoiding aliasing and allowing full reconstruction. Note that the algorithms implemented in " }, { "__type": "InlineRole", "__tag": 4003, "value": "ShortTimeFFT.istft", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " and in " }, { "__type": "InlineRole", "__tag": 4003, "value": "istft", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " (legacy) only require that the weaker \"nonzero overlap-add\" condition (as in " }, { "__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": ") is met." } ] }, { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Some examples of windows that satisfy COLA:" } ] }, "dd": [ { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Rectangular window at overlap of 0, 1/2, 2/3, 3/4, ..." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Bartlett window at overlap of 1/2, 3/4, 5/6, ..." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Hann window at 1/2, 2/3, 3/4, ..." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Any Blackman family window at 2/3 overlap" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Any window with " }, { "__type": "InlineCode", "__tag": 4051, "value": "noverlap = nperseg-1" } ] } ] } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A very comprehensive list of other windows may be found in " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "2" }, { "__type": "Text", "__tag": 4046, "value": ", wherein the COLA condition is satisfied when the \"Amplitude Flatness\" is unity." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.19.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_COLA", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._spectral_py:check_COLA" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " is not in-scope for support of Python Array API Standard compatible backends other than NumPy." } ] }, { "__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 COLA 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 Constant OverLap Add (COLA) constraint is met (legacy function)." } ] } ], "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": 1158, "item_type": "function", "aliases": [ "scipy.signal.check_COLA" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from scipy import signal\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nConfirm COLA condition for rectangular window of 75% (3/4) overlap:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.check_COLA(signal.windows.boxcar(100), 100, 75)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nCOLA is not true for 25% (1/4) overlap, though:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.check_COLA(signal.windows.boxcar(100), 100, 25)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\n\"Symmetrical\" Hann window (for filter design) is not COLA:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.check_COLA(signal.windows.hann(120, sym=True), 120, 60)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\n\"Periodic\" or \"DFT-even\" Hann window (for FFT analysis) is COLA for\noverlap of 1/2, 2/3, 3/4, etc.:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.check_COLA(signal.windows.hann(120, sym=False), 120, 60)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.check_COLA(signal.windows.hann(120, sym=False), 120, 80)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.check_COLA(signal.windows.hann(120, sym=False), 120, 90)\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "ShortTimeFFT", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._short_time_fft:ShortTimeFFT" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Provide short-time Fourier transform and its inverse" } ] } ], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "check_NOLA", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._spectral_py:check_NOLA" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Check whether the Nonzero Overlap Add (NOLA) constraint is met" } ] } ], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "closest_STFT_dual_window", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._short_time_fft:closest_STFT_dual_window" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Allows determining the closest window meeting the COLA constraint for a given window" } ] } ], "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 (legacy)" } ] } ], "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 (legacy)" } ] } ], "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_COLA" }, "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_COLA", "arbitrary": [], "local_refs": [ "noverlap", "nperseg", "tol", "verdict", "window" ] }