Returns the unit-step response of a transfer (based upon the ILT). The argument 'transfer' will be set to gain if None is given. :return: SLiCAP results object of which the following attributes with be set as a result of this instruction: :rtype: SLiCAP.SLiC
(cir, source='circuit', detector='circuit', lgref='circuit',
transfer='gain', convtype=None, pardefs=None, numeric=False,
stepdict=None)
| 728 | return result |
| 729 | |
| 730 | def doStep(cir, source='circuit', detector='circuit', lgref='circuit', |
| 731 | transfer='gain', convtype=None, pardefs=None, numeric=False, |
| 732 | stepdict=None): |
| 733 | """ |
| 734 | Returns the unit-step response of a transfer (based upon the ILT). The |
| 735 | argument 'transfer' will be set to gain if None is given. |
| 736 | |
| 737 | :return: SLiCAP results object of which the following attributes with be |
| 738 | set as a result of this instruction: |
| 739 | |
| 740 | :rtype: SLiCAP.SLiCAPinstruction.instruction object |
| 741 | |
| 742 | **Return value attributes** |
| 743 | |
| 744 | - doStep(<circuit>).M: MNA matrix (sympy.Matrix) |
| 745 | - doStep(<circuit>.Iv: Vector with independent variables (sympy.Matrix) |
| 746 | - doStep(<circuit>).Dv: Vector with dependent variables (sympy.Matrix) |
| 747 | - doStep(<circuit>).numer: Numerator of the voltage transfer from V1 to |
| 748 | V_out (sympy.Expr) |
| 749 | - doStep(<circuit>).denom: Denominator of the voltage transfer from V1 |
| 750 | to V_out (sympy.Expr) |
| 751 | - doStep(<circuit>).laplace: Voltage transfer from V1 to V_out (sympy.Expr) |
| 752 | - doStep(<circuit>).stepResp: Unit-step response of the Voltage transfer |
| 753 | from V1 to V_out (sympy.Expr) |
| 754 | |
| 755 | If parameter stepping is applied, all above attributes are lists of values |
| 756 | or expressions for each step. |
| 757 | |
| 758 | **Parameters** |
| 759 | |
| 760 | See section `General instruction format`_. |
| 761 | |
| 762 | **Example** |
| 763 | |
| 764 | .. code-block:: python |
| 765 | |
| 766 | import SLiCAP as sl |
| 767 | sl.initProject("My First RC Network") |
| 768 | # Generate the circuit object from the netlist |
| 769 | cir = sl.makeCircuit("myFirstRCnetwork.cir") |
| 770 | # Obtain the unit-step response of the transfer from V1 to V_out: |
| 771 | a_t = sl.doStep(cir).stepResp |
| 772 | |
| 773 | """ |
| 774 | if transfer == None: |
| 775 | print("Warning: Invalid transfer=None has been changed to 'gain'") |
| 776 | transfer = 'gain' |
| 777 | |
| 778 | result = _executeInstruction(cir, transfer=transfer, source=source, |
| 779 | detector=detector, lgref=lgref, |
| 780 | convtype=convtype, datatype='step', |
| 781 | pardefs=pardefs, numeric=numeric, |
| 782 | stepdict=stepdict) |
| 783 | return result |
| 784 | |
| 785 | def doPoles(cir, source='circuit', detector='circuit', lgref='circuit', |
| 786 | transfer='gain', convtype=None, pardefs=None, numeric=False, |
nothing calls this directly
no test coverage detected