cspice 0.1.0

Safe wrapper around the NAIF CSPICE toolkit
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

//! Functions for converting between different types of coordinates.
use crate::with_spice_lock_or_panic;
use cspice_sys::{azlrec_c, recazl_c, reclat_c, recrad_c, SpiceBoolean, SpiceDouble};
use derive_more::Into;

/// Rectangular coordinates
#[repr(C)]
#[derive(Copy, Clone, Debug, Default, PartialEq, Into)]
pub struct Rectangular {
    pub x: SpiceDouble,
    pub y: SpiceDouble,
    pub z: SpiceDouble,
}

impl From<[SpiceDouble; 3]> for Rectangular {
    fn from(rect: [SpiceDouble; 3]) -> Self {
        Rectangular {
            x: rect[0],
            y: rect[1],
            z: rect[2],
        }
    }
}

impl From<Rectangular> for [SpiceDouble; 3] {
    fn from(rect: Rectangular) -> Self {
        [rect.x, rect.y, rect.z]
    }
}

/// Range, azimuth, and elevation
#[derive(Copy, Clone, Debug, Default, PartialEq)]
pub struct AzEl {
    pub range: SpiceDouble,
    pub az: SpiceDouble,
    pub el: SpiceDouble,
}

impl AzEl {
    /// See [recazl_c](https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/recazl_c.html)
    pub fn from_rect(mut rect: Rectangular, azccw: bool, elplsz: bool) -> Self {
        with_spice_lock_or_panic(|| {
            let mut az_el = AzEl::default();
            unsafe {
                recazl_c(
                    &mut rect.x as *mut SpiceDouble,
                    azccw as SpiceBoolean,
                    elplsz as SpiceBoolean,
                    &mut az_el.range,
                    &mut az_el.az,
                    &mut az_el.el,
                )
            };
            az_el
        })
    }
}

impl Rectangular {
    /// See [azlrec_c](https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/azlrec_c.html)
    pub fn from_azel(azel: AzEl, azccw: bool, elplsz: bool) -> Self {
        with_spice_lock_or_panic(|| {
            let mut rect = [0.0f64; 3];
            unsafe {
                azlrec_c(
                    azel.range,
                    azel.az,
                    azel.el,
                    azccw as SpiceBoolean,
                    elplsz as SpiceBoolean,
                    rect.as_mut_ptr(),
                )
            };
            rect.into()
        })
    }
}

/// Range, right ascension, and declination.
#[derive(Copy, Clone, Debug, Default, PartialEq)]
pub struct RaDec {
    pub range: SpiceDouble,
    pub ra: SpiceDouble,
    pub dec: SpiceDouble,
}

impl From<Rectangular> for RaDec {
    /// See [recrad_c](https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/recrad_c.html).
    fn from(mut rect: Rectangular) -> Self {
        with_spice_lock_or_panic(|| {
            let mut ra_dec = RaDec::default();
            unsafe {
                recrad_c(
                    &mut rect.x as *mut SpiceDouble,
                    &mut ra_dec.range,
                    &mut ra_dec.ra,
                    &mut ra_dec.dec,
                )
            };
            ra_dec
        })
    }
}

/// Latitudinal coordinates.
#[derive(Copy, Clone, Debug, Default, PartialEq)]
pub struct Latitudinal {
    pub radius: SpiceDouble,
    pub longitude: SpiceDouble,
    pub latitude: SpiceDouble,
}

impl From<Rectangular> for Latitudinal {
    /// See [reclat_c](https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/reclat_c.html).
    fn from(mut rect: Rectangular) -> Self {
        with_spice_lock_or_panic(|| {
            let mut lat = Latitudinal::default();
            unsafe {
                reclat_c(
                    &mut rect.x as *mut SpiceDouble,
                    &mut lat.radius,
                    &mut lat.longitude,
                    &mut lat.latitude,
                )
            };
            lat
        })
    }
}

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

    const EPSILON: f64 = 1e-3;

    // Test data comes from NAIF website https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/recazl_c.html
    const TEST_DATA_F_F: [[SpiceDouble; 6]; 11] = [
        [0.000, 0.000, 0.000, 0.000, 0.000, 0.000],
        [1.000, 0.000, 0.000, 1.000, 0.000, 0.000],
        [0.000, 1.000, 0.000, 1.000, 270.000, 0.000],
        [0.000, 0.000, 1.000, 1.000, 0.000, -90.000],
        [-1.000, 0.000, 0.000, 1.000, 180.000, 0.000],
        [0.000, -1.000, 0.000, 1.000, 90.000, 0.000],
        [0.000, 0.000, -1.000, 1.000, 0.000, 90.000],
        [1.000, 1.000, 0.000, 1.414, 315.000, 0.000],
        [1.000, 0.000, 1.000, 1.414, 0.000, -45.000],
        [0.000, 1.000, 1.000, 1.414, 270.000, -45.000],
        [1.000, 1.000, 1.000, 1.732, 315.000, -35.264],
    ];

    const TEST_DATA_F_T: [[SpiceDouble; 6]; 11] = [
        [0.000, 0.000, 0.000, 0.000, 0.000, 0.000],
        [1.000, 0.000, 0.000, 1.000, 0.000, 0.000],
        [0.000, 1.000, 0.000, 1.000, 270.000, 0.000],
        [0.000, 0.000, 1.000, 1.000, 0.000, 90.000],
        [-1.000, 0.000, 0.000, 1.000, 180.000, 0.000],
        [0.000, -1.000, 0.000, 1.000, 90.000, 0.000],
        [0.000, 0.000, -1.000, 1.000, 0.000, -90.000],
        [1.000, 1.000, 0.000, 1.414, 315.000, 0.000],
        [1.000, 0.000, 1.000, 1.414, 0.000, 45.000],
        [0.000, 1.000, 1.000, 1.414, 270.000, 45.000],
        [1.000, 1.000, 1.000, 1.732, 315.000, 35.264],
    ];

    const TEST_DATA_T_F: [[SpiceDouble; 6]; 11] = [
        [0.000, 0.000, 0.000, 0.000, 0.000, 0.000],
        [1.000, 0.000, 0.000, 1.000, 0.000, 0.000],
        [0.000, 1.000, 0.000, 1.000, 90.000, 0.000],
        [0.000, 0.000, 1.000, 1.000, 0.000, -90.000],
        [-1.000, 0.000, 0.000, 1.000, 180.000, 0.000],
        [0.000, -1.000, 0.000, 1.000, 270.000, 0.000],
        [0.000, 0.000, -1.000, 1.000, 0.000, 90.000],
        [1.000, 1.000, 0.000, 1.414, 45.000, 0.000],
        [1.000, 0.000, 1.000, 1.414, 0.000, -45.000],
        [0.000, 1.000, 1.000, 1.414, 90.000, -45.000],
        [1.000, 1.000, 1.000, 1.732, 45.000, -35.264],
    ];

    const TEST_DATA_T_T: [[SpiceDouble; 6]; 11] = [
        [0.000, 0.000, 0.000, 0.000, 0.000, 0.000],
        [1.000, 0.000, 0.000, 1.000, 0.000, 0.000],
        [0.000, 1.000, 0.000, 1.000, 90.000, 0.000],
        [0.000, 0.000, 1.000, 1.000, 0.000, 90.000],
        [-1.000, 0.000, 0.000, 1.000, 180.000, 0.000],
        [0.000, -1.000, 0.000, 1.000, 270.000, 0.000],
        [0.000, 0.000, -1.000, 1.000, 0.000, -90.000],
        [1.000, 1.000, 0.000, 1.414, 45.000, 0.000],
        [1.000, 0.000, 1.000, 1.414, 0.000, 45.000],
        [0.000, 1.000, 1.000, 1.414, 90.000, 45.000],
        [1.000, 1.000, 1.000, 1.732, 45.000, 35.264],
    ];

    #[test]
    fn test_azel_rect_conversion() {
        azel_rect_conversion(&TEST_DATA_F_F, false, false);
        azel_rect_conversion(&TEST_DATA_F_T, false, true);
        azel_rect_conversion(&TEST_DATA_T_F, true, false);
        azel_rect_conversion(&TEST_DATA_T_T, true, true);
    }

    fn azel_rect_conversion(test_data: &[[f64; 6]; 11], azccw: bool, elplsz: bool) {
        for test in test_data.iter() {
            let azel = AzEl {
                range: test[3],
                az: test[4].to_radians(),
                el: test[5].to_radians(),
            };
            let rect = Rectangular::from_azel(azel, azccw, elplsz);
            assert!((rect.x - test[0]).abs() < EPSILON);
            assert!((rect.y - test[1]).abs() < EPSILON);
            assert!((rect.z - test[2]).abs() < EPSILON);
            let azel_ = AzEl::from_rect(rect, azccw, elplsz);
            assert!((azel_.range - test[3]).abs() < EPSILON);
            assert!((azel_.az - test[4].to_radians()).abs() < EPSILON);
            assert!((azel_.el - test[5].to_radians()).abs() < EPSILON);
        }
    }
}