{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This polyphase method will likely be faster than the Fourier method in " }, { "__type": "CrossRef", "__tag": 4002, "value": "scipy.signal.resample", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "*", "kind": "api", "path": "scipy.signal._signaltools:resample" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " when the number of samples is large and prime, or when the number of samples is large and " }, { "__type": "ParamRef", "__tag": 4071, "name": "up" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "down" }, { "__type": "Text", "__tag": 4046, "value": " share a large greatest common denominator. The length of the FIR filter used will depend on " }, { "__type": "InlineCode", "__tag": 4051, "value": "max(up, down) // gcd(up, down)" }, { "__type": "Text", "__tag": 4046, "value": ", and the number of operations during polyphase filtering will depend on the filter length and " }, { "__type": "ParamRef", "__tag": 4071, "name": "down" }, { "__type": "Text", "__tag": 4046, "value": " (see " }, { "__type": "CrossRef", "__tag": 4002, "value": "scipy.signal.upfirdn", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "*", "kind": "api", "path": "scipy.signal._upfirdn:upfirdn" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " for details)." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The argument " }, { "__type": "ParamRef", "__tag": 4071, "name": "window" }, { "__type": "Text", "__tag": 4046, "value": " specifies the FIR low-pass filter design." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "window" }, { "__type": "Text", "__tag": 4046, "value": " is an array_like it is assumed to be the FIR filter coefficients. Note that the FIR filter is applied after the upsampling step, so it should be designed to operate on a signal at a sampling frequency higher than the original by a factor of " }, { "__type": "InlineRole", "__tag": 4003, "value": "up//gcd(up, down)", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ". This function's output will be centered with respect to this array, so it is best to pass a symmetric filter with an odd number of samples if, as is usually the case, a zero-phase filter is desired." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For any other type of " }, { "__type": "ParamRef", "__tag": 4071, "name": "window" }, { "__type": "Text", "__tag": 4046, "value": ", the functions " }, { "__type": "CrossRef", "__tag": 4002, "value": "scipy.signal.get_window", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "*", "kind": "api", "path": "scipy.signal.windows._windows:get_window" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "CrossRef", "__tag": 4002, "value": "scipy.signal.firwin", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "*", "kind": "api", "path": "scipy.signal._fir_filter_design:firwin" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " are called to generate the appropriate filter coefficients." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The first sample of the returned vector is the same as the first sample of the input vector. The spacing between samples is changed from " }, { "__type": "InlineCode", "__tag": 4051, "value": "dx" }, { "__type": "Text", "__tag": 4046, "value": " to " }, { "__type": "InlineCode", "__tag": 4051, "value": "dx * down / float(up)" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__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": "resample_poly", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._signaltools:resample_poly" }, "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 ⚠️ no JIT ⛔ \nDask ⛔ n/a \n==================== ==================== ====================", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "CuPy only supports " }, { "__type": "InlineCode", "__tag": 4051, "value": "padtype=\"constant\"" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__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": "resampled_x", "annotation": "array", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The resampled array." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Resample " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": " along the given axis using polyphase filtering." } ] } ], "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_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The data to be resampled." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "up", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The upsampling factor." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "down", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The downsampling factor." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "axis", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The axis of " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": " that is resampled. Default is 0." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "window", "annotation": "string, tuple, or array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Desired window to use to design the low-pass filter, or the FIR filter coefficients to employ. See below for details." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "padtype", "annotation": "string, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineRole", "__tag": 4003, "value": "constant", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "line", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "mean", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "median", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "CrossRef", "__tag": 4002, "value": "maximum", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.ndimage._measurements:maximum" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "CrossRef", "__tag": 4002, "value": "minimum", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.ndimage._measurements:minimum" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " or any of the other signal extension modes supported by " }, { "__type": "CrossRef", "__tag": 4002, "value": "scipy.signal.upfirdn", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "*", "kind": "api", "path": "scipy.signal._upfirdn:upfirdn" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ". Changes assumptions on values beyond the boundary. If " }, { "__type": "InlineRole", "__tag": 4003, "value": "constant", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", assumed to be " }, { "__type": "ParamRef", "__tag": 4071, "name": "cval" }, { "__type": "Text", "__tag": 4046, "value": " (default zero). If " }, { "__type": "InlineRole", "__tag": 4003, "value": "line", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " assumed to continue a linear trend defined by the first and last points. " }, { "__type": "InlineRole", "__tag": 4003, "value": "mean", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "median", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "CrossRef", "__tag": 4002, "value": "maximum", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.ndimage._measurements:maximum" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "CrossRef", "__tag": 4002, "value": "minimum", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.ndimage._measurements:minimum" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " work as in " }, { "__type": "InlineRole", "__tag": 4003, "value": "np.pad", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " and assume that the values beyond the boundary are the mean, median, maximum or minimum respectively of the array along the axis." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 1.4.0" } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "cval", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Value to use if " }, { "__type": "InlineRole", "__tag": 4003, "value": "padtype='constant'", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ". Default is zero." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 1.4.0" } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The signal " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": " is upsampled by the factor " }, { "__type": "ParamRef", "__tag": 4071, "name": "up" }, { "__type": "Text", "__tag": 4046, "value": ", a zero-phase low-pass FIR filter is applied, and then it is downsampled by the factor " }, { "__type": "ParamRef", "__tag": 4071, "name": "down" }, { "__type": "Text", "__tag": 4046, "value": ". The resulting sample rate is " }, { "__type": "InlineCode", "__tag": 4051, "value": "up / down" }, { "__type": "Text", "__tag": 4046, "value": " times the original sample rate. By default, values beyond the boundary of the signal are assumed to be zero during the filtering step." } ] } ], "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/_signaltools.py", "item_line": 3866, "item_type": "function", "aliases": [ "scipy.signal.resample_poly" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "By default, the end of the resampled data rises to meet the first\nsample of the next cycle for the FFT method, and gets closer to zero\nfor the polyphase method:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy import signal\nimport matplotlib.pyplot as plt\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "x = np.linspace(0, 10, 20, endpoint=False)\ny = np.cos(-x**2/6.0)\nf_fft = signal.resample(y, 100)\nf_poly = signal.resample_poly(y, 100, 20)\nxnew = np.linspace(0, 10, 100, endpoint=False)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "plt.plot(xnew, f_fft, 'b.-', xnew, f_poly, 'r.-')\nplt.plot(x, y, 'ko-')\nplt.plot(10, y[0], 'bo', 10, 0., 'ro') # boundaries\nplt.legend(['resample', 'resamp_poly', 'data'], loc='best')\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-fed19d7d418f62f5.png" } }, { "__type": "Text", "__tag": 4046, "value": "\nThis default behaviour can be changed by using the padtype option:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "N = 5\nx = np.linspace(0, 1, N, endpoint=False)\ny = 2 + x**2 - 1.7*np.sin(x) + .2*np.cos(11*x)\ny2 = 1 + x**3 + 0.1*np.sin(x) + .1*np.cos(11*x)\nY = np.stack([y, y2], axis=-1)\nup = 4\nxr = np.linspace(0, 1, N*up, endpoint=False)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "y2 = signal.resample_poly(Y, up, 1, padtype='constant')\ny3 = signal.resample_poly(Y, up, 1, padtype='mean')\ny4 = signal.resample_poly(Y, up, 1, padtype='line')\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "for i in [0,1]:\n plt.figure()\n plt.plot(xr, y4[:,i], 'g.', label='line')\n plt.plot(xr, y3[:,i], 'y.', label='mean')\n plt.plot(xr, y2[:,i], 'r.', label='constant')\n plt.plot(x, Y[:,i], 'k-')\n plt.legend()\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-368ab624175744ef.png" } }, { "__type": "Figure", "__tag": 4024, "value": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "1.17.1", "kind": "assets", "path": "fig-d5979fa23a8de6ba.png" } } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "decimate", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._signaltools:decimate" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Downsample the signal after applying an FIR or IIR filter." } ] } ], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "resample", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "resample" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Resample up or down using the FFT method." } ] } ], "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": "up", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "down", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "axis", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0" }, { "__type": "SigParam", "__tag": 4030, "name": "window", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "('kaiser', 5.0)" }, { "__type": "SigParam", "__tag": 4030, "name": "padtype", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "constant" }, { "__type": "SigParam", "__tag": 4030, "name": "cval", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "resample_poly" }, "references": null, "qa": "scipy.signal._signaltools:resample_poly", "arbitrary": [], "local_refs": [ "axis", "cval", "down", "padtype", "resampled_x", "up", "window", "x" ] }