{ "__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": "ss2tf", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._lti_conversion:ss2tf" }, "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": "num", "annotation": "2-D ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Numerator(s) of the resulting transfer function(s). " }, { "__type": "CrossRef", "__tag": 4002, "value": "num", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "num" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " has one row for each of the system's outputs. Each row is a sequence representation of the numerator polynomial." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "den", "annotation": "1-D ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Denominator of the resulting transfer function(s). " }, { "__type": "CrossRef", "__tag": 4002, "value": "den", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "den" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " is a sequence representation of the denominator polynomial." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "State-space to transfer function." } ] } ], "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": "A", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "State (or system) matrix of shape " }, { "__type": "InlineCode", "__tag": 4051, "value": "(n, n)" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "B", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input matrix of shape " }, { "__type": "InlineCode", "__tag": 4051, "value": "(n, p)" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "C", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Output matrix of shape " }, { "__type": "InlineCode", "__tag": 4051, "value": "(q, n)" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "D", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Feedthrough (or feedforward) matrix of shape " }, { "__type": "InlineCode", "__tag": 4051, "value": "(q, p)" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "input", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For multiple-input systems, the index of the input to use." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A, B, C, D defines a linear state-space system with " }, { "__type": "InlineRole", "__tag": 4003, "value": "p", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " inputs, " }, { "__type": "InlineRole", "__tag": 4003, "value": "q", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " outputs, and " }, { "__type": "InlineRole", "__tag": 4003, "value": "n", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " state variables." } ] } ], "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/_lti_conversion.py", "item_line": 217, "item_type": "function", "aliases": [ "scipy.signal.ss2tf" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "Convert the state-space representation:\n\n.. math::\n\n \\dot{\\textbf{x}}(t) =\n \\begin{bmatrix} -2 & -1 \\\\ 1 & 0 \\end{bmatrix} \\textbf{x}(t) +\n \\begin{bmatrix} 1 \\\\ 0 \\end{bmatrix} \\textbf{u}(t) \\\\\n\n \\textbf{y}(t) = \\begin{bmatrix} 1 & 2 \\end{bmatrix} \\textbf{x}(t) +\n \\begin{bmatrix} 1 \\end{bmatrix} \\textbf{u}(t)\n\n" }, { "__type": "Code", "__tag": 4050, "value": "A = [[-2, -1], [1, 0]]\nB = [[1], [0]] # 2-D column vector\nC = [[1, 2]] # 2-D row vector\nD = 1\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nto the transfer function:\n\n.. math:: H(s) = \\frac{s^2 + 3s + 3}{s^2 + 2s + 1}\n\n" }, { "__type": "Code", "__tag": 4050, "value": "from scipy.signal import ss2tf\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "ss2tf(A, B, C, D)\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "A", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "B", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "C", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "D", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "input", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "ss2tf" }, "references": null, "qa": "scipy.signal._lti_conversion:ss2tf", "arbitrary": [], "local_refs": [ "A", "B", "C", "D", "den", "input", "num" ] }