{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Changing the value of properties that are not part of the " }, { "__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": " system representation (such as the " }, { "__type": "InlineRole", "__tag": 4003, "value": "A", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "B", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "C", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "D", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " state-space matrices) is very inefficient and may lead to numerical inaccuracies. It is better to convert to the specific system representation first. For example, call " }, { "__type": "InlineCode", "__tag": 4051, "value": "sys = sys.to_ss()" }, { "__type": "Text", "__tag": 4046, "value": " before accessing/changing the A, B, C, D system matrices." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If (numerator, denominator) is passed in for " }, { "__type": "InlineCode", "__tag": 4051, "value": "*system" }, { "__type": "Text", "__tag": 4046, "value": ", coefficients for both the numerator and denominator should be specified in descending exponent order (e.g. " }, { "__type": "InlineCode", "__tag": 4051, "value": "s^2 + 3s + 5" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineCode", "__tag": 4051, "value": "z^2 + 3z + 5" }, { "__type": "Text", "__tag": 4046, "value": " would be represented as " }, { "__type": "InlineCode", "__tag": 4051, "value": "[1, 3, 5]" }, { "__type": "Text", "__tag": 4046, "value": ")" } ] } ], "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": [], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Linear Time Invariant system class in transfer function form." } ] } ], "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": "arguments", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The " }, { "__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": " class can be instantiated with 1 or 2 arguments. The following gives the number of input arguments and their interpretation:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "1: " }, { "__type": "CrossRef", "__tag": 4002, "value": "lti", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:lti" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__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": " system: (" }, { "__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": "CrossRef", "__tag": 4002, "value": "TransferFunction", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:TransferFunction" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__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": "Text", "__tag": 4046, "value": "2: array_like: (numerator, denominator)" } ] } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "dt", "annotation": "float, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Sampling time [s] of the discrete-time systems. Defaults to " }, { "__type": "CrossRef", "__tag": 4002, "value": "None", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "builtins", "version": "?", "kind": "module", "path": "builtins:None" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " (continuous-time). Must be specified as a keyword argument, for example, " }, { "__type": "InlineCode", "__tag": 4051, "value": "dt=0.1" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Represents the system as the continuous-time transfer function " }, { "__type": "InlineMath", "__tag": 4057, "value": "H(s)=\\sum_{i=0}^N b[N-i] s^i / \\sum_{j=0}^M a[M-j] s^j" }, { "__type": "Text", "__tag": 4046, "value": " or the discrete-time transfer function " }, { "__type": "InlineMath", "__tag": 4057, "value": "H(z)=\\sum_{i=0}^N b[N-i] z^i / \\sum_{j=0}^M a[M-j] z^j" }, { "__type": "Text", "__tag": 4046, "value": ", where " }, { "__type": "InlineMath", "__tag": 4057, "value": "b" }, { "__type": "Text", "__tag": 4046, "value": " are elements of the numerator " }, { "__type": "InlineRole", "__tag": 4003, "value": "num", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineMath", "__tag": 4057, "value": "a" }, { "__type": "Text", "__tag": 4046, "value": " are elements of the denominator " }, { "__type": "InlineRole", "__tag": 4003, "value": "den", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", and " }, { "__type": "InlineCode", "__tag": 4051, "value": "N == len(b) - 1" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineCode", "__tag": 4051, "value": "M == len(a) - 1" }, { "__type": "Text", "__tag": 4046, "value": ". " }, { "__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": " systems inherit additional functionality from the " }, { "__type": "CrossRef", "__tag": 4002, "value": "lti", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:lti" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", respectively the " }, { "__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": " classes, depending on which system representation is used." } ] } ], "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": 733, "item_type": "class", "aliases": [ "scipy.signal.TransferFunction" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "Construct the transfer function\n:math:`H(s) = \\frac{s^2 + 3s + 3}{s^2 + 2s + 1}`:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "from scipy import signal\n", "execution_status": "success", "out": "" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "num = [1, 3, 3]\nden = [1, 2, 1]\n", "execution_status": "success", "out": "" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.TransferFunction(num, den)\n", "execution_status": "success", "out": "TransferFunctionContinuous(\narray([1., 3., 3.]),\narray([1., 2., 1.]),\ndt: None\n)\n" }, { "__type": "Text", "__tag": 4046, "value": "\nConstruct the transfer function\n:math:`H(z) = \\frac{z^2 + 3z + 3}{z^2 + 2z + 1}` with a sampling time of\n0.1 seconds:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "signal.TransferFunction(num, den, dt=0.1)\n", "execution_status": "success", "out": "TransferFunctionDiscrete(\narray([1., 3., 3.]),\narray([1., 2., 1.]),\ndt: 0.1\n)\n" } ], "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": "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": "dlti", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:dlti" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "lti", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._ltisys:lti" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "tf2sos", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._filter_design:tf2sos" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "tf2ss", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._lti_conversion:tf2ss" }, "kind": "module" }, "descriptions": [], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "tf2zpk", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.signal._filter_design:tf2zpk" }, "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": "VAR_POSITIONAL", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "dt", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "TransferFunction" }, "references": null, "qa": "scipy.signal._ltisys:TransferFunction", "arbitrary": [], "local_refs": [ "*system", "dt" ] }