{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The defaults are chosen such that " }, { "__type": "InlineCode", "__tag": 4051, "value": "signal.zoom_fft(x, 2)" }, { "__type": "Text", "__tag": 4046, "value": " is equivalent to " }, { "__type": "InlineCode", "__tag": 4051, "value": "fft.fft(x)" }, { "__type": "Text", "__tag": 4046, "value": " and, if " }, { "__type": "InlineCode", "__tag": 4051, "value": "m > len(x)" }, { "__type": "Text", "__tag": 4046, "value": ", that " }, { "__type": "InlineCode", "__tag": 4051, "value": "signal.zoom_fft(x, 2, m)" }, { "__type": "Text", "__tag": 4046, "value": " is equivalent to " }, { "__type": "InlineCode", "__tag": 4051, "value": "fft.fft(x, m)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "To graph the magnitude of the resulting transform, use " } ] }, { "__type": "Code", "__tag": 4050, "value": "plot(linspace(f1, f2, m, endpoint=False), abs(zoom_fft(x, [f1, f2], m)))", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If the transform needs to be repeated, use " }, { "__type": "CrossRef", "__tag": 4002, "value": "ZoomFFT", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._czt:ZoomFFT" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " to construct a specialized transform function which can be reused without recomputing constants." } ] }, { "__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": "zoom_fft", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._czt:zoom_fft" }, "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": "out", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The transformed signal. The Fourier transform will be calculated at the points f1, f1+df, f1+2df, ..., f2, where df=(f2-f1)/m." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compute the DFT of " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": " only for frequencies in range " }, { "__type": "ParamRef", "__tag": 4071, "name": "fn" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "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": "x", "annotation": "array", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The signal to transform." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "fn", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A length-2 sequence [" }, { "__type": "InlineRole", "__tag": 4003, "value": "f1", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "f2", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "] giving the frequency range, or a scalar, for which the range [0, " }, { "__type": "ParamRef", "__tag": 4071, "name": "fn" }, { "__type": "Text", "__tag": 4046, "value": "] is assumed." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "m", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The number of points to evaluate. The default is the length of " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "fs", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The sampling frequency. If " }, { "__type": "InlineCode", "__tag": 4051, "value": "fs=10" }, { "__type": "Text", "__tag": 4046, "value": " represented 10 kHz, for example, then " }, { "__type": "InlineRole", "__tag": 4003, "value": "f1", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineRole", "__tag": 4003, "value": "f2", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " would also be given in kHz. The default sampling frequency is 2, so " }, { "__type": "InlineRole", "__tag": 4003, "value": "f1", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineRole", "__tag": 4003, "value": "f2", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " should be in the range [0, 1] to keep the transform below the Nyquist frequency." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "endpoint", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, " }, { "__type": "InlineRole", "__tag": 4003, "value": "f2", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " is the last sample. Otherwise, it is not included. Default is False." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "axis", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Axis over which to compute the FFT. If not given, the last axis is used." } ] } ] } ] } ], "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/_czt.py", "item_line": 508, "item_type": "function", "aliases": [ "scipy.signal.zoom_fft" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "To plot the transform results use something like the following:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.signal import zoom_fft\nt = np.linspace(0, 1, 1021)\nx = np.cos(2*np.pi*15*t) + np.sin(2*np.pi*17*t)\nf1, f2 = 5, 27\nX = zoom_fft(x, [f1, f2], len(x), fs=1021)\nf = np.linspace(f1, f2, len(x))\nimport matplotlib.pyplot as plt\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "plt.plot(f, 20*np.log10(np.abs(X)))\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "plt.show()\n", "execution_status": "success" }, { "__type": "Figure", "__tag": 4024, "value": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "1.17.1", "kind": "assets", "path": "fig-b831c157968c3562.png" } } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "ZoomFFT", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._czt:ZoomFFT" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Class that creates a callable partial FFT function." } ] } ], "type": "func" } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "x", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "fn", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "m", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "fs", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "2" }, { "__type": "SigParam", "__tag": 4030, "name": "endpoint", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "axis", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "-1" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "zoom_fft" }, "references": null, "qa": "scipy.signal._czt:zoom_fft", "arbitrary": [], "local_refs": [ "axis", "endpoint", "fn", "fs", "m", "out", "x" ] }