lasprs 0.14.3

Library for Acoustic Signal Processing (Rust edition, with optional Python bindings via pyo3)
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

use super::*;
use crate::{siggen::source::SourceImpl, *};
use snafu::prelude::*;

type Result<T> = std::result::Result<T, SiggenError>;

/// Sine wave, with configurable frequency
#[derive(Clone, Debug)]
pub struct Sine {
    // Sampling freq \[Hz\]
    fs: StrictlyPositive,
    // current stored phase
    phase: Flt,
    // Signal frequency \[rad/s\]
    omg: StrictlyPositive,
}
impl Sine {
    /// Create new sine source signal
    ///
    /// Args:
    ///
    /// * fs: Sampling freq [Hz]
    /// *
    pub fn new(freq: Positive, fs: StrictlyPositive) -> Result<Sine> {
        ensure!(
            *freq < *fs / 2.0,
            InvalidParameterSnafu {
                param: "Frequency",
                criterion: "Sine frequency should be smaller than Nyquist frequency"
            }
        );

        Ok(Sine {
            fs,
            phase: 0.0,
            omg: StrictlyPositive::new(twopi * *freq).unwrap(), // Freq is already checked for being positive
        })
    }
}
impl SourceImpl for Sine {
    fn genSignal_unscaled(&mut self, sig: &mut dyn ExactSizeIterator<Item = &mut Flt>) {
        if *self.fs <= 0.0 {
            sig.for_each(|s| {
                *s = 0.0;
            });
            return;
        }
        sig.for_each(|s| {
            *s = Flt::sin(self.phase);
            self.phase += *self.omg / *self.fs;
            self.phase %= twopi;
        });
    }
    fn fs(&self) -> StrictlyPositive {
        self.fs
    }
}