Skip to main content

dnoise_core/
lib.rs

1//! dnoise-core — the in-memory denoising stages of
2//! [dnoise](https://crates.io/crates/dnoise), for Bruker timsTOF frames.
3//!
4//! This crate does no I/O and has no native dependencies. A caller reads frames
5//! and run metadata itself (for example with `timsrust` and SQLite), then:
6//!
7//! 1. builds one [`Denoiser`] per run from [`FrameMeta`] and the parameters,
8//! 2. attaches any per-run state its stages need (see [`pipeline`]),
9//! 3. calls [`Denoiser::process`], [`Denoiser::denoise_ms1`] or
10//!    [`Denoiser::denoise_msms`] per frame, in any order, from any thread
11//!    (`Denoiser` is `Send + Sync`, checked at compile time).
12//!
13//! The `dnoise` crate runs exactly this path for its CLI and writes the
14//! survivors into a new `.d` folder.
15//!
16//! # Example
17//!
18//! ```
19//! use dnoise_core::{Acquisition, Denoiser, FilterParams, FlatFrame, FrameMeta, Stages};
20//!
21//! let meta = vec![FrameMeta { id: 1, num_scans: 700, num_peaks: 8, ms_ms_type: 0, rt: 0.5 }];
22//! let params = FilterParams::default();
23//! let stages = Stages::default();
24//! let denoiser = Denoiser::new(&params, &stages, Acquisition::Ms1Only, meta, false)?;
25//!
26//! // A vertical streak at TOF 1000 across 8 consecutive mobility scans.
27//! let frame = FlatFrame {
28//!     frame_id: 1,
29//!     num_scans: 700,
30//!     scan: (10..18).collect(),
31//!     tof: vec![1000; 8],
32//!     intensity: vec![100; 8],
33//! };
34//! let out = denoiser.process(0, &|_| Ok(frame.clone()), None)?;
35//! assert_eq!(out.survivors.len(), 8); // the streak survives
36//! # Ok::<(), dnoise_core::Error>(())
37//! ```
38//!
39//! The lower-level stages ([`filter::filter_iterated`], [`halo`], the gates,
40//! [`smooth`], [`watershed`], [`box_centroid`]) are public too.
41
42#![warn(missing_docs)]
43
44pub mod average;
45pub mod box_centroid;
46pub mod convert;
47pub mod crop;
48pub mod dia_ms1;
49pub mod dia_window;
50pub mod error;
51pub mod filter;
52pub mod frame;
53pub mod halo;
54pub mod mobility;
55pub mod msms;
56pub mod neighbor;
57pub mod overlap;
58pub mod params;
59pub mod pipeline;
60pub mod polygon;
61pub mod smooth;
62pub mod units;
63pub mod watershed;
64pub mod windows;
65
66pub use error::{Error, Result};
67pub use frame::{CsrFrame, FlatFrame};
68pub use mobility::{MobilityScale, ScanToMobility};
69pub use params::{
70    BoxCentroidParams, CropParams, DdaWindowParams, DiaMs1WindowParams, DiaWindowParams,
71    FilterParams, HaloParams, Ms1PolygonParams, MsmsFilterParams, NeighborParams, SmoothParams,
72    Stages, WatershedParams,
73};
74pub use pipeline::{Acquisition, DecodedFrame, Denoiser};
75pub use windows::{DiaWindows, FrameMeta, PasefWindow};
76
77// Doc-test the README's usage example.
78#[cfg(doctest)]
79#[doc = include_str!("../README.md")]
80struct ReadmeDoctests;
81
82// `Denoiser` is shared across threads by embedders; keep it Send + Sync.
83const _: () = {
84    const fn assert_send_sync<T: Send + Sync>() {}
85    assert_send_sync::<Denoiser<'static>>();
86};