Method pz

SLiCAP/SLiCAPlatex.py:305–379

Creates a table or tables with results of pole/zero analysis stored in *resultObject*. If no label AND no caption are given this method returns a LaTeX tabular snippet. Else it returns a table snippet. :param resultObject: SLiCAP circuit object that comprises the ci

(self, resultObject, label="", caption="", color="myyellow")

        return Snippet(TEX, self.format)

    def pz(self, resultObject, label="", caption="", color="myyellow"):
        """
        Creates a table or tables with results of pole/zero analysis stored in *resultObject*.
        If no label AND no caption are given this method returns a LaTeX
        tabular snippet. Else it returns a table snippet.

        :param resultObject: SLiCAP circuit object that comprises the circuit data to be listed.
        :type resultObject: SLiCAP.SLiCAPinstruction.instruction
        
        :param label: Reference label for the table. Defaults to an empty string.
        :type label: str
        
        :param caption: Text that will used as table caption(s).
        :type caption: str
        
        :param color: Alternate row color name, should be defined in 
                     'preambuleSLiCAP.tex' defaults to 'myyellow'. Use None for
                     no background color.
        :type color: str
        
        :return: SLiCAP Snippet object
        :rtype: SLiCAP.SLiCAPprotos.Snippet
        """
        if resultObject.errors != 0:
            print("pz2TEX: Errors found in instruction.")
            TEX = ''
        elif resultObject.dataType != 'poles' and resultObject.dataType != 'zeros' and resultObject.dataType != 'pz':
            print("pz2TEX: Error: 'pz2RST()' expected dataType: 'poles', 'zeros', or 'pz', got: '{0}'.".format(resultObject.dataType))
            TEX = ''
        elif resultObject.step == True :
            print("pz2TEX: Error: parameter stepping not implemented for 'pz2RST()'.")
            TEX = ''
        else:
            TEX = ''
            if len(resultObject.poles) != 0:
                numericPoles = _checkNumeric(resultObject.poles)
            else:
                numericPoles = True
            if len(resultObject.zeros) != 0:
                numericZeros = _checkNumeric(resultObject.zeros)
            else:
                numericZeros = True
            if numericPoles and numericZeros:
                numeric = True
            else:
                numeric = False
            if numeric:
                alignstring = '[c]{lrrrrr}'
                if ini.hz == True:
                    headerList = ['\\#', 'Re [Hz]', 'Im [Hz]', 'f [Hz]', 'Q']
                else:
                    headerList = ['\\#', 'Re [rad/s]', 'Im [rad/s]', '$\\omega$ [rad/s]', 'Q']
            else:
                alignstring = '[c]{ll}'
                if ini.hz == True:
                    headerList = ['\\#', 'f [Hz]']
                else:
                    headerList = ['\\#', '$\\omega$ [rad/s]']