openreadout_quant/lib.rs
1//! Quantitation primitives for chromatography and mass spectrometry.
2//!
3//! - [`extract`]: chromatograms from any reader — total-ion (TIC), base-peak (BPC),
4//! extracted-ion (XIC/EIC) and SRM/MRM transition chromatograms streamed from mass spectra,
5//! stored chromatograms and detector signals (traces), and MRM tables.
6//! - [`peaks`]: peak detection (Savitzky–Golay smoothing, robust noise, S/N threshold) and
7//! integration (drop-line, valley-to-valley or tangent-skim baselines; trapezoidal areas;
8//! widths, USP tailing, asymmetry, plates, resolution), retention-time targeting and
9//! area-percent reports.
10//! - [`bands`]: bands and regions of spectra (any non-time axis: wavenumber, wavelength,
11//! Raman shift, ppm): band picking and region areas with linear or no baseline.
12//! - [`targets`]: compound lists (name, m/z or transition, expected retention time and window)
13//! turned into one result row per compound.
14//!
15//! The method, its parameters and its validation against pyOpenMS, SciPy and vendor
16//! integration results are documented in `book/src/guides/quantitation.md`.
17#![forbid(unsafe_code)]
18#![warn(missing_docs)]
19// Signal arithmetic reads best with the conventional short names (t, y, a, b, l, r, …).
20#![allow(clippy::many_single_char_names)]
21// Exact equality of sample times (zero-width steps) and of flat tops is what is meant.
22#![allow(clippy::float_cmp)]
23
24pub mod analyze;
25pub mod api;
26pub mod bands;
27pub mod dataset;
28pub mod extract;
29pub mod peaks;
30pub mod plot;
31pub mod rows;
32pub mod smooth;
33pub mod targets;