Skip to main content

Crate openreadout_quant

Crate openreadout_quant 

Source
Expand description

Quantitation primitives for chromatography and mass spectrometry.

  • extract: chromatograms from any reader — total-ion (TIC), base-peak (BPC), extracted-ion (XIC/EIC) and SRM/MRM transition chromatograms streamed from mass spectra, stored chromatograms and detector signals (traces), and MRM tables.
  • peaks: peak detection (Savitzky–Golay smoothing, robust noise, S/N threshold) and integration (drop-line, valley-to-valley or tangent-skim baselines; trapezoidal areas; widths, USP tailing, asymmetry, plates, resolution), retention-time targeting and area-percent reports.
  • bands: bands and regions of spectra (any non-time axis: wavenumber, wavelength, Raman shift, ppm): band picking and region areas with linear or no baseline.
  • targets: compound lists (name, m/z or transition, expected retention time and window) turned into one result row per compound.

The method, its parameters and its validation against pyOpenMS, SciPy and vendor integration results are documented in book/src/guides/quantitation.md.

Modules§

analyze
analyze peaks: chromatograms → peak tables, targeted picks, manual integrations and compound results, as flat rows.
api
JSON queries for analyze chromatogram and analyze peaks, shared by the MCP tool (openreadout_chromatogram and openreadout_peaks) and the Python bindings: the same field names and defaults everywhere.
bands
Bands and regions of spectra: peak picking and integration on any trace whose axis is not time — IR/Raman wavenumber or Raman shift, UV-Vis wavelength, NMR chemical shift, m/z of a profile spectrum, interferogram points.
dataset
Extracted chromatograms as a Dataset with one table, so that the existing CSV, Parquet and Arrow writers (with their read-back verification) export them unchanged.
extract
Chromatograms from any reader: total-ion (TIC), base-peak (BPC), extracted-ion (XIC) and SRM/MRM transition chromatograms computed from mass spectra in one streaming pass, and stored chromatograms or detector signals read from traces and tables.
peaks
Chromatographic peak detection and integration on one chromatogram (t, y).
plot
Pictures of chromatograms, optionally with their integrated peaks shaded, baselines drawn and peaks numbered at their apex: the picture a chromatographer checks an integration against. Drawn with the figure engine; deterministic: the same input gives the same bytes.
rows
Flat result rows (peak rows, compound rows, …) as CSV, TSV or JSON Lines text. Columns are the union of the rows’ keys in first-seen order; nested values are written as JSON.
smooth
Signal conditioning for peak detection: Savitzky–Golay smoothing, a robust noise estimate and a running low-quantile baseline. Everything is deterministic (fixed summation order, no threads) so the same input gives the same peaks on every machine.
targets
Compound lists for targeted quantitation: one row per compound with how to extract its chromatogram (an m/z, an SRM transition, a detector trace or the default chromatogram) and where to expect it (retention time ± window). Read from CSV/TSV (header row) or JSON (an array of objects, or {"compounds": [...]}).