mzdeisotoper 0.3.5

Deisotoping and charge state deconvolution of mass spectrometry files
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
use std::collections::HashMap;

use itertools::Itertools;

use mzdata::{io::MassSpectrometryFormat, prelude::*, spectrum::{ScanPolarity, SignalContinuity}, Param};
use mzpeaks::MZPeakSetType;

use mzdeisotope::{
    isolation::{Coisolation, PrecursorPurityEstimator},
    scorer::{IsotopicFitFilter, IsotopicPatternScorer},
    solution::DeconvolvedSolutionPeak,
    DeconvolutionEngine, PeaksAndTargets,
};

use crate::{
    args::{DeconvolutionParams, PrecursorProcessing, SignalParams},
    progress::ProgressRecord,
    types::{CPeak, SpectrumGroupType, SpectrumType, PEAK_COUNT_THRESHOLD_WARNING},
    write::postprocess_spectra,
};

pub fn coisolation_to_param(c: &Coisolation) -> Param {
    Param::new_key_value(
        "mzdeisotope:coisolation".to_string(),
        format!(
            "{} {} {}",
            c.neutral_mass,
            c.intensity,
            c.charge.unwrap_or_default()
        ),
    )
}

pub struct PrecursorPeakMapper<'a> {
    mzs: &'a [f64],
    peaks: &'a [Option<DeconvolvedSolutionPeak>],
}

impl<'a> PrecursorPeakMapper<'a> {
    pub fn new(mzs: &'a [f64], peaks: &'a [Option<DeconvolvedSolutionPeak>]) -> Self {
        Self { mzs, peaks }
    }

    pub fn find_peak_for_mz(&self, mz: f64) -> Option<&DeconvolvedSolutionPeak> {
        self.find_mz(mz).and_then(|i| self.peaks[i].as_ref())
    }

    pub fn find_mz(&self, mz: f64) -> Option<usize> {
        self.mzs
            .iter()
            .find_position(|m| (**m - mz).abs() < 1e-6)
            .map(|(i, _)| i)
    }
}

pub fn purities_of(
    purity_estimator: &PrecursorPurityEstimator,
    group: &SpectrumGroupType,
    targets: &PrecursorPeakMapper,
    is_dia: bool,
) -> HashMap<usize, (f32, Vec<Coisolation>)> {
    let mut purities = HashMap::new();
    if let Some(precursor_scan) = group.precursor() {
        group.products().iter().enumerate().for_each(|(i, scan)| {
            if let Some(prec) = scan.precursor() {
                if is_dia {
                    let coisolations = purity_estimator.coisolation(
                        precursor_scan.deconvoluted_peaks.as_ref().unwrap(),
                        &DeconvolvedSolutionPeak::new(
                            prec.ion().unwrap().mz,
                            0.0,
                            1,
                            0,
                            0.0,
                            Box::default(),
                        ),
                        Some(&prec.isolation_window),
                        0.1,
                        true,
                    );
                    purities.insert(i, (0.0, coisolations));
                } else if let Some(peak) = targets.find_peak_for_mz(prec.ion().unwrap().mz) {
                    if is_dia {
                        // For DIA mode, purity isn't meaningful
                    } else {
                        let purity = purity_estimator.precursor_purity(
                            precursor_scan.peaks.as_ref().unwrap(),
                            peak,
                            Some(&prec.isolation_window),
                        );
                        let coisolations = purity_estimator.coisolation(
                            precursor_scan.deconvoluted_peaks.as_ref().unwrap(),
                            peak,
                            Some(&prec.isolation_window),
                            0.1,
                            true,
                        );
                        purities.insert(i, (purity, coisolations));
                    }
                }
            }
        });
    }
    purities
}

#[tracing::instrument(
    level = "debug",
    skip(
        scan,
        precursor_processing,
        selected_mz_ranges,
        signal_processing_params
    )
)]
pub fn pick_ms1_peaks(
    scan: &mut SpectrumType,
    precursor_processing: &PrecursorProcessing,
    selected_mz_ranges: &[(f64, f64)],
    signal_processing_params: &SignalParams,
) -> Option<MZPeakSetType<CPeak>> {
    match scan.signal_continuity() {
        SignalContinuity::Unknown => {
            panic!("Can't infer peak mode for {}", scan.id())
        }
        SignalContinuity::Centroid => match precursor_processing {
            PrecursorProcessing::Full | PrecursorProcessing::MS1Only | PrecursorProcessing::DIA => {
                Some(scan.try_build_centroids().unwrap().clone())
            }
            PrecursorProcessing::SelectedPrecursors => {
                let peaks = scan.try_build_centroids().unwrap();
                let peaks = selected_mz_ranges
                    .iter()
                    .flat_map(|(low, high)| peaks.between(*low, *high, Tolerance::PPM(5.0)))
                    .cloned()
                    .collect();

                Some(peaks)
            }
            PrecursorProcessing::TandemOnly => None,
        },
        SignalContinuity::Profile => {
            if signal_processing_params.ms1_denoising > 0.0 {
                tracing::trace!("Denoising {}", scan.id());
                if let Err(e) = scan.denoise(signal_processing_params.ms1_denoising) {
                    tracing::error!("An error occurred while denoising {}: {e}", scan.id());
                }
            }
            match precursor_processing {
                PrecursorProcessing::SelectedPrecursors => {
                    scan.pick_peaks_in_intervals(1.0, selected_mz_ranges)
                        .unwrap();
                    scan.description_mut().signal_continuity = SignalContinuity::Centroid;
                    Some(scan.peaks.clone().unwrap())
                }
                PrecursorProcessing::Full
                | PrecursorProcessing::MS1Only
                | PrecursorProcessing::DIA => {
                    scan.pick_peaks(1.0).unwrap();
                    scan.description_mut().signal_continuity = SignalContinuity::Centroid;
                    Some(scan.peaks.clone().unwrap())
                }
                PrecursorProcessing::TandemOnly => None,
            }
        }
    }
}

pub fn pick_msn_peaks(
    scan: &mut SpectrumType,
    _signal_processing_params: &SignalParams,
) -> MZPeakSetType<CPeak> {
    match scan.signal_continuity() {
        SignalContinuity::Unknown => {
            panic!("Can't infer peak mode for {}", scan.id())
        }
        SignalContinuity::Centroid => scan.try_build_centroids().unwrap().clone(),
        SignalContinuity::Profile => {
            scan.pick_peaks(1.0).unwrap();
            scan.description_mut().signal_continuity = SignalContinuity::Centroid;
            scan.peaks.clone().unwrap()
        }
    }
}

#[allow(clippy::too_many_arguments)]
pub fn deconvolution_transform<
    S: IsotopicPatternScorer + Send + 'static,
    F: IsotopicFitFilter + Send + 'static,
    SN: IsotopicPatternScorer + Send + 'static,
    FN: IsotopicFitFilter + Send + 'static,
>(
    ms1_engine: &mut DeconvolutionEngine<'_, CPeak, S, F>,
    msn_engine: &mut DeconvolutionEngine<'_, CPeak, SN, FN>,
    ms1_deconv_params: &DeconvolutionParams,
    msn_deconv_params: &DeconvolutionParams,
    signal_processing_params: &SignalParams,
    group_idx: usize,
    mut group: SpectrumGroupType,
    precursor_processing: PrecursorProcessing,
    writer_format: MassSpectrometryFormat,
) -> (usize, SpectrumGroupType, ProgressRecord) {
    let had_precursor = group.precursor().is_some();
    let mut prog = ProgressRecord::default();
    let is_dia = matches!(precursor_processing, PrecursorProcessing::DIA);

    let precursor_mz: Vec<_> = if is_dia {
        vec![]
    } else {
        group
            .products()
            .iter()
            .flat_map(|s| s.precursor().map(|prec| prec.ion().unwrap().mz))
            .collect()
    };

    let purity_estimator = PrecursorPurityEstimator::default();

    let selected_mz_ranges = group.selected_intervals(1.0, 3.0);

    // Process the precursor spectrum and collect the updated selected ions' solutions
    let targets = match group.precursor_mut() {
        Some(scan) => {
            if tracing::enabled!(tracing::Level::TRACE) {
                tracing::trace!(
                    "Processing {} MS{} ({:0.3})",
                    scan.id(),
                    scan.ms_level(),
                    scan.start_time()
                );
            }

            let peaks = pick_ms1_peaks(
                scan,
                &precursor_processing,
                &selected_mz_ranges,
                signal_processing_params,
            );

            let charge_range = match scan.polarity() {
                ScanPolarity::Unknown
                | ScanPolarity::Positive => {
                    let (mut low, mut high) = ms1_deconv_params.charge_range;
                    low = low.abs();
                    high = high.abs();
                    (low.min(high), high.max(low))
                }
                ScanPolarity::Negative => {
                    let (mut low, mut high) = ms1_deconv_params.charge_range;
                    low = -low.abs();
                    high = -high.abs();
                    (low.min(high), high.max(low))
                }
            };

            if let Some(peaks) = peaks {
                let has_too_many_peaks = peaks.len() >= PEAK_COUNT_THRESHOLD_WARNING;
                if has_too_many_peaks {
                    tracing::warn!("{} has {} centroids", scan.id(), peaks.len())
                }
                let PeaksAndTargets {
                    deconvoluted_peaks,
                    targets,
                } = ms1_engine
                    .deconvolute_peaks_with_targets(
                        peaks,
                        Tolerance::PPM(20.0),
                        charge_range,
                        ms1_deconv_params.max_missed_peaks,
                        &precursor_mz,
                    )
                    .unwrap();
                if has_too_many_peaks {
                    tracing::warn!(
                        "{} has {} deconvolved centroids",
                        scan.id(),
                        deconvoluted_peaks.len()
                    )
                }
                prog.ms1_peaks = deconvoluted_peaks.len();
                prog.ms1_spectra += 1;
                scan.deconvoluted_peaks = Some(deconvoluted_peaks);
                targets
            } else {
                // We aren't actually deconvoluting the MS1 spectrum, so create a stub for each precursor
                vec![None; precursor_mz.len()]
            }
        }
        None => vec![None; precursor_mz.len()],
    };
    let mut purities = HashMap::new();

    let precursor_map = PrecursorPeakMapper::new(&precursor_mz, &targets);

    if had_precursor {
        purities = purities_of(&purity_estimator, &group, &precursor_map, is_dia);
    }

    group
        .products_mut()
        .iter_mut()
        .enumerate()
        .for_each(|(scan_i, scan)| {
            if !had_precursor && tracing::enabled!(tracing::Level::TRACE) {
                tracing::trace!(
                    "Processing {} MS{} ({:0.3})",
                    scan.id(),
                    scan.ms_level(),
                    scan.acquisition().start_time()
                );
            }

            let precursor_charge = scan
                .precursor()
                .and_then(|prec| prec.ion().and_then(|i| i.charge()))
                .unwrap_or(msn_deconv_params.charge_range.1);

            let mut msn_charge_range = msn_deconv_params.charge_range;

            if precursor_charge.abs() < msn_charge_range.1.abs() && precursor_charge.abs() != 0 {
                msn_charge_range.1 = precursor_charge;
            }

            msn_charge_range = match scan.polarity() {
                ScanPolarity::Unknown
                | ScanPolarity::Positive => {
                    let (mut low, mut high) = msn_charge_range;
                    low = low.abs();
                    high = high.abs();
                    (low.min(high), high.max(low))
                }
                ScanPolarity::Negative => {
                    let (mut low, mut high) = msn_charge_range;
                    low = -low.abs();
                    high = -high.abs();
                    (low.min(high), high.max(low))
                }
            };

            let peaks = pick_msn_peaks(scan, signal_processing_params);
            {
                let deconvoluted_peaks = msn_engine
                    .deconvolute_peaks(
                        peaks,
                        Tolerance::PPM(20.0),
                        msn_charge_range,
                        msn_deconv_params.max_missed_peaks,
                    )
                    .unwrap();
                prog.msn_peaks += deconvoluted_peaks.len();
                prog.msn_spectra += 1;
                scan.deconvoluted_peaks = Some(deconvoluted_peaks);
            }

            if is_dia {
                if let Some(prec) = scan.precursor_mut() {
                    let ion = prec.ion_mut().unwrap();
                    let (_, coisolated) = purities.remove(&scan_i).unwrap_or_default();
                    coisolated.iter().for_each(|c| {
                        ion.params_mut().push(coisolation_to_param(c));
                    });
                }
            } else if let Some(prec) = scan.precursor_mut() {
                let target_mz = prec.ion().unwrap().mz();
                let _ = precursor_map
                    .find_mz(target_mz)
                    .map(|i| {
                        if let Some(peak) = &targets[i] {
                            let orig_charge = prec.ion().unwrap().charge();
                            let update_ion = if let Some(orig_z) = orig_charge {
                                let t = orig_z == peak.charge;
                                if !t {
                                    prog.precursor_charge_state_mismatch += 1;
                                }
                                t
                            } else {
                                true
                            };
                            let prec_ion = prec.ion_mut().unwrap();
                            if update_ion {
                                prec_ion.mz = peak.mz();
                                prec_ion.charge = Some(peak.charge);
                                prec_ion.intensity = peak.intensity;
                                let (purity, coisolated) =
                                    purities.remove(&scan_i).unwrap_or_default();
                                prec_ion.params_mut().push(Param::new_key_value(
                                    "mzdeisotope:isolation purity".to_string(),
                                    purity.to_string(),
                                ));
                                coisolated.iter().for_each(|c| {
                                    prec_ion.params_mut().push(coisolation_to_param(c));
                                });
                            } else {
                                prec_ion.params_mut().push(Param::new_key_value(
                                    "mzdeisotope:defaulted".to_string(),
                                    true.to_string(),
                                ));
                                let (purity, coisolated) =
                                    purities.remove(&scan_i).unwrap_or_default();
                                prec_ion.params_mut().push(Param::new_key_value(
                                    "mzdeisotope:isolation purity".to_string(),
                                    purity.to_string(),
                                ));
                                coisolated.iter().for_each(|c| {
                                    prec_ion.params_mut().push(coisolation_to_param(c));
                                });
                                prog.precursors_defaulted += 1;
                            }
                        }
                    })
                    .or_else(|| {
                        let prec_ion = prec.ion_mut().unwrap();
                        prec_ion.params_mut().push(Param::new_key_value(
                            "mzdeisotope:defaulted".to_string(),
                            true.to_string(),
                        ));
                        prec_ion.params_mut().push(Param::new_key_value(
                            "mzdeisotope:orphan".to_string(),
                            true.to_string(),
                        ));
                        prog.precursors_defaulted += 1;
                        None
                    });
            }
        });

    let (group_idx, group) = postprocess_spectra(group_idx, group, writer_format);
    (group_idx, group, prog)
}