Skip to main content

Crate openreadout_sciex

Crate openreadout_sciex 

Source
Expand description

Clean-room reader for legacy Sciex .wiff files with their .wiff.scan companions: the acquisition method (experiments, MRM transitions with their scheduling windows), sample information, the scan index, MRM intensities and TripleTOF time-of-flight scans with the per-scan calibration and data-dependent precursors. .wiff2 files are recognised and refused: they are encrypted (see docs/legal/clean-room-policy.md).

Derived from public MetaboLights data sets compared against the depositors’ own conversions. The .wiff container is read with openreadout-core’s compound-file reader. No vendor library is used, linked or consulted; see docs/provenance/sciex-wiff.md.

Layout and vocabulary: docs/formats/sciex-wiff.md.

§Example

use openreadout_core::FormatReader;
use openreadout_sciex::SciexWiffReader;

let format = SciexWiffReader.descriptor();
assert_eq!(format.id, openreadout_sciex::FORMAT_ID);
println!("{} ({}): .{}", format.name, format.family, format.extensions.join(", ."));

Reading a file (the .wiff.scan must sit beside the .wiff):

use std::path::Path;

use openreadout_core::FormatReader;
use openreadout_sciex::SciexWiffReader;

let mut dataset = SciexWiffReader.open(Path::new("run.wiff"))?;
let info = dataset.info()?; // method, sample and scan index only
let run = &info.spectra[0];
println!("{} spectra, MS levels {:?}", run.scan_count, run.ms_levels);
let spectrum = dataset.read_spectrum(0, 0)?;
println!("MS{} at {:?} s: {} points", spectrum.ms_level, spectrum.rt_s, spectrum.mz.len());

§API stability

The supported API is what this page documents. The parser modules are public only so that tests and fuzz targets can reach them: they are hidden from this documentation and may change in any release.

Structs§

SciexWiffReader
The Sciex .wiff reader.

Constants§

FORMAT_ID
Format id used on the command line and in JSON.