sda.rlc.fit_circuit
===================

.. py:module:: sda.rlc.fit_circuit


Classes
-------

.. autoapisummary::

   sda.rlc.fit_circuit.FitCircuit


Module Contents
---------------

.. py:class:: FitCircuit(times, current, V, tau = None, R = None, L = None, C = None)

   .. py:attribute:: times


   .. py:attribute:: current


   .. py:attribute:: V


   .. py:attribute:: tau


   .. py:attribute:: L


   .. py:attribute:: R


   .. py:attribute:: C


   .. py:method:: guess_tau()

      Guess the pulse duration.

      The pulse duration is estimated as the time at which the current reaches its maximum value.

      :returns: The guessed pulse duration.
      :rtype: :py:class:`float`



   .. py:method:: guess_inductance()

      Guess the inductance.

      The inductance is the inverse of the slope of the current at t = 0:
      L = V / (dI/dt) = V / (I(tau) - I(0) / (tau - 0)) = V * tau / I(tau)

      :returns: The guessed inductance.
      :rtype: :py:class:`float`



   .. py:method:: guess_resistance()

      Guess the resistance.

      The resistance is related to the times T the current reaches 0.05 of its maximum value,
      by R = 3 * L / T

      :returns: The guessed resistance.
      :rtype: :py:class:`float`



   .. py:method:: guess_capacitance()

      Guess the capacitance.

      The capacitance is linked to oscillations in current.
      - If the current oscillates, the circuit is underdamped, and the capacitance is small.
      - If the current does not oscillate, the circuit is overdamped, and the capacitance is large.

      :returns: The guessed capacitance.
      :rtype: :py:class:`float`



   .. py:method:: fit_circuit()

      Fit the current across the RLC circuit to a pulsed signal.

      :returns: The resistance, inductance, and capacitance of the RLC circuit.
      :rtype: :py:class:`tuple[float`, :py:class:`float`, :py:class:`float]`