MCPcopy Create free account
hub / github.com/SLiCAP/SLiCAP_python / doZeros

Function doZeros

SLiCAP/SLiCAPshell.py:838–891  ·  view source on GitHub ↗

Returns the zeros of a transfer function. :return: SLiCAP results object of which the following attributes with be set as a result of this instruction: :rtype: SLiCAP.SLiCAPinstruction.instruction object **Return value attributes** - doZeros(<cir

(cir, source='circuit', detector='circuit', lgref='circuit', 
            transfer='gain', convtype=None, pardefs=None, numeric=False, 
            stepdict=None)

Source from the content-addressed store, hash-verified

836 return result
837
838def doZeros(cir, source='circuit', detector='circuit', lgref='circuit',
839 transfer='gain', convtype=None, pardefs=None, numeric=False,
840 stepdict=None):
841 """
842 Returns the zeros of a transfer function.
843
844 :return: SLiCAP results object of which the following attributes with be
845 set as a result of this instruction:
846
847 :rtype: SLiCAP.SLiCAPinstruction.instruction object
848
849 **Return value attributes**
850
851 - doZeros(<circuit>).M: MNA matrix (sympy.Matrix)
852 - doZeros(<circuit>.Iv: Vector with independent variables (sympy.Matrix)
853 - doZeros(<circuit>).Dv: Vector with dependent variables (sympy.Matrix)
854 - doZeros(<circuit>).numer: Numerator of the voltage transfer from V1
855 to V_out (sympy.Expr)
856 - doZeros(<circuit>).zeros: List with solutions of numer=0 for the Laplace
857 variable (ini.laplace) (list with sympy.Expr or floats)
858
859 If parameter stepping is applied, all above attributes are lists of values
860 or expressions for each step.
861
862 Frequencies of zeros are always in radians per seconds. The setting of
863 ini.hz only affects the diplay of tables in the console (listPZ()), on HTML
864 pages (pz2httml()), or in LaTeX and RST reports.
865
866 **Parameters**
867
868 See section `General instruction format`_.
869
870 **Example**
871
872 .. code-block:: python
873
874 import SLiCAP as sl
875 sl.initProject("My First RC Network")
876 # Generate the circuit object from the netlist
877 cir = sl.makeCircuit("myFirstRCnetwork.cir")
878 # Obtain the zeros of the transfer from V1 to V_out:
879 Zeros = sl.doZeros(cir).zeros
880
881 """
882 if transfer == None:
883 print("Warning: Invalid transfer=None has been changed to 'gain'")
884 transfer = 'gain'
885
886 result = _executeInstruction(cir, transfer=transfer, source=source,
887 detector=detector, lgref=lgref,
888 convtype=convtype, datatype='zeros',
889 pardefs=pardefs, numeric=numeric,
890 stepdict=stepdict)
891 return result
892
893def doPZ(cir, source='circuit', detector='circuit', lgref='circuit',
894 transfer='gain', convtype=None, pardefs=None, numeric=False,

Callers

nothing calls this directly

Calls 1

_executeInstructionFunction · 0.85

Tested by

no test coverage detected