skultrafast.zero_finding
========================

.. py:module:: skultrafast.zero_finding

.. autoapi-nested-parse::

   Contains functions to find the time-zero and to interpolate the data.



Classes
-------

.. autoapisummary::

   skultrafast.zero_finding.est


Functions
---------

.. autoapisummary::

   skultrafast.zero_finding.use_gaussian
   skultrafast.zero_finding.use_diff
   skultrafast.zero_finding.use_sv_filter
   skultrafast.zero_finding.use_max
   skultrafast.zero_finding.use_first_abs
   skultrafast.zero_finding.use_fit
   skultrafast.zero_finding._fit_func
   skultrafast.zero_finding.robust_fit_tz
   skultrafast.zero_finding.interpol
   skultrafast.zero_finding.get_tz_cor


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

.. py:class:: est

   Bases: :py:obj:`object`


.. py:function:: use_gaussian(dat, sigma=1)

   Use convolution with the derivate of an gaussian.


.. py:function:: use_diff(dat, smooth=0)

   Use numerical diff.


.. py:function:: use_sv_filter(dat, window=7, polydeg=5)

   Use savitzky-golay derivate.


.. py:function:: use_max(dat, use_abs=True)

   Uses the absolute maximum of the signal


.. py:function:: use_first_abs(dat, val=5)

   Returns the first index where abs(dat)>val.


.. py:function:: use_fit(dat, t, tau=[5, 20000], w0=0.08, tn=None, n=-1)

   Fits each transient with only w and x0 free.


.. py:function:: _fit_func(t, y, x0, w, tau)

   Fit


.. py:function:: robust_fit_tz(wl, tn, degree=3, t=1)

   Apply a robust 3-degree fit to given tn-indexs.


.. py:function:: interpol(tup, tn, shift=0.0, new_t=None)

   Uses linear interpolation to shift each channcel by given tn.


.. py:function:: get_tz_cor(tup, method=use_diff, deg=3, plot=False, **kwargs)

   Fully automatic timezero correction.