timsrust_core/lib.rs
1//! This crate allows to read Bruker TimsTOF data.
2//!
3//! ## Basics
4//!
5//! Two primary data types are exposed:
6//!
7//! * [Spectra](crate::ms_data::Spectrum): A traditional representation that expresses intensitites in function of mz values for a given precursor.
8//! * [Frames](crate::ms_data::Frame): All recorded data from a single TIMS elution (i.e. at one specific retention_time).
9//!
10//! ## File formats
11//!
12//! Two file formats are supported:
13//!
14//! * Bruker .d folder containing:
15//! * analysis.tdf
16//! * analysis.tdf_bin
17//! * miniTDF - ProteoScape optimized Bruker file-format. Similar to TDF, miniTDF consists of multiple files: a binary '.bin'
18//! and an index '.parquet' file. The file-names are made up to the following convention: `<producing-engine-name>.<domain-name>.<extension>`.
19//! e.g. for MS2 spectrum information: `<producing-engine-name>.ms2spectrum.<extension>`. Therefore the following files are expected
20//! in the provided ms2 folder:
21//! * *.ms2spectrum.bin
22//! * *.ms2spectrum.parquet
23
24mod acquisition;
25mod coordinates;
26#[allow(hidden_glob_reexports)]
27mod error;
28mod frames;
29// mod ions;
30mod precursors;
31mod quadrupole;
32// mod query;
33// pub mod prelude;
34mod spectra;
35
36pub use acquisition::*;
37pub use coordinates::*;
38pub use error::*;
39pub use frames::*;
40pub use precursors::*;
41pub use quadrupole::*;
42pub use spectra::*;
43
44pub use timsrust_utils as utils;
45
46#[cfg(feature = "io")]
47pub use filemanager as io;