Function doPoles

SLiCAP/SLiCAPshell.py:785–836

Returns the poles 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** - doPoles(<cir

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

    return result

def doPoles(cir, source='circuit', detector='circuit', lgref='circuit', 
            transfer='gain', convtype=None, pardefs=None, numeric=False, 
            stepdict=None):
    """
    Returns the poles 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**
    
    - doPoles(<circuit>).M: MNA matrix (sympy.Matrix)
    - doPoles(<circuit>).Dv: Vector with dependent variables (sympy.Matrix)
    - doPoles(<circuit>).denom: Denominator of the voltage transfer from V1
      to V_out (sympy.Expr)
    - doPoles(<circuit>).poles: List with solutions of denom=0 for the Laplace 
      variable (ini.laplace) (list with sympy.Expr or floats)
      
    If parameter stepping is applied, all above attributes are lists of values
    or expressions for each step.
    
    Frequencies of poles are always in radians per seconds. The setting of 
    ini.hz only affects the diplay of tables in the console (listPZ()), on HTML
    pages (pz2httml()), or in LaTeX and RST reports.
      
    **Parameters**
    
    See section `General instruction format`_.
    
    **Example**
    
    .. code-block:: python
        
        import SLiCAP as sl
        sl.initProject("My First RC Network")
        # Generate the circuit object from the netlist
        cir = sl.makeCircuit("myFirstRCnetwork.cir")
        # Obtain the poles of the transfer from V1 to V_out:
        Poles = sl.doPoles(cir).poles
    
    """
    if transfer == None:
        print("Warning: Invalid transfer=None has been changed to 'gain'")
        transfer = 'gain'
        
    result = _executeInstruction(cir, transfer=transfer, lgref=lgref, 
                                 convtype=convtype, datatype='poles', 
                                 pardefs=pardefs, numeric=numeric, 
                                 stepdict=stepdict)
    return result

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