siderust 0.9.1

High-precision astronomy and satellite mechanics in Rust.
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
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

// SPDX-License-Identifier: AGPL-3.0-or-later
// Copyright (C) 2026 Vallés Puig, Ramon

//! Field-of-view geometry and instrument metadata.

use qtty::angular::Radians;

/// Field-of-view geometry attached to an instrument.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum Fov {
    /// Right circular cone, parameterised by half-angle from the
    /// boresight to the cone edge.
    Conical {
        /// Half-angle of the cone.
        half_angle: Radians,
    },
    /// Rectangular pyramid with full-angle extents about the boresight.
    Rectangular {
        /// Full angle across the X axis.
        across_track: Radians,
        /// Full angle across the Y axis.
        along_track: Radians,
    },
}

impl Fov {
    /// Test whether an off-axis angle (measured from the boresight in the
    /// instrument frame, boresight = +Z) lies inside the field of view.
    ///
    /// For conical FoVs, the point is inside when `|off_axis| ≤ half_angle`.
    ///
    /// For rectangular FoVs a single off-axis angle is insufficient to fully
    /// describe containment in both axes; this method conservatively tests
    /// `|off_axis| ≤ min(across_track, along_track) / 2`. Callers that need
    /// a proper 2-axis rectangular test should decompose the off-axis vector
    /// into its x and y components and test each axis independently.
    pub fn contains_boresight(&self, off_axis: Radians) -> bool {
        let abs_off = off_axis.abs();
        match self {
            Fov::Conical { half_angle } => abs_off <= *half_angle,
            Fov::Rectangular {
                across_track,
                along_track,
            } => {
                let half_x = *across_track / 2.0;
                let half_y = *along_track / 2.0;
                // Use the smaller half-angle as the conservative single-axis bound.
                let bound = if half_x <= half_y { half_x } else { half_y };
                abs_off <= bound
            }
        }
    }
}

/// Instrument metadata: a typed FoV plus a free-text identifier.
#[derive(Debug, Clone, PartialEq)]
pub struct Instrument {
    /// Free-text identifier for the instrument.
    pub id: String,
    /// Field-of-view geometry.
    pub fov: Fov,
}

impl Instrument {
    /// Build an [`Instrument`] with the supplied identifier and FoV.
    pub fn new(id: impl Into<String>, fov: Fov) -> Self {
        Self { id: id.into(), fov }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use qtty::Quantity;

    #[test]
    fn fov_conical_contains_axis() {
        let fov = Fov::Conical {
            half_angle: Quantity::new(0.1),
        };
        assert!(fov.contains_boresight(Quantity::new(0.0)));
        assert!(fov.contains_boresight(Quantity::new(0.099)));
        assert!(!fov.contains_boresight(Quantity::new(0.2)));
    }

    #[test]
    fn fov_rectangular_uses_smaller_half_angle() {
        // across_track = 0.2 rad full → half = 0.1; along_track = 0.4 rad full → half = 0.2.
        // Conservative bound = min(0.1, 0.2) = 0.1.
        let fov = Fov::Rectangular {
            across_track: Quantity::new(0.2),
            along_track: Quantity::new(0.4),
        };
        assert!(fov.contains_boresight(Quantity::new(0.0)));
        assert!(fov.contains_boresight(Quantity::new(0.09)));
        assert!(!fov.contains_boresight(Quantity::new(0.15)));
    }

    #[test]
    fn instrument_construction_preserves_id() {
        let inst = Instrument::new(
            "demo",
            Fov::Conical {
                half_angle: Quantity::new(0.1),
            },
        );
        assert_eq!(inst.id, "demo");
    }
}