skultrafast.quickcontrol
========================

.. py:module:: skultrafast.quickcontrol

.. autoapi-nested-parse::

   Module to import and work with files generated by QuickControl from phasetech.



Classes
-------

.. autoapisummary::

   skultrafast.quickcontrol.QCFile
   skultrafast.quickcontrol.QCBaseTimeRes
   skultrafast.quickcontrol.QC1DSpec
   skultrafast.quickcontrol.QC2DSpec


Functions
---------

.. autoapisummary::

   skultrafast.quickcontrol.parse_str


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

.. py:function:: parse_str(s: str)

   Parse entry of info file

   :param s: Value
   :type s: str

   :returns: Corresponding python type
   :rtype: obj


.. py:class:: QCFile

   Base class for QC files.


   .. py:attribute:: fname
      :type:  os.PathLike

      Full path to info file


   .. py:property:: path
      :type: pathlib.Path


      Path to the directory containing the file


   .. py:property:: prefix
      :type: str


      Prefix of the file


   .. py:property:: info
      :type: dict[str, Any]



.. py:class:: QCBaseTimeRes

   Bases: :py:obj:`QCFile`


   Base class for QC files.


   .. py:property:: wavelength

      Wavelength data calculated from given grating and mono wavelength


   .. py:property:: wavenumbers


.. py:class:: QC1DSpec

   Bases: :py:obj:`QCBaseTimeRes`


   Helper class to load time resolved spectra measured with QuickControl


   .. py:property:: par_data
      :type: numpy.ndarray



   .. py:property:: per_data
      :type: numpy.ndarray



   .. py:property:: t
      :type: list[float]



   .. py:method:: make_pol_ds(sigma=None) -> skultrafast.dataset.PolTRSpec


.. py:class:: QC2DSpec

   Bases: :py:obj:`QCBaseTimeRes`


   Helper class to load 2D-spectra measured with QuickControl


   .. py:attribute:: par_data
      :type:  Dict

      Data for parallel polarization


   .. py:attribute:: per_data
      :type:  Dict

      Data for perpendicular polarization


   .. py:attribute:: par_spec
      :type:  Optional[Dict]
      :value: None


      Resulting 2D spectra for parallel polarization


   .. py:attribute:: per_spec
      :type:  Optional[Dict]
      :value: None


      Resulting 2D spectra for perpendicular polarization


   .. py:attribute:: probe_filter
      :type:  Optional[float]
      :value: None


      Size of the filter applied to the spectral axis. 'None' is no filtering


   .. py:attribute:: upsampling
      :type:  int
      :value: 2


      Upsamling factor of the pump-axis


   .. py:attribute:: pump_freq
      :type:  numpy.ndarray

      Resulting wavenumbers of the pump axis.


   .. py:attribute:: bg_correct
      :type:  Optional[Tuple]
      :value: None


      If given, the size of the left and right region used to calculate the signal background which
      will be subtracted


   .. py:attribute:: win_function
      :type:  Optional[Callable]

      Window function used for apodization. The coded will the window-function with
      `2*len(t2)` and uses only the second half of the returned array.


   .. py:property:: t
      :type: numpy.ndarray


      Waiting time delays in ps


   .. py:property:: t2
      :type: numpy.ndarray


      Interferogram delays in ps, e.g. the inter pump delay


   .. py:method:: _loader(which: str)


   .. py:method:: __attrs_post_init__()


   .. py:method:: switch_pol()


   .. py:method:: calc_spec()


   .. py:method:: _calc_freqs()


   .. py:method:: make_ds() -> Dict[str, skultrafast.twoD_dataset.TwoDim]