Method dcvarContribs

SLiCAP/SLiCAPlatex.py:436–491

Creates a table with results of dcvar 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

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

        return Snippet(TEX, self.format)

    def dcvarContribs(self, resultObject, label="", caption="", color="myyellow"):
        """
        Creates a table with results of dcvar 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
        """
        TEX = ''
        if resultObject.dataType == 'dcvar' and resultObject.step == False:
            detUnits = resultObject.detUnits + '**2'
            if resultObject.srcUnits != None:
                srcUnits = resultObject.srcUnits + '**2'
            else:
                srcUnits = ""
            # Add a table for source contributions
            linesList = []
            alignstring = '[c]{lll}'
            headerList = ['Name', 'Value' , 'Units']
            linesList = []
            for src in resultObject.ovarTerms.keys():
                if src[0].upper() == 'I':
                    units = 'A**2'
                elif src[0].upper() == 'V':
                    units = 'V**2'
                #units = sp.sympify(units)
                line = [src + ': Value' , resultObject.svarTerms[src], units]
                linesList.append(line)
                if resultObject.srcUnits != None:
                    line = [src + ': Source-referred', 
                            resultObject.ivarTerms[src], srcUnits]
                    linesList.append(line)
                line = [src + ': Detector-referred', 
                        resultObject.ovarTerms[src], detUnits]
                linesList.append(line)
            TEX += _TEXcreateCSVtable(headerList, linesList, alignstring, 
                                      unitpos=2, caption=caption, label=label, 
                                      color=color)
        else:
            print('dcvarContribs2TEX: Error: wrong data type, or stepped analysis.')
        return Snippet(TEX, self.format)

    def specs(self, specs, specType, label="", caption="", color="myyellow"):