mzdeisotoper 0.3.2

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
use std::io;
use std::time::Instant;

use crossbeam_channel::{Receiver, Sender, TryRecvError, TrySendError};

use itertools::Itertools;
use mzdata::{
    io::MassSpectrometryFormat,
    prelude::*,
    spectrum::{
        bindata::BinaryCompressionType, utils::Collator,
        IonMobilityFrameGroup, SpectrumLike,
    },
    RawSpectrum,
};
use tracing::{debug, error, info, instrument};

use crate::{
    selection_targets::TargetTrackingFrameGroup,
    types::{
        CFeature, CPeak, DFeature, DPeak, FrameGroupType, FrameResult, FrameResultGroup, FrameType, SpectrumGroupType, SpectrumType, BUFFER_SIZE
    },
};

pub(crate) trait HasIndex {
    fn index(&self) -> usize;
}

pub(crate) trait Iterable: IntoIterator {
    fn iter(&self) -> impl Iterator<Item = &Self::Item>;
}

impl Iterable for SpectrumGroupType {
    fn iter(&self) -> impl Iterator<Item = &Self::Item> {
        self.iter()
    }
}

impl HasIndex for SpectrumType {
    fn index(&self) -> usize {
        self.description().index
    }
}

impl Iterable for FrameGroupType {
    fn iter(&self) -> impl Iterator<Item = &Self::Item> {
        self.iter()
    }
}

impl Iterable for TargetTrackingFrameGroup<CFeature, DFeature, FrameGroupType> {
    fn iter(&self) -> impl Iterator<Item = &Self::Item> {
        self.group.iter()
    }
}

impl Iterable for FrameResultGroup {
    fn iter(&self) -> impl Iterator<Item = &Self::Item> {
        self.iter()
    }
}

impl HasIndex for FrameType {
    fn index(&self) -> usize {
        self.description().index
    }
}

impl HasIndex for RawSpectrum {
    fn index(&self) -> usize {
        self.description().index
    }
}

impl HasIndex for FrameResult {
    fn index(&self) -> usize {
        IonMobilityFrameLike::index(self)
    }
}

#[instrument(level = "debug", skip(group, output_format))]
pub(crate) fn postprocess_spectra(
    group_idx: usize,
    mut group: SpectrumGroupType,
    output_format: MassSpectrometryFormat,
) -> (usize, SpectrumGroupType) {
    if matches!(output_format, MassSpectrometryFormat::MzML) {
        if let Some(precursor) = group.precursor_mut() {
            if let Some(peaks) = precursor.deconvoluted_peaks.as_ref() {
                let mut arrays = BuildArrayMapFrom::as_arrays(peaks.as_slice());
                arrays.iter_mut().for_each(|(_k, a)| {
                    a.store_compressed(BinaryCompressionType::Zlib).unwrap();
                });
                precursor.arrays = Some(arrays);
                precursor.deconvoluted_peaks = None;
                precursor.peaks = None
            }
        }
        for product in group.products_mut().iter_mut() {
            if let Some(peaks) = product.deconvoluted_peaks.as_ref() {
                let mut arrays = BuildArrayMapFrom::as_arrays(peaks.as_slice());
                arrays.iter_mut().for_each(|(_k, a)| {
                    a.store_compressed(BinaryCompressionType::Zlib).unwrap();
                });
                product.arrays = Some(arrays);
                product.deconvoluted_peaks = None;
                product.peaks = None;
            }
        }
        (group_idx, group)
    } else if matches!(output_format, MassSpectrometryFormat::MzMLb) {
        if let Some(precursor) = group.precursor_mut() {
            if let Some(peaks) = precursor.deconvoluted_peaks.as_ref() {
                let arrays = BuildArrayMapFrom::as_arrays(peaks.as_slice());
                precursor.arrays = Some(arrays);
                precursor.deconvoluted_peaks = None;
                precursor.peaks = None
            }
        }
        for product in group.products_mut().iter_mut() {
            if let Some(peaks) = product.deconvoluted_peaks.as_ref() {
                let arrays = BuildArrayMapFrom::as_arrays(peaks.as_slice());
                product.arrays = Some(arrays);
                product.deconvoluted_peaks = None;
                product.peaks = None;
            }
        }
        (group_idx, group)
    } else {
        (group_idx, group)
    }
}

#[instrument(level = "debug", skip(group, output_format))]
pub(crate) fn postprocess_frames(
    group_idx: usize,
    mut group: TargetTrackingFrameGroup<CFeature, DFeature, FrameGroupType>,
    output_format: MassSpectrometryFormat,
) -> (
    usize,
    FrameResultGroup,
) {
    let mut grp = IonMobilityFrameGroup::default();
    if matches!(output_format, MassSpectrometryFormat::MzML) {
        if let Some(precursor) = group.group.precursor.take() {
            let descr = precursor.description().clone();
            let mut spec = RawSpectrum::from(precursor);
            spec.arrays.iter_mut().for_each(|(_, a)| { a.store_compressed(BinaryCompressionType::Zlib).unwrap() });
            let spec = FrameResult::Flattened(spec, descr);
            grp.precursor = Some(spec);
        }
        let mut products = Vec::new();
        for product in group.group.products {
            let descr = product.description().clone();
            let mut spec = RawSpectrum::from(product);
            spec.arrays.iter_mut().for_each(|(_, a)| { a.store_compressed(BinaryCompressionType::Zlib).unwrap() });
            let spec = FrameResult::Flattened(spec, descr);
            products.push(spec);
        }
        grp.products = products;
        (group_idx, grp)
    } else if matches!(output_format, MassSpectrometryFormat::MzMLb) {
        let mut grp = IonMobilityFrameGroup::default();
        if let Some(precursor) = group.group.precursor.take() {
            let descr = precursor.description().clone();
            let spec = RawSpectrum::from(precursor);
            let spec = FrameResult::Flattened(spec, descr);
            grp.precursor = Some(spec);
        }
        let mut products = Vec::new();
        for product in group.group.products {
            let descr = product.description().clone();
            let spec = FrameResult::Flattened(RawSpectrum::from(product), descr);
            products.push(spec);
        }
        grp.products = products;
        (group_idx, grp)
    } else {
        grp.precursor = group.group.precursor.take().map(FrameResult::Frame);
        grp.products = group
            .group
            .products
            .into_iter()
            .map(FrameResult::Frame)
            .collect();
        (group_idx, grp)
    }
}

fn drain_channel<T: Send + HasIndex, I: Iterable<Item = T>>(
    collator: &mut Collator<T>,
    channel: &Receiver<(usize, I)>,
    batch_size: usize,
) -> bool {
    let mut j = 0;
    for b in 0..batch_size {
        match channel.try_recv() {
            Ok((_, group)) => {
                group
                    .into_iter()
                    .for_each(|s| collator.receive(s.index(), s));
                j += 1;
            }
            Err(e) => match e {
                TryRecvError::Empty => {
                    break;
                }
                TryRecvError::Disconnected => {
                    debug!("Work queue finished after draining {b} items from the work queue");
                    collator.done = true;
                    break;
                }
            },
        }
    }
    if j > batch_size / 2 {
        info!("Drained {j} items from work queue");
    }
    collator.done
}

pub(crate) fn collate_results_spectra<T: HasIndex + Send, I: Iterable<Item = T>>(
    receiver: Receiver<(usize, I)>,
    sender: Sender<(usize, T)>,
) {
    let mut collator = Collator::default();
    let mut i = 0usize;
    let mut last_send = Instant::now();
    let mut has_work = true;
    while has_work {
        i += 1;
        if i == usize::MAX {
            info!("Collation counter rolling over");
            i = 1;
        }
        {
            match receiver.try_recv() {
                Ok((group_idx, group)) => {
                    if group_idx == 0 {
                        if let Some(i) = group.iter().map(|s| s.index()).min() {
                            collator.next_key = i;
                        }
                    }
                    group
                        .into_iter()
                        .for_each(|s| collator.receive(s.index(), s));
                    if drain_channel(&mut collator, &receiver, 1000)
                        && collator.done
                        && collator.waiting.is_empty()
                    {
                        debug!("Setting collator loop condition to false");
                        has_work = false;
                    }
                }
                Err(e) => match e {
                    TryRecvError::Empty => {}
                    TryRecvError::Disconnected => {
                        collator.done = true;
                        if collator.done && collator.waiting.is_empty() {
                            debug!("Setting collator loop condition to false");
                            has_work = false;
                        }
                    }
                },
            }
        }

        let n = collator.waiting.len();
        if !collator.has_next() && i % 10000000 == 0 && i > 0 && n > 0 {
            let t = Instant::now();
            if (t - last_send).as_secs_f64() > 30.0 {
                let waiting_keys: Vec<_> =
                    collator.waiting.keys().sorted().take(10).copied().collect();
                let write_queue_size = sender.len();
                let work_queue_size = receiver.len();
                tracing::info!(
                    r#"Collator holding {n} entries at tick {i}, next key {} ({}), pending keys: {waiting_keys:?}
with {write_queue_size} writing backlog and {work_queue_size} work waiting to collate"#,
                    collator.next_key,
                    collator.has_next()
                );
                last_send = t;
            }
        }

        if collator.done && n > 0 {
            debug!("Draining output queue, {n} items");
            let mut waiting_items = std::mem::take(&mut collator.waiting)
                .into_iter()
                .collect_vec();
            waiting_items.sort_by(|(i, _), (j, _)| i.cmp(j));
            for (group_idx, group) in waiting_items {
                match sender.send((group_idx, group)) {
                    Ok(()) => {}
                    Err(e) => {
                        error!("Failed to send {group_idx} for writing: {e}");
                        debug!("Setting collator loop condition to false");
                        has_work = false;
                        break;
                    }
                }
            }
        } else {
            while let Some((group_idx, group)) = collator.try_next() {
                if collator.waiting.len() >= BUFFER_SIZE {
                    match sender.send((group_idx, group)) {
                        Ok(()) => {}
                        Err(e) => {
                            error!("Failed to send {group_idx} for writing: {e}");
                            debug!("Setting collator loop condition to false");
                            has_work = false;
                            break;
                        }
                    }
                } else {
                    match sender.try_send((group_idx, group)) {
                        Ok(()) => {}
                        Err(e) => match e {
                            TrySendError::Full((group_idx, group)) => {
                                collator.receive(group_idx, group);
                                collator.set_next_key(group_idx);
                            }
                            TrySendError::Disconnected(_) => {
                                error!("Failed to send {group_idx} for writing: {e}");
                                debug!("Setting collator loop condition to false");
                                has_work = false;
                                break;
                            }
                        },
                    }
                }
            }
        }
        if collator.waiting.len() < n {
            last_send = Instant::now();
        }
    }
    debug!("Spectrum collator done");
}

pub fn write_output_spectra<S: SpectrumWriter<CPeak, DPeak>>(
    mut writer: S,
    receiver: Receiver<(usize, SpectrumType)>,
) -> io::Result<()> {
    let mut checkpoint = 0usize;
    let mut time_checkpoint = 0.0;
    let mut scan_counter = 0usize;
    let mut scan_time = 0.0;
    while let Ok((group_idx, scan)) = receiver.recv() {
        scan_counter += 1;
        scan_time = scan.start_time();
        if ((group_idx - checkpoint) % 1000 == 0 && group_idx != 0)
            || (scan_time - time_checkpoint) > 1.0
        {
            let queue_size = receiver.len();
            if group_idx + 1 != scan_counter {
                tracing::info!(
                    "Completed Scan {} | Scans={scan_counter} Time={scan_time:0.3} | {queue_size} items in the write queue",
                    group_idx + 1
                );
            } else {
                tracing::info!("Completed Scan {} | Time={scan_time:0.3} | {queue_size} items in the write queue", group_idx + 1);
            }
            checkpoint = group_idx;
            time_checkpoint = scan_time;
        }
        writer.write(&scan)?;
    }
    if time_checkpoint != scan_time {
        tracing::info!("Finished | Scans={scan_counter} Time={scan_time:0.3}");
    }
    writer.close()?;
    Ok(())
}

pub fn write_output_frames<
    S: IonMobilityFrameWriter<CFeature, DFeature> + SpectrumWriter<CPeak, DPeak>,
>(
    mut writer: S,
    receiver: Receiver<(usize, FrameResult)>,
) -> io::Result<()> {
    let mut checkpoint = 0usize;
    let mut time_checkpoint = 0.0;
    let mut frame_counter = 0usize;
    let mut frame_time = 0.0;
    while let Ok((group_idx, frame)) = receiver.recv() {
        frame_counter += 1;
        frame_time = frame.start_time();
        if ((group_idx - checkpoint) % 1000 == 0 && group_idx != 0)
            || (frame_time - time_checkpoint) > 1.0
        {
            let queue_size = receiver.len();
            if group_idx + 1 != frame_counter {
                tracing::info!(
                    "Completed Frame {} | Frames={frame_counter} Time={frame_time:0.3} | {queue_size} items in the write queue",
                    group_idx + 1
                );
            } else {
                tracing::info!("Completed Frame {} | Time={frame_time:0.3} | {queue_size} items in the write queue", group_idx + 1);
            }
            checkpoint = group_idx;
            time_checkpoint = frame_time;
        }
        let span = tracing::debug_span!("writing frame", frame_index = group_idx);
        let _entered = span.enter();

        match frame {
            FrameResult::Flattened(raw_spectrum, _) => writer.write_owned(raw_spectrum),
            FrameResult::Frame(frame) => writer.write_frame_owned(frame),
        }?;

        // writer.write_frame(&frame)?;
    }
    if time_checkpoint != frame_time {
        tracing::info!("Finished | Frame={frame_counter} Time={frame_time:0.3}");
    }
    writer.close()?;
    Ok(())
}