{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This function is a convenience wrapper around " }, { "__type": "CrossRef", "__tag": 4002, "value": "dfreqresp", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:dfreqresp" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " for extracting magnitude and phase from the calculated complex-valued amplitude of the frequency response." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 0.18.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": "dbode", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:dbode" }, "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": "w", "annotation": "1D ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Array of frequencies normalized to the Nyquist frequency being " }, { "__type": "InlineCode", "__tag": 4051, "value": "np.pi/dt" }, { "__type": "Text", "__tag": 4046, "value": " with " }, { "__type": "InlineCode", "__tag": 4051, "value": "dt" }, { "__type": "Text", "__tag": 4046, "value": " being the sampling interval of the " }, { "__type": "ParamRef", "__tag": 4071, "name": "system" }, { "__type": "Text", "__tag": 4046, "value": " parameter. The unit is rad/s assuming " }, { "__type": "InlineCode", "__tag": 4051, "value": "dt" }, { "__type": "Text", "__tag": 4046, "value": " is in seconds." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "mag", "annotation": "1D ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Magnitude array in dB" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "phase", "annotation": "1D ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Phase array in degrees" } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Calculate Bode magnitude and phase data of a discrete-time system." } ] } ], "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": "system", "annotation": "dlti | tuple", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "An instance of the LTI class " }, { "__type": "CrossRef", "__tag": 4002, "value": "dlti", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:dlti" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " or a tuple describing the system. The number of elements in the tuple determine the interpretation. I.e.:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "system" }, { "__type": "Text", "__tag": 4046, "value": ": Instance of LTI class " }, { "__type": "CrossRef", "__tag": 4002, "value": "dlti", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:dlti" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ". Note that derived instances, such as instances of " }, { "__type": "CrossRef", "__tag": 4002, "value": "TransferFunction", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:TransferFunction" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "CrossRef", "__tag": 4002, "value": "ZerosPolesGain", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:ZerosPolesGain" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", or " }, { "__type": "CrossRef", "__tag": 4002, "value": "StateSpace", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:StateSpace" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", are allowed as well." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "(num, den, dt)" }, { "__type": "Text", "__tag": 4046, "value": ": Rational polynomial as described in " }, { "__type": "CrossRef", "__tag": 4002, "value": "TransferFunction", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:TransferFunction" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ". The coefficients of the polynomials should be specified in descending exponent order, e.g., z² + 3z + 5 would be represented as " }, { "__type": "InlineCode", "__tag": 4051, "value": "[1, 3, 5]" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "(zeros, poles, gain, dt)" }, { "__type": "Text", "__tag": 4046, "value": ": Zeros, poles, gain form as described in " }, { "__type": "CrossRef", "__tag": 4002, "value": "ZerosPolesGain", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:ZerosPolesGain" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "(A, B, C, D, dt)" }, { "__type": "Text", "__tag": 4046, "value": ": State-space form as described in " }, { "__type": "CrossRef", "__tag": 4002, "value": "StateSpace", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:StateSpace" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "w", "annotation": "array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Array of frequencies normalized to the Nyquist frequency being π, i.e., having unit radiant / sample. Magnitude and phase data is calculated for every value in this array. If not given, a reasonable set will be calculated." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "n", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of frequency points to compute if " }, { "__type": "ParamRef", "__tag": 4071, "name": "w" }, { "__type": "Text", "__tag": 4046, "value": " is not given. The " }, { "__type": "ParamRef", "__tag": 4071, "name": "n" }, { "__type": "Text", "__tag": 4046, "value": " frequencies are logarithmically spaced in an interval chosen to include the influence of the poles and zeros of the system." } ] } ] } ] } ], "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/_ltisys.py", "item_line": 3455, "item_type": "function", "aliases": [ "scipy.signal.dbode" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "The following example shows how to create a Bode plot of a 5-th order\nButterworth lowpass filter with a corner frequency of 100 Hz:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import matplotlib.pyplot as plt\nimport numpy as np\nfrom scipy import signal\nT = 1e-4 # sampling interval in s\nf_c, o = 1e2, 5 # corner frequency in Hz (i.e., -3 dB value) and filter order\nbb, aa = signal.butter(o, f_c, 'lowpass', fs=1/T)\nw, mag, phase = signal.dbode((bb, aa, T))\nw /= 2*np.pi # convert unit of frequency into Hertz\nfg, (ax0, ax1) = plt.subplots(2, 1, sharex='all', figsize=(5, 4),\n tight_layout=True)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "ax0.set_title(\"Bode Plot of Butterworth Lowpass Filter \" +\n rf\"($f_c={f_c:g}\\,$Hz, order={o})\")\nax0.set_ylabel(r\"Magnitude in dB\")\nax1.set(ylabel=r\"Phase in Degrees\",\n xlabel=\"Frequency $f$ in Hertz\", xlim=(w[1], w[-1]))\nax0.semilogx(w, mag, 'C0-', label=r\"$20\\,\\log_{10}|G(f)|$\") # Magnitude plot\nax1.semilogx(w, phase, 'C1-', label=r\"$\\angle G(f)$\") # Phase plot\nfor ax_ in (ax0, ax1):\n ax_.axvline(f_c, color='m', alpha=0.25, label=rf\"${f_c=:g}\\,$Hz\")\n ax_.grid(which='both', axis='x') # plot major & minor vertical grid lines\n ax_.grid(which='major', axis='y')\n ax_.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-6b2a44c30d2e911f.png" } } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "StateSpace", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:StateSpace" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "TransferFunction", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:TransferFunction" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "ZerosPolesGain", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:ZerosPolesGain" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "dfreqresp", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:dfreqresp" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "dlti", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:dlti" }, "kind": "module" }, "descriptions": [], "type": "func" } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "system", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "w", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "n", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "100" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "dbode" }, "references": null, "qa": "scipy.signal._ltisys:dbode", "arbitrary": [], "local_refs": [ "mag", "n", "phase", "system", "w" ] }