lasprs 0.14.1

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

use super::*;
use crate::*;
use anyhow::{Error, Result, bail};
use derive_builder::Builder;

/// Settings for Cross Power Spectrum computation, compatible with lasp.CPSSettings
#[derive(Builder, Clone, Copy, Debug, PartialEq, Hash, serde::Serialize, serde::Deserialize)]
#[builder(
    pattern = "owned",
    build_fn(validate = "Self::validate", error = "Error")
)]
#[cfg_attr(
    feature = "python-bindings",
    gen_stub_pyclass,
    pyclass(get_all, from_py_object)
)]
pub struct CPSSettings {
    /// FFT Length
    pub nfft: usize,
    /// Overlap percentage [0, 100)
    pub overlap: Overlap,
    /// Window applied to time segments. See [WindowType].
    #[builder(default)]
    pub window: WindowType,
    /// Start sample index (None for start of signal)
    #[builder(default)]
    pub istart: Option<usize>,
    /// Stop sample index (None for end of signal)
    #[builder(default)]
    pub istop: Option<usize>,
}
impl Default for CPSSettings {
    fn default() -> Self {
        Self {
            nfft: 2048,
            overlap: Default::default(),
            window: Default::default(),
            istart: Default::default(),
            istop: Default::default(),
        }
    }
}

impl CPSSettingsBuilder {
    fn validate(&self) -> Result<()> {
        if self.nfft.is_none() {
            bail!("nfft not specified")
        };
        let nfft = self.nfft.unwrap();
        if !nfft.is_multiple_of(2) {
            bail!("NFFT should be even")
        }
        if nfft == 0 {
            bail!("Invalid NFFT, should be > 0.")
        }

        if let Some(overlap) = self.overlap {
            overlap.validate(nfft)?;
        }

        if let (Some(istart), Some(istop)) = (self.istart, self.istop)
            && let (Some(start), Some(stop)) = (istart, istop)
            && start >= stop
        {
            bail!("istart should be less than istop")
        }

        Ok(())
    }
}

#[cfg(feature = "python-bindings")]
#[cfg_attr(feature = "python-bindings", gen_stub_pymethods, pymethods)]
impl CPSSettings {
    // I do not know why, but adding this signature results in compilation errors for the stub generation.
    // #[pyo3(signature = (nfft, overlap, window=WindowType::Hann, istart=None, istop=None))]
    #[new]
    fn new(
        nfft: usize,
        overlap: Overlap,
        window: WindowType,
        istart: Option<usize>,
        istop: Option<usize>,
    ) -> PyResult<CPSSettings> {
        let builder = CPSSettingsBuilder::default()
            .nfft(nfft)
            .overlap(overlap)
            .window(window)
            .istart(istart)
            .istop(istop);
        Ok(builder.build()?)
    }
    #[staticmethod]
    #[pyo3(name = "default")]
    fn default_py() -> CPSSettings {
        CPSSettings::default()
    }

    /// Get the number of samples to overlap
    fn get_overlap_samples_py(&self) -> usize {
        self.get_overlap_samples()
    }

    /// Get the hop size (number of samples to advance between FFT blocks)
    fn get_hop_size_py(&self) -> usize {
        self.get_hop_size()
    }
}

impl CPSSettings {
    /// Returns the amount of samples to overlap
    pub fn get_overlap_samples(&self) -> usize {
        self.overlap.get_overlap_samples(self.nfft) as usize
    }

    /// Returns the hop size (number of samples to advance between FFT blocks)
    pub fn get_hop_size(&self) -> usize {
        self.overlap.get_hop_size(self.nfft) as usize
    }

    /// Convert to ApsSettings given a sampling frequency
    pub fn to_aps_settings(&self, fs: StrictlyPositive) -> ApsSettings {
        ApsSettings {
            mode: ApsMode::AllAveraging {},
            overlap: self.overlap,
            windowType: self.window,
            freqWeightingType: FreqWeighting::Z, // Default to no weighting
            nfft: self.nfft,
            fs,
        }
    }
}