Functions¶
This is the official documentation for the DeerLab toolbox functions. The following list contains the names of the different function and a brief description of their functionality. The parametric model functions are listed in separate sections.
Modeling¶
This class of functions allows simulation of dipolar signals and their modeling for fitting experimental data.
| Function | Description |
|---|---|
| dipolarkernel | Dipolar kernel constructor |
| dipolarbackground | Multi-pathway background constructor |
| dipolarsignal | Dipolar signal simulator |
| whitegaussnoise | Gaussian white noise generator |
| paramodel | Parametric model builder |
| mixmodels | Parametric model mixer |
Analysis¶
This class of functions can be used and/or combined to create fitting routines of dipolar data.
| Function | Description |
|---|---|
| fitsignal | Full model signal fitting engine |
| bootan | Bootstrap uncertainty analysis |
| fitmultimodel | Multi-component model fitting engine |
| fitparamodel | Parametric model fitting engine |
| fitregmodel | Regularization fitting engine |
| obir | Osher-Bregman iterative regularization |
| regoperator | Regularization operator constructor |
Pre-Processing¶
This class of functions provide tools for preparing experimental data for analysis.
| Function | Description |
|---|---|
| correctphase | IQ Phase correction |
| correctzerotime | Dipolar zero-time correction |
| longpass | Longpass filtering |
| winlowpass | Windowed-lowpass filtering |
Model Selection¶
This class of functions helps to find an optimal choice of model or model parameters.
| Function | Description |
|---|---|
| selectmodel | Parametric model selector |
| selregparam | Regularization parameter selector |
| regparamrange | Regularization parameter range selector |
Utilities¶
This class of functions provides several tools for quick commands typically required in data processing.
| Function | Description |
|---|---|
| deerload | Spectrometer data loader |
| time2freq | Time to frequency axis converter |
| noiselevel | Noise level estimator |
| fftspec | Fast-Fourier transform spectrum |
Legacy Functions¶
This group of functions provides tools for reproducing analysis methods or workflows encountered in older software, particularly DeerAnalysis. These functions are not recommended for routine data analysis.
| Function | Description |
|---|---|
| time2dist | Heuristic time-to-distance axis converter |
| correctscale | Dipolar signal amplitude rescaling |
| backgroundstart | Background fit start point optimizer |
| fitbackground | Background fitting engine |
| apt | Approximate Pake transformation (APT) |
| aptkernel | APT kernel constructor |