Skip to main content

Crate opentimstdf

Crate opentimstdf 

Source
Expand description

OpenTimsTDF - Rust reader for timsTOF .d/ (TDF) mass spectrometry bundles.

The format and codecs are documented in the repository under docs/docs/format/, published at https://sigilweaver.app/opentimstdf/docs/. Both compression codecs are supported:

  • Codec 2 (TimsCompressionType == 2) - byte-transposed delta-TOF over zstd. Used by modern acquisitions.
  • Codec 1 (TimsCompressionType == 1) - per-scan LZF blobs with a signed-int32 delta stream. Used by older acquisitions (e.g. PXD022216).

Re-exports§

pub use calibration::BundleCalibration;
pub use calibration::Calibration;
pub use calibration::MobilityConversion;
pub use calibration::MzCalibrationModel;
pub use calibration::MzCalibrationStatus;
pub use calibration::MzConversion;
pub use calibration::TablesMzModel;
pub use codec::checked_block_len;
pub use codec::decode_codec1;
pub use codec::decode_codec2;
pub use error::Error;
pub use error::Result;
pub use error::SqliteError;
pub use reader::Reader;
pub use types::DiaFrameWindows;
pub use types::DiaWindow;
pub use types::Frame;
pub use types::Metadata;
pub use types::PasefMsMsInfo;
pub use types::Peak;
pub use types::Precursor;
pub use types::PrmMsMsInfo;
pub use types::PrmTarget;

Modules§

calibration
TOF index <-> m/z and scan index <-> 1/K0 conversion.
codec
error
mzml
mzML export for Bruker timsTOF .d/ (TDF) bundles.
reader
types
Plain data types read from a bundle.