{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The algorithm is an implementation of the block diagram shown on page 129 of the Vaidyanathan text " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "1" }, { "__type": "Text", "__tag": 4046, "value": " (Figure 4.3-8d)." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The direct approach of upsampling by factor of P with zero insertion, FIR filtering of length " }, { "__type": "InlineCode", "__tag": 4051, "value": "N" }, { "__type": "Text", "__tag": 4046, "value": ", and downsampling by factor of Q is O(N*Q) per output sample. The polyphase implementation used here is O(N/P)." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.18" } ] } ] }, { "__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": "upfirdn", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._upfirdn:upfirdn" }, "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 ⚠️ computes graph n/a \n==================== ==================== ====================", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "CuPy only supports " }, { "__type": "InlineCode", "__tag": 4051, "value": "mode=\"constant\"" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "cval=0.0" }, { "__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": "y", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The output signal array. Dimensions will be the same as " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": " except for along " }, { "__type": "ParamRef", "__tag": 4071, "name": "axis" }, { "__type": "Text", "__tag": 4046, "value": ", which will change size according to the " }, { "__type": "ParamRef", "__tag": 4071, "name": "h" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "ParamRef", "__tag": 4071, "name": "up" }, { "__type": "Text", "__tag": 4046, "value": ", and " }, { "__type": "ParamRef", "__tag": 4071, "name": "down" }, { "__type": "Text", "__tag": 4046, "value": " parameters." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Upsample, FIR filter, and downsample." } ] } ], "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": "h", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "1-D FIR (finite-impulse response) filter coefficients." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "x", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input signal array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "up", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Upsampling rate. Default is 1." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "down", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Downsampling rate. Default is 1." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "axis", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The axis of the input data array along which to apply the linear filter. The filter is applied to each subarray along this axis. Default is -1." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "mode", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The signal extension mode to use. The set " }, { "__type": "InlineCode", "__tag": 4051, "value": "{\"constant\", \"symmetric\", \"reflect\", \"edge\", \"wrap\"}" }, { "__type": "Text", "__tag": 4046, "value": " correspond to modes provided by " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.pad", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "numpy", "version": "*", "kind": "api", "path": "numpy:pad" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ". " }, { "__type": "InlineCode", "__tag": 4051, "value": "\"smooth\"" }, { "__type": "Text", "__tag": 4046, "value": " implements a smooth extension by extending based on the slope of the last 2 points at each end of the array. " }, { "__type": "InlineCode", "__tag": 4051, "value": "\"antireflect\"" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "\"antisymmetric\"" }, { "__type": "Text", "__tag": 4046, "value": " are anti-symmetric versions of " }, { "__type": "InlineCode", "__tag": 4051, "value": "\"reflect\"" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "\"symmetric\"" }, { "__type": "Text", "__tag": 4046, "value": ". The mode " }, { "__type": "InlineRole", "__tag": 4003, "value": "\"line\"", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " extends the signal based on a linear trend defined by the first and last points along the " }, { "__type": "InlineCode", "__tag": 4051, "value": "axis" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__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": "The constant value to use when " }, { "__type": "InlineCode", "__tag": 4051, "value": "mode == \"constant\"" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__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": [], "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/_upfirdn.py", "item_line": 108, "item_type": "function", "aliases": [ "scipy.signal.upfirdn" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "Simple operations:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.signal import upfirdn\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "upfirdn([1, 1, 1], [1, 1, 1]) # FIR filter\nupfirdn([1], [1, 2, 3], 3) # upsampling with zeros insertion\nupfirdn([1, 1, 1], [1, 2, 3], 3) # upsampling with sample-and-hold\nupfirdn([.5, 1, .5], [1, 1, 1], 2) # linear interpolation\nupfirdn([1], np.arange(10), 1, 3) # decimation by 3\nupfirdn([.5, 1, .5], np.arange(10), 2, 3) # linear interp, rate 2/3\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nApply a single filter to multiple signals:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "x = np.reshape(np.arange(8), (4, 2))\nx\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nApply along the last dimension of ``x``:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "h = [1, 1]\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "upfirdn(h, x, 2)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nApply along the 0th dimension of ``x``:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "upfirdn(h, x, 2, axis=0)\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "h", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__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": "1" }, { "__type": "SigParam", "__tag": 4030, "name": "down", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1" }, { "__type": "SigParam", "__tag": 4030, "name": "axis", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "-1" }, { "__type": "SigParam", "__tag": 4030, "name": "mode", "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": "0" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "upfirdn" }, "references": [ ".. [1] P. P. Vaidyanathan, Multirate Systems and Filter Banks,", " Prentice Hall, 1993." ], "qa": "scipy.signal._upfirdn:upfirdn", "arbitrary": [], "local_refs": [ "axis", "cval", "down", "h", "mode", "up", "x", "y" ] }