nabled-sensor 0.0.11

Kalman, EKF, IMU, and camera models for nabled Physical AI estimation
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

//! Sensor fusion and estimation.

#![allow(clippy::missing_errors_doc, clippy::many_single_char_names)]

use nabled_core::errors::{IntoNabledError, NabledError, ShapeError};

pub mod camera;
pub mod ekf;
pub mod imu;
pub mod kalman;

#[derive(Debug, Clone, PartialEq)]
pub enum SensorError {
    EmptyInput,
    DimensionMismatch,
    InvalidInput(String),
    NumericalInstability,
}

impl std::fmt::Display for SensorError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            SensorError::EmptyInput => write!(f, "input cannot be empty"),
            SensorError::DimensionMismatch => write!(f, "input dimensions are incompatible"),
            SensorError::InvalidInput(message) => write!(f, "invalid input: {message}"),
            SensorError::NumericalInstability => write!(f, "numerical instability detected"),
        }
    }
}

impl std::error::Error for SensorError {}

impl IntoNabledError for SensorError {
    fn into_nabled_error(self) -> NabledError {
        match self {
            SensorError::EmptyInput => NabledError::Shape(ShapeError::EmptyInput),
            SensorError::DimensionMismatch => NabledError::Shape(ShapeError::DimensionMismatch),
            SensorError::InvalidInput(message) => NabledError::InvalidInput(message),
            SensorError::NumericalInstability => NabledError::NumericalInstability,
        }
    }
}

#[cfg(test)]
mod tests {
    use nabled_core::errors::{IntoNabledError, NabledError, ShapeError};

    use super::*;

    #[test]
    fn sensor_errors_display_and_map_to_shared_taxonomy() {
        assert_eq!(SensorError::EmptyInput.to_string(), "input cannot be empty");
        assert_eq!(SensorError::DimensionMismatch.to_string(), "input dimensions are incompatible");
        assert_eq!(
            SensorError::InvalidInput("bad z".to_string()).to_string(),
            "invalid input: bad z"
        );
        assert_eq!(SensorError::NumericalInstability.to_string(), "numerical instability detected");

        assert!(matches!(
            SensorError::EmptyInput.into_nabled_error(),
            NabledError::Shape(ShapeError::EmptyInput)
        ));
        assert!(matches!(
            SensorError::DimensionMismatch.into_nabled_error(),
            NabledError::Shape(ShapeError::DimensionMismatch)
        ));
        assert!(matches!(
            SensorError::InvalidInput("x".to_string()).into_nabled_error(),
            NabledError::InvalidInput(_)
        ));
        assert!(matches!(
            SensorError::NumericalInstability.into_nabled_error(),
            NabledError::NumericalInstability
        ));
    }
}