{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__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": "dstep", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:dstep" }, "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": "tout", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Output time points, as a 1-D array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "yout", "annotation": "tuple of ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Step response of system. Each element of the tuple represents the output of the system based on a step response to each input." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Step response of 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": "x0", "annotation": "array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Initial state-vector. Defaults to zero." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "t", "annotation": "array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Time points. Computed if not given." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "n", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The number of time points to compute (if " }, { "__type": "ParamRef", "__tag": 4071, "name": "t" }, { "__type": "Text", "__tag": 4046, "value": " is not given)." } ] } ] } ] } ], "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": 3253, "item_type": "function", "aliases": [ "scipy.signal.dstep" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "The following example illustrates how to create a digital Butterworth filer and\nplot its step response:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy import signal\nimport matplotlib.pyplot as plt\ndt = 1 # sampling interval is one => time unit is sample number\nbb, aa = signal.butter(3, 0.25, fs=1/dt)\nt, y = signal.dstep((bb, aa, dt), n=25)\nfig0, ax0 = plt.subplots()\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "ax0.step(t, np.squeeze(y), '.-', where='post')\nax0.set_title(r\"Step Response of a $3^\\text{rd}$ Order Butterworth Filter\")\nax0.set(xlabel='Sample number', ylabel='Amplitude', ylim=(0, 1.1*np.max(y)))\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "ax0.grid()\nplt.show()\n", "execution_status": "success" }, { "__type": "Figure", "__tag": 4024, "value": { "__type": "RefInfo", "__tag": 4000, "module": "scipy", "version": "1.17.1", "kind": "assets", "path": "fig-3e3ce7998892c84c.png" } } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "cont2discrete", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._lti_conversion:cont2discrete" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "dimpulse", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:dimpulse" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "dlsim", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:dlsim" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "step", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "step" }, "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": "x0", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "t", "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": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "dstep" }, "references": null, "qa": "scipy.signal._ltisys:dstep", "arbitrary": [], "local_refs": [ "n", "system", "t", "tout", "x0", "yout" ] }