skultrafast.single_spectrum
===========================

.. py:module:: skultrafast.single_spectrum


Classes
-------

.. autoapisummary::

   skultrafast.single_spectrum.SingleSpec
   skultrafast.single_spectrum.SingleSpecPlotter


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

.. py:class:: SingleSpec(frequency, signal, unit_freq='nm', unit_signal='OD')

   .. py:attribute:: x


   .. py:attribute:: y


   .. py:attribute:: unit_freq
      :value: 'nm'



   .. py:attribute:: unit_signal
      :value: 'OD'



   .. py:attribute:: back


   .. py:attribute:: fi


   .. py:attribute:: plot


   .. py:method:: subtract_const(region: tuple)

      Subtracts a constant background. The background is calculated by
      taking the mean signal in the designated region.

      :param region: The borders of the region.
      :type region: tuple of two floats



   .. py:method:: cut(region, invert_sel=True)

      Cuts part of the spectrum away.

      :param region: Defines the region to be cutted away.
      :type region: tuple of floats
      :param invert_sel: If `True`, the cutted region is inverted.
      :type invert_sel: bool

      :returns: Cut spectra.
      :rtype: SingleSpec



   .. py:method:: fit_single_gauss(start_params=None, back_deg=2, peak_region=None)


.. py:class:: SingleSpecPlotter(single_spec: SingleSpec)

   .. py:attribute:: ds


   .. py:method:: spec(remove_back=True, ax=None)