Method setDetector

SLiCAP/SLiCAPinstruction.py:1246–1291

Defines the signal detector :param detector: Name(s) of one or two nodal voltages or of one or two dependent currents. :type detector: list, str detector can defined as: - None: no detector has been defined - str: a single

(self, detector)

        return

    def setDetector(self, detector):
        """
        Defines the signal detector

        :param detector: Name(s) of one or two nodal voltages or of one or two
                         dependent currents.
        :type detector: list, str

        detector can defined as:

        - None: no detector has been defined
        - str:  a single detector, name of a nodal voltage or a branch current
        - list: with names of either two nodal voltages or two branch currents.

        instruction.checkDetector converts the detector definition into a list
        with a positive and a negative detector [<detP>, <detN>], where detP
        and detN are the names (str) of either two nodal voltages or two branch
        currents. One of those can be 'None'.

        A list with names of dependent variables that can be used as signal
        detector is returned by the method: **instruction.depVars()**.

        :Example:

        >>> # create an instance if a SLiCAP instruction
        >>> my_instr = instruction()
        >>> # create my_instr.circuit from the netlist 'myFirstRCnetwork.cir'
        >>> my_instr.setCircuit('myFirstRCnetwork.cir')
        >>> # Display a list with names of nodal voltages and branch currents
        >>> # that can be assigned to the detector.
        >>> my_instr.depVars()
        ['I_V1', 'V_0', 'V_N001', 'V_out']
        >>> # Voltage at node 'out':
        >>> my_instr.setDetector('V_out')
        >>> # Differential voltage between node 'N001' and 'out':
        >>> my_instr.setDetector(['V_N001', 'V_out'])
        >>> # Current through `V1':
        >>> my_instr.setDetector('I_V1')

        :note:

        The voltage 'V_0' at the reference node '0' equals zero.
        """
        self.detector = detector
        self.checkDetector()
        return

    def checkDetector(self):
        """