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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
use core::ops::Range;

/// Struct containing the information of a found peak.
///
/// Some values can be `None`s -- you have to specify at least one of the corresponding bounds in
/// `PeakFinder`. If you don't, `find_peaks` skipps their calculation.
#[derive(Debug, PartialEq, Clone)]
pub struct Peak<T> {
    /// range indices the peak spans
    pub position: Range<usize>,
    /// absolute value of difference to the nearest neighbour to the left
    pub left_diff: T,
    /// absolute value of difference to the nearest neighbour to the right
    pub right_diff: T,
    pub height: Option<T>,
    pub prominence: Option<T>,
}

impl<T> Peak<T> {
    fn new(position: Range<usize>, left_diff: T, right_diff: T) -> Self {
        Self {
            position,
            left_diff,
            right_diff,
            height: None,
            prominence: None,
        }
    }
    fn add_height(&mut self, h: T) {
        self.height = Some(h);
    }
    fn add_prominence(&mut self, p: T) {
        self.prominence = Some(p);
    }

    /// Get the middle index of a peak (plateau). For an even plateau size the function rounds down.
    pub fn middle_position(&self) -> usize {
        (self.position.start + self.position.end) / 2
    }
}

#[derive(Debug, Clone)]
struct Limits<T> {
    pub lower: Option<T>,
    pub upper: Option<T>,
}

impl<T> Limits<T>
where
    T: PartialOrd,
{
    pub fn empty() -> Self {
        Self {
            lower: None,
            upper: None,
        }
    }

    pub fn is_empty(&self) -> bool {
        self.lower.is_none() && self.upper.is_none()
    }

    pub fn is_inside(&self, v: &T) -> bool {
        (self.lower.is_none() || v.ge(self.lower.as_ref().unwrap()))
            && (self.upper.is_none() || v.le(self.upper.as_ref().unwrap()))
    }
}

/// Setup for the peak filtering.
///
/// Change the settings by using the methods for specifing the lower and upper bounds.
#[derive(Debug, Clone)]
pub struct PeakFinder<'a, T> {
    y_data: &'a [T],
    height: Limits<T>,
    prominence: Limits<T>,
    difference: Limits<T>,
    plateau_size: Limits<usize>,
    zero: Option<T>,
}

impl<'a, T> PeakFinder<'a, T>
where
    T: Clone + std::ops::Sub<Output = T> + PartialOrd + std::fmt::Debug,
{
    /// Initialize with a data slice.
    pub fn new(y_data: &'a [T]) -> Self {
        if y_data.is_empty() {
            Self {
                y_data,
                height: Limits::empty(),
                prominence: Limits::empty(),
                difference: Limits::empty(),
                plateau_size: Limits::empty(),
                zero: None,
            }
        } else {
            let zero = Some(y_data[0].clone() - y_data[0].clone());
            Self {
                y_data,
                height: Limits::empty(),
                prominence: Limits::empty(),
                difference: Limits {
                    lower: zero.clone(),
                    upper: None,
                },
                plateau_size: Limits::empty(),
                zero,
            }
        }
    }

    fn get_local_maxima<'b>(&'b self) -> impl Iterator<Item = Peak<T>> + 'b {
        let zero = self.zero.clone().unwrap();

        let mut it = self.y_data.iter().cloned().enumerate();
        let (_i, zeroth) = it.next().unwrap();
        let (_i, first) = it.next().unwrap();

        let mut back_diff = first.clone() - zeroth;
        let mut prev = first;

        let limit = &self.difference;

        let mut start: Option<usize> = None;

        it.filter_map(move |(i, y)| {
            let ahead_diff = prev.clone() - y.clone(); // positive for downward slope
            let ahead_inside = limit.is_inside(&ahead_diff);
            let back_inside = limit.is_inside(&back_diff);

            let res = if back_inside && ahead_diff == zero {
                if start.is_none() {
                    start = Some(i - 1);
                }
                None
            } else {
                let r = if ahead_inside && back_inside {
                    Some(Peak::new(
                        start.unwrap_or(i - 1)..i,
                        back_diff.clone(),
                        ahead_diff.clone(),
                    ))
                } else {
                    None
                };

                start = None;
                back_diff = zero.clone() - ahead_diff;

                r
            };
            prev = y.clone();

            res
        })
    }

    fn filter_plateau<'b, I>(&'b self, peaks: I) -> impl Iterator<Item = Peak<T>> + 'b
    where
        I: Iterator<Item = Peak<T>> + 'b,
    {
        let limit = &self.plateau_size;
        let empty = limit.is_empty();

        peaks.filter_map(move |p| {
            if empty {
                // do nothing
                Some(p)
            } else {
                if limit.is_inside(&p.position.len()) {
                    Some(p)
                } else {
                    None
                }
            }
        })
    }

    fn filter_height<'b, I>(&'b self, peaks: I) -> impl Iterator<Item = Peak<T>> + 'b
    where
        I: Iterator<Item = Peak<T>> + 'b,
    {
        let limit = &self.height;
        let empty = limit.is_empty();

        peaks.filter_map(move |mut p| {
            if empty {
                // do nothing
                Some(p)
            } else {
                let y = self.y_data[p.position.start].clone();

                if limit.is_inside(&y) {
                    p.add_height(y);
                    Some(p)
                } else {
                    None
                }
            }
        })
    }

    fn filter_prominence<'b, I>(&'b self, peaks: I) -> impl Iterator<Item = Peak<T>> + 'b
    where
        I: Iterator<Item = Peak<T>> + 'b,
    {
        let limit = &self.prominence;
        let empty = limit.is_empty();

        peaks.filter_map(move |mut p| {
            if empty {
                // do nothing
                Some(p)
            } else {
                let prom = self.calc_prominence(&p);

                if limit.is_inside(&prom) {
                    p.add_prominence(prom);
                    Some(p)
                } else {
                    None
                }
            }
        })
    }

    fn calc_prominence(&self, p: &Peak<T>) -> T {
        let i_left = p.position.start;
        let i_right = p.position.end - 1;

        let data = &self.y_data;

        debug_assert_eq!(data[i_right], data[i_left]);

        let from_peak_right = data.iter().skip(i_right + 1);
        let from_peak_left = data.iter().rev().skip(data.len() - i_left);

        let left_valley_y = from_peak_left
            .take_while(|&x| x <= &data[i_left])
            .min_by(|a, b| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal));
        let right_valley_y = from_peak_right
            .take_while(|&x| x <= &data[i_left])
            .min_by(|a, b| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal));

        let peak_height = data[i_left].clone();
        match (left_valley_y, right_valley_y) {
            (None, None) => self.zero.clone().unwrap(),
            (Some(v), None) => peak_height - v.clone(),
            (None, Some(v)) => peak_height - v.clone(),
            (Some(v1), Some(v2)) => peak_height - (if v1.ge(&v2) { v1 } else { v2 }).clone(),
        }
        .clone()
    }

    /// Outputs a vector of `Peak<_>` structures containing peaks that matched the criteria
    /// specified in `PeakFinder<_>`.
    ///
    /// Output will **not** contain some properties (for example, height, prominence) unless you
    /// specified at least on of the corresponding bounds in `PeakFinder<_>` -- the calculation of
    /// the property is skipped.
    ///
    /// # Examples
    ///
    /// ```
    /// use find_peaks::PeakFinder;
    /// let y = [1., 2., 3., 0., 5., 0.];
    ///
    /// let ps = PeakFinder::new(&y)
    ///            .with_min_height(0.)
    ///            .with_min_prominence(1.)
    ///            .find_peaks();
    ///
    /// assert_eq!(
    ///    ps.iter().map(|x| x.middle_position()).collect::<Vec<_>>(),
    ///    vec![2, 4]
    /// );
    /// ```
    pub fn find_peaks(&self) -> Vec<Peak<T>> {
        if [0, 1].contains(&self.y_data.len()) {
            return Vec::new();
        }

        let it = self
            .filter_prominence(self.filter_height(self.filter_plateau(self.get_local_maxima())));

        it.collect()
    }

    pub fn with_min_height(&mut self, h: T) -> &mut Self {
        self.height.lower = Some(h);
        self
    }

    pub fn with_max_height(&mut self, h: T) -> &mut Self {
        self.height.upper = Some(h);
        self
    }

    pub fn with_min_prominence(&mut self, prominence: T) -> &mut Self {
        let zero = prominence.clone() - prominence.clone();
        assert!(zero.le(&prominence), "Prominence must be positive!");

        self.prominence.lower = Some(prominence);
        self
    }

    pub fn with_max_prominence(&mut self, prominence: T) -> &mut Self {
        let zero = prominence.clone() - prominence.clone();
        assert!(zero.le(&prominence), "Prominence must be positive!");

        self.prominence.upper = Some(prominence);
        self
    }

    pub fn with_min_difference(&mut self, difference: T) -> &mut Self {
        let zero = difference.clone() - difference.clone();
        assert!(zero.le(&difference), "Difference must be positive!");

        self.difference.lower = Some(difference);
        self
    }

    pub fn with_max_difference(&mut self, difference: T) -> &mut Self {
        let zero = difference.clone() - difference.clone();
        assert!(zero.le(&difference), "Difference must be positive!");

        self.difference.upper = Some(difference);
        self
    }

    pub fn with_min_plateau_size(&mut self, size: usize) -> &mut Self {
        self.plateau_size.lower = Some(size);
        self
    }

    pub fn with_max_plateau_size(&mut self, size: usize) -> &mut Self {
        self.plateau_size.upper = Some(size);
        self
    }
}

#[cfg(test)]
mod tests {
    use super::{Peak, PeakFinder};

    #[test]
    fn findpeaks() {
        let y = [1., 2., 3., 0., 5., 0.];
        let mut fp = PeakFinder::new(&y);
        fp.with_min_height(0.);
        let ps = fp.find_peaks();
        assert_eq!(
            ps,
            vec![
                Peak {
                    position: 2..3,
                    left_diff: 1.,
                    right_diff: 3.,
                    height: Some(3.),
                    prominence: None
                },
                Peak {
                    position: 4..5,
                    left_diff: 5.,
                    right_diff: 5.,
                    height: Some(5.),
                    prominence: None
                }
            ]
        );
    }

    #[test]
    fn proms() {
        let y = [1., 2., 3., 0., 5., 0.];
        let mut fp = PeakFinder::new(&y);
        fp.with_min_height(0.);
        fp.with_min_prominence(1.);
        let ps = fp.find_peaks();
        assert_eq!(
            ps,
            vec![
                Peak {
                    position: 2..3,
                    left_diff: 1.,
                    right_diff: 3.,
                    height: Some(3.),
                    prominence: Some(2.)
                },
                Peak {
                    position: 4..5,
                    left_diff: 5.,
                    right_diff: 5.,
                    height: Some(5.),
                    prominence: Some(5.)
                }
            ]
        );
    }

    #[test]
    fn plateaus() {
        let y = [1., 2., 3., 3., 3., 0., 5., 5., 0.];
        let mut fp = PeakFinder::new(&y);
        fp.with_min_height(0.);
        fp.with_min_prominence(0.);

        let ps = fp.find_peaks();

        assert_eq!(
            ps,
            vec![
                Peak {
                    position: 2..5,
                    left_diff: 1.,
                    right_diff: 3.,
                    height: Some(3.),
                    prominence: Some(2.)
                },
                Peak {
                    position: 6..8,
                    left_diff: 5.,
                    right_diff: 5.,
                    height: Some(5.),
                    prominence: Some(5.)
                }
            ]
        );

        fp.with_min_plateau_size(3);
        let ps = fp.find_peaks();

        assert_eq!(
            ps,
            vec![Peak {
                position: 2..5,
                left_diff: 1.,
                right_diff: 3.,
                height: Some(3.),
                prominence: Some(2.)
            }]
        );
    }

    #[test]
    fn plateau_with_diff() {
        let y = [1., 2., 3., 3., 3., 0., 5., 5., 0.];
        let mut fp = PeakFinder::new(&y);
        fp.with_min_prominence(0.);
        fp.with_min_height(0.);

        fp.with_min_difference(4.);
        let ps = fp.find_peaks();

        assert_eq!(
            ps,
            vec![Peak {
                position: 6..8,
                left_diff: 5.,
                right_diff: 5.,
                height: Some(5.),
                prominence: Some(5.)
            }]
        );
    }

    #[test]
    fn empty_data() {
        let y: Vec<u8> = vec![];
        let ps = PeakFinder::new(&y).with_min_prominence(1).find_peaks();

        assert_eq!(ps, Vec::new())
    }

    #[test]
    fn single_point() {
        let y: Vec<u32> = vec![1];
        let ps = PeakFinder::new(&y).find_peaks();

        assert_eq!(ps, vec![])
    }

    #[test]
    fn two_points() {
        let y: Vec<u32> = vec![2, 2];
        let ps = PeakFinder::new(&y).find_peaks();

        assert_eq!(ps, vec![])
    }
}