dspk-core 0.0.6

Core types for dspk: recordings, buffers, time, masks, windows, and the CubeCL compute layer with run-time device choice (wgpu, CUDA, HIP, CPU)
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

use serde::{Deserialize, Serialize};

/// Physical unit of a channel's scaled values (`stored * gain + offset`).
/// Microvolts in one volt (formats storing volts per bit report µV).
pub const MICROVOLTS_PER_VOLT: f64 = 1e6;

#[derive(Debug, Clone, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum SignalUnit {
    Volt,
    Millivolt,
    Microvolt,
    Ampere,
    Milliampere,
    Microampere,
    /// Normalized values or raw counts.
    #[default]
    Dimensionless,
    /// Any unit not listed, by its symbol (e.g. `"Pa"`, `"g"`).
    Other(String),
}

impl SignalUnit {
    /// Display symbol (`"µV"`, `"mA"`, …); empty for [`SignalUnit::Dimensionless`].
    pub fn symbol(&self) -> &str {
        match self {
            SignalUnit::Volt => "V",
            SignalUnit::Millivolt => "mV",
            SignalUnit::Microvolt => "µV",
            SignalUnit::Ampere => "A",
            SignalUnit::Milliampere => "mA",
            SignalUnit::Microampere => "µA",
            SignalUnit::Dimensionless => "",
            SignalUnit::Other(symbol) => symbol,
        }
    }
}