skultrafast.referencing

Module Contents

Functions

get_stats(→ numpy.ndarray)

get_scans(→ dict[str, list[numpy.ndarray]])

get_ref_stats(→ list[numpy.ndarray])

get_all_scans(→ numpy.ndarray)

build_basis(all_scans)

use_edge_ref(probe_wn, all_scan, low, high[, ref_scans])

This function takes the whole 2D dataset and applies edge referencing to it.

use_edge_ref_full(all_scan, probe_wn, low, high, ...)

This function takes the whole 2D dataset and applies edge referencing to it.
skultrafast.referencing.get_stats(grp: h5py.Group) → numpy.ndarray[source]
skultrafast.referencing.get_scans(f: h5py.File) → dict[str, list[numpy.ndarray]][source]
skultrafast.referencing.get_ref_stats(f: h5py.File) → list[numpy.ndarray][source]
skultrafast.referencing.get_all_scans(f: h5py.File, filter_val=0.8) → numpy.ndarray[source]
skultrafast.referencing.build_basis(all_scans)[source]
skultrafast.referencing.use_edge_ref(probe_wn, all_scan, low, high, ref_scans=2)[source]

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.

skultrafast.referencing.use_edge_ref_full(all_scan, probe_wn, low, high, add_higher_degree)[source]

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.

Parameters:

  • all_scan (np.ndarray) – The 2D dataset.

  • probe_wn (np.ndarray) – The wavenumbers of the dataset.

  • low (float) – The lower bound of the wavenumber range to exclude.

  • high (float) – The upper bound of the wavenumber range to exclude.

  • add_higher_degree (bool) – Whether to add higher degree polynomials to the referencing.