skultrafast.referencing
=======================

.. py:module:: skultrafast.referencing


Functions
---------

.. autoapisummary::

   skultrafast.referencing.get_stats
   skultrafast.referencing.get_scans
   skultrafast.referencing.get_ref_stats
   skultrafast.referencing.get_all_scans
   skultrafast.referencing.build_basis
   skultrafast.referencing.use_edge_ref
   skultrafast.referencing.use_edge_ref_full


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

.. py:function:: get_stats(grp: h5py.Group) -> numpy.ndarray

.. py:function:: get_scans(f: h5py.File) -> dict[str, list[numpy.ndarray]]

.. py:function:: get_ref_stats(f: h5py.File) -> list[numpy.ndarray]

.. py:function:: get_all_scans(f: h5py.File, filter_val=0.8) -> numpy.ndarray

.. py:function:: build_basis(all_scans)

.. py:function:: use_edge_ref(probe_wn, all_scan, low, high, ref_scans=2)

   This function takes the whole 2D dataset and applies edge referencing to it.
   After referencing, the 2D-signal is calculated and returned along with the
   corresponding wavenumbers.

   Assumes 4 phase cycling steps.


.. py:function:: use_edge_ref_full(all_scan, probe_wn, low, high, add_higher_degree)

   This function takes the whole 2D dataset and applies edge referencing to it.
   After referencing, the 2D-signal is calculated and returned along with the
   corresponding wavenumbers. Assumes 4 phase cycling steps.


   :param all_scan: The 2D dataset.
   :type all_scan: np.ndarray
   :param probe_wn: The wavenumbers of the dataset.
   :type probe_wn: np.ndarray
   :param low: The lower bound of the wavenumber range to exclude.
   :type low: float
   :param high: The upper bound of the wavenumber range to exclude.
   :type high: float
   :param add_higher_degree: Whether to add higher degree polynomials to the referencing.
   :type add_higher_degree: bool