twoD_dataset.TwoDim¶

class twoD_dataset.TwoDim(t: ndarray, pump_wn: ndarray, probe_wn: ndarray, spec2d: ndarray, info: Dict = NOTHING, single_cls_result_: SingleCLSResult | None = None, cls_result_: CLSResult | None = None, plot: TwoDimPlotter = NOTHING, interpolator_: RegularGridInterpolator | None = None, fit_exp_result_: ExpFit2DResult | None = None, unit_scaling: float = 1.0)[source]¶

Dataset for an two dimensional dataset. Requires the t- (waiting times),the probe- and pump-axes in addition to the three dimensional spec2d data.

Method generated by attrs for class TwoDim.

__init__(t: ndarray, pump_wn: ndarray, probe_wn: ndarray, spec2d: ndarray, info: Dict = NOTHING, single_cls_result_: SingleCLSResult | None = None, cls_result_: CLSResult | None = None, plot: TwoDimPlotter = NOTHING, interpolator_: RegularGridInterpolator | None = None, fit_exp_result_: ExpFit2DResult | None = None, unit_scaling: float = 1.0) → None¶: Method generated by attrs for class TwoDim.

Methods

`__init__`(t, pump_wn, probe_wn, spec2d[, ...])	Method generated by attrs for class TwoDim.
`apply_filter`(kind, size, *args)
`background_correction`(excluded_range[, deg, ...])	Fits and subtracts a background for each pump-frequency.
`cls`([joblib_kws])	Calculates the CLS for all 2d-spectra.
`copy`()	Makes a copy of the dataset.
`data_at`([t, probe_wn, pump_wn])	Extracts the data at given coordinates.
`diag_and_antidiag`(t[, offset, p])	Extracts the diagonal and anti-diagonal.
`fit_das`(taus[, fix_last_decay])	Fit the data to a sum of exponentials (DAS), starting from the given decay constants.
`fit_gauss`([mode])	Fits the 2D spectra using two gaussians peaks.
`fit_taus`(taus)	Given a set of decay times, fit the data to a sum of the exponentials.
`get_minmax`(t[, com])	Returns the position of the minimum and maximum of the dataset at time t.
`integrate_pump`([lower, upper])	Calculate and return 1D Time-resolved spectra for given range.
`integrate_reg`(pump_range[, probe_range])	Integrates the 2D spectra over a given range, using Simpson's rule.
`load_numpy`(fname)	Loads a dataset from a numpy file.
`probe_idx`(wn)	Return nearest idx to nearest probe_wn value
`pump_idx`(wn)	Return nearest idx to nearest pump_wn value
`pump_slice_amp`(t[, bg_correct])
`save_numpy`(fname)	Saves the dataset as a numpy file.
`save_single_txt`(fname, i, **kwargs)	Save a single 2D spectra as a text file
`save_txt`(pname, **kwargs)	Saves 2d-spectra as a text files a directory.
`select_range`(pump_range, probe_range[, invert])	Return a dataset containing only the selected region.
`select_t_range`([t_min, t_max])
`single_cls`(t[, pr_range, pu_range, mode, method])	Calculate the CLS for single 2D spectrum.
`t_d`(t)	Return the dataset nearest to the given time t
`t_idx`(-> int)	Return nearest idx to nearest time value

Attributes

`t`	Array of the waiting times
`pump_wn`	Array with the pump-wavenumbers
`probe_wn`	Array with the probe-wavenumbers
`spec2d`	Array with the data, shape must be (t.size, wn_probe.size, wn_pump.size)
`info`	Meta Info
`single_cls_result_`	Contains the data from a Single CLS analysis
`cls_result_`	Contains the data from a CLS analysis
`plot`	Plot object offering plotting methods
`interpolator_`	Contains the interpolator for the 2d-spectra
`fit_exp_result_`	Contains the result of the exponential fit
`unit_scaling`	Scaling factor for the units of the dataset