rsspice 0.1.0

Pure Rust port of the SPICE Toolkit for space geometry
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
//
// GENERATED FILE
//

use super::*;
use f2rust_std::*;

const CNVTOL: f64 = 0.000001;
const NWMAX: i32 = 15;
const NWDIST: i32 = 5;
const NWSEP: i32 = 5;
const NWRR: i32 = 5;
const NWUDS: i32 = 5;
const NWPA: i32 = 5;
const NWILUM: i32 = 5;
const ADDWIN: f64 = 0.5;
const FRMNLN: i32 = 32;
const FOVTLN: i32 = 40;
const FTCIRC: &[u8] = b"CIRCLE";
const FTELLI: &[u8] = b"ELLIPSE";
const FTPOLY: &[u8] = b"POLYGON";
const FTRECT: &[u8] = b"RECTANGLE";
const ANNULR: &[u8] = b"ANNULAR";
const ANY: &[u8] = b"ANY";
const PARTL: &[u8] = b"PARTIAL";
const FULL: &[u8] = b"FULL";
const DSSHAP: &[u8] = b"DSK";
const EDSHAP: &[u8] = b"ELLIPSOID";
const PTSHAP: &[u8] = b"POINT";
const RYSHAP: &[u8] = b"RAY";
const SPSHAP: &[u8] = b"SPHERE";
const NOCTYP: i32 = 4;
const OCLLN: i32 = 7;
const SHPLEN: i32 = 9;
const MAXVRT: i32 = 10000;
const CIRFOV: &[u8] = b"CIRCLE";
const ELLFOV: &[u8] = b"ELLIPSE";
const POLFOV: &[u8] = b"POLYGON";
const RECFOV: &[u8] = b"RECTANGLE";
const NABCOR: i32 = 15;
const ABATSZ: i32 = 6;
const GEOIDX: i32 = 1;
const LTIDX: i32 = (GEOIDX + 1);
const STLIDX: i32 = (LTIDX + 1);
const CNVIDX: i32 = (STLIDX + 1);
const XMTIDX: i32 = (CNVIDX + 1);
const RELIDX: i32 = (XMTIDX + 1);
const CORLEN: i32 = 5;
const PCK: &[u8] = b"nat.pck";
const SPK: &[u8] = b"nat.spk";
const NRCORR: i32 = 5;
const NXCORR: i32 = 4;
const BDNMLN: i32 = 36;
const LNSIZE: i32 = 80;

struct SaveVars {
    RCORR: ActualCharArray,
    XCORR: ActualCharArray,
    TARGET: ActualCharArray,
    ILLUMN: ActualCharArray,
    OBSRVR: ActualCharArray,
}

impl SaveInit for SaveVars {
    fn new() -> Self {
        let mut RCORR = ActualCharArray::new(CORLEN, 1..=NRCORR);
        let mut XCORR = ActualCharArray::new(CORLEN, 1..=NXCORR);
        let mut TARGET = ActualCharArray::new(BDNMLN, 1..=6);
        let mut ILLUMN = ActualCharArray::new(BDNMLN, 1..=6);
        let mut OBSRVR = ActualCharArray::new(BDNMLN, 1..=6);

        {
            use f2rust_std::data::Val;

            let mut clist = [
                Val::C(b"nOne"),
                Val::C(b"lT"),
                Val::C(b"Cn"),
                Val::C(b"Lt+s"),
                Val::C(b"cN+S"),
            ]
            .into_iter();
            RCORR
                .iter_mut()
                .for_each(|n| fstr::assign(n, clist.next().unwrap().into_str()));

            debug_assert!(clist.next().is_none(), "DATA not fully initialised");
        }
        {
            use f2rust_std::data::Val;

            let mut clist = [
                Val::C(b"xlT"),
                Val::C(b"xCn"),
                Val::C(b"XLt+s"),
                Val::C(b"XcN+S"),
            ]
            .into_iter();
            XCORR
                .iter_mut()
                .for_each(|n| fstr::assign(n, clist.next().unwrap().into_str()));

            debug_assert!(clist.next().is_none(), "DATA not fully initialised");
        }
        {
            use f2rust_std::data::Val;

            let mut clist = [
                Val::C(b"ALPHA"),
                Val::C(b"ALPHA"),
                Val::C(b"X"),
                Val::C(b"ALPHA"),
                Val::C(b"SUN"),
                Val::C(b"ALPHA"),
            ]
            .into_iter();
            TARGET
                .iter_mut()
                .for_each(|n| fstr::assign(n, clist.next().unwrap().into_str()));

            debug_assert!(clist.next().is_none(), "DATA not fully initialised");
        }
        {
            use f2rust_std::data::Val;

            let mut clist = [
                Val::C(b"SUN"),
                Val::C(b"X"),
                Val::C(b"SUN"),
                Val::C(b"ALPHA"),
                Val::C(b"SUN"),
                Val::C(b"SUN"),
            ]
            .into_iter();
            ILLUMN
                .iter_mut()
                .for_each(|n| fstr::assign(n, clist.next().unwrap().into_str()));

            debug_assert!(clist.next().is_none(), "DATA not fully initialised");
        }
        {
            use f2rust_std::data::Val;

            let mut clist = [
                Val::C(b"X"),
                Val::C(b"BETA"),
                Val::C(b"BETA"),
                Val::C(b"BETA"),
                Val::C(b"ALPHA"),
                Val::C(b"SUN"),
            ]
            .into_iter();
            OBSRVR
                .iter_mut()
                .for_each(|n| fstr::assign(n, clist.next().unwrap().into_str()));

            debug_assert!(clist.next().is_none(), "DATA not fully initialised");
        }

        Self {
            RCORR,
            XCORR,
            TARGET,
            ILLUMN,
            OBSRVR,
        }
    }
}

//$Procedure F_ZZGFPAU ( ZZGFPAU family tests )
pub fn F_ZZGFPAU(OK: &mut bool, ctx: &mut Context) -> f2rust_std::Result<()> {
    let save = ctx.get_vars::<SaveVars>();
    let save = &mut *save.borrow_mut();

    let mut ABCORR = [b' '; CORLEN as usize];
    let mut XABCOR = [b' '; CORLEN as usize];
    let mut TARG = [b' '; BDNMLN as usize];
    let mut ILLUM = [b' '; BDNMLN as usize];
    let mut OBS = [b' '; BDNMLN as usize];
    let mut TXT = [b' '; (2 * LNSIZE) as usize];
    let mut ET: f64 = 0.0;
    let mut RVL: f64 = 0.0;
    let mut HANDLE: i32 = 0;
    let mut XTARG: i32 = 0;
    let mut XILLUM: i32 = 0;
    let mut XOBS: i32 = 0;
    let mut YTARG: i32 = 0;
    let mut YILLUM: i32 = 0;
    let mut YOBS: i32 = 0;
    let mut XABLK = StackArray::<bool, 15>::new(1..=NABCOR);
    let mut ABLK = StackArray::<bool, 15>::new(1..=NABCOR);
    let mut DECRES: bool = false;
    let mut FOUND: bool = false;

    //
    // Local parameters
    //

    //
    // Local variables
    //

    //
    // Saved variables
    //

    //
    // Indices 1:3 for Invalid body name test, 4:6 for not distinct
    // body names test.
    //

    //
    // Begin every test family with an open call.
    //
    testutil::TOPEN(b"F_ZZGFPAU", ctx)?;

    //
    // Case 1: Create test kernels.
    //
    testutil::TCASE(b"Setup: create and load SPK, PCK, LSK files.", ctx)?;

    //
    // Create the PCK for Nat's Solar System.
    //
    testutil::NATPCK(PCK, false, true, ctx)?;
    testutil::CHCKXC(false, b" ", OK, ctx)?;

    spicelib::FURNSH(PCK, ctx)?;
    testutil::CHCKXC(false, b" ", OK, ctx)?;

    testutil::NATSPK(SPK, true, &mut HANDLE, ctx)?;
    testutil::CHCKXC(false, b" ", OK, ctx)?;

    spicelib::FURNSH(SPK, ctx)?;
    testutil::CHCKXC(false, b" ", OK, ctx)?;

    //
    // Case 2: Invalid body names.
    //
    fstr::assign(&mut ABCORR, save.RCORR.get(1));

    for I in 1..=3 {
        fstr::assign(&mut TARG, save.TARGET.get(I));
        fstr::assign(&mut ILLUM, save.ILLUMN.get(I));
        fstr::assign(&mut OBS, save.OBSRVR.get(I));

        fstr::assign(
            &mut TXT,
            b"Invalid body name test. TARG = #, ILLUM = #, OBS = #",
        );
        spicelib::REPMC(&TXT.clone(), b"#", &TARG, &mut TXT);
        spicelib::REPMC(&TXT.clone(), b"#", &ILLUM, &mut TXT);
        spicelib::REPMC(&TXT.clone(), b"#", &OBS, &mut TXT);

        testutil::TCASE(&TXT, ctx)?;

        spicelib::ZZGFPAIN(&TARG, &ILLUM, &ABCORR, &OBS, ctx)?;
        testutil::CHCKXC(true, b"SPICE(IDCODENOTFOUND)", OK, ctx)?;
    }

    //
    // Case 3: Invalid aberration corrections.
    //

    //
    // Set appropriate values for TARGET, ILLUMN, OBSRVR.
    //
    fstr::assign(&mut TARG, save.TARGET.get(1));
    fstr::assign(&mut ILLUM, save.ILLUMN.get(1));
    fstr::assign(&mut OBS, save.OBSRVR.get(2));

    for I in 1..=NXCORR {
        fstr::assign(&mut ABCORR, save.XCORR.get(I));

        fstr::assign(&mut TXT, b"Invalid aberration correction. ABCOR = #");
        spicelib::REPMC(&TXT.clone(), b"#", &ABCORR, &mut TXT);

        testutil::TCASE(&TXT, ctx)?;

        spicelib::ZZGFPAIN(&TARG, &ILLUM, &ABCORR, &OBS, ctx)?;
        testutil::CHCKXC(true, b"SPICE(INVALIDOPTION)", OK, ctx)?;
    }

    //
    // Case 4: Not distinct body names.
    //

    //
    // Set appropriate values for ABCORR.
    //
    fstr::assign(&mut ABCORR, save.RCORR.get(1));

    for I in 4..=6 {
        fstr::assign(&mut TARG, save.TARGET.get(I));
        fstr::assign(&mut ILLUM, save.ILLUMN.get(I));
        fstr::assign(&mut OBS, save.OBSRVR.get(I));

        fstr::assign(
            &mut TXT,
            b"Not distinct body name test. TARG = #, ILLUM = #, OBS = #",
        );
        spicelib::REPMC(&TXT.clone(), b"#", &TARG, &mut TXT);
        spicelib::REPMC(&TXT.clone(), b"#", &ILLUM, &mut TXT);
        spicelib::REPMC(&TXT.clone(), b"#", &OBS, &mut TXT);

        testutil::TCASE(&TXT, ctx)?;

        spicelib::ZZGFPAIN(&TARG, &ILLUM, &ABCORR, &OBS, ctx)?;
        testutil::CHCKXC(true, b"SPICE(BODIESNOTDISTINCT)", OK, ctx)?;
    }

    //
    // Case 5: Confirm initialized values are correctly saved.
    //

    fstr::assign(&mut TARG, save.TARGET.get(1));
    fstr::assign(&mut ILLUM, save.ILLUMN.get(1));
    fstr::assign(&mut OBS, save.OBSRVR.get(2));
    fstr::assign(&mut ABCORR, save.RCORR.get(1));

    spicelib::BODS2C(&TARG, &mut YTARG, &mut FOUND, ctx)?;
    testutil::CHCKXC(false, b" ", OK, ctx)?;

    spicelib::BODS2C(&ILLUM, &mut YILLUM, &mut FOUND, ctx)?;
    testutil::CHCKXC(false, b" ", OK, ctx)?;

    spicelib::BODS2C(&OBS, &mut YOBS, &mut FOUND, ctx)?;
    testutil::CHCKXC(false, b" ", OK, ctx)?;

    //
    // Aberration correction NONE.
    //

    for J in 1..=ABATSZ {
        ABLK[J] = false;
        XABLK[J] = false;
    }

    fstr::assign(&mut TXT, b"Initialize then check saved values in ZZGFPAIN. TARG = #, ILLUM = #, OBS = #, ABCORR = #.");
    spicelib::REPMC(&TXT.clone(), b"#", &TARG, &mut TXT);
    spicelib::REPMC(&TXT.clone(), b"#", &ILLUM, &mut TXT);
    spicelib::REPMC(&TXT.clone(), b"#", &OBS, &mut TXT);
    spicelib::REPMC(&TXT.clone(), b"#", &ABCORR, &mut TXT);

    testutil::TCASE(&TXT, ctx)?;

    spicelib::ZZGFPAIN(&TARG, &ILLUM, &ABCORR, &OBS, ctx)?;

    spicelib::ZZGFPAX(
        &mut XTARG,
        &mut XILLUM,
        &mut XABCOR,
        &mut XOBS,
        XABLK.as_slice_mut(),
        ctx,
    );

    testutil::CHCKSI(b"TARG X vs Y", XTARG, b"=", YTARG, 0, OK, ctx)?;
    testutil::CHCKSI(b"ILLUM X vs Y", XILLUM, b"=", YILLUM, 0, OK, ctx)?;
    testutil::CHCKSI(b"OBS X vs Y", XOBS, b"=", YOBS, 0, OK, ctx)?;

    spicelib::UCASE(&ABCORR.clone(), &mut ABCORR, ctx);
    testutil::CHCKSC(b"ABCORR vs XABCORR", &XABCOR, b"=", &ABCORR, OK, ctx)?;

    spicelib::ZZVALCOR(&ABCORR, ABLK.as_slice_mut(), ctx)?;

    for J in 1..=ABATSZ {
        testutil::CHCKSL(b"ABLK", XABLK[J], ABLK[J], OK, ctx)?;
    }

    //
    // Aberration correction not NONE.
    //

    for I in 2..=NRCORR {
        for J in 1..=ABATSZ {
            ABLK[J] = false;
            XABLK[J] = false;
        }

        fstr::assign(&mut TXT, b"Initialize then check saved values in ZZGFPAIN. TARG = #, ILLUM = #, OBS = #, ABCORR = #.");
        spicelib::REPMC(&TXT.clone(), b"#", &TARG, &mut TXT);
        spicelib::REPMC(&TXT.clone(), b"#", &ILLUM, &mut TXT);
        spicelib::REPMC(&TXT.clone(), b"#", &OBS, &mut TXT);

        fstr::assign(&mut ABCORR, save.RCORR.get(I));

        spicelib::REPMC(&TXT.clone(), b"#", &ABCORR, &mut TXT);

        spicelib::ZZVALCOR(&ABCORR, ABLK.as_slice_mut(), ctx)?;

        testutil::TCASE(&TXT, ctx)?;

        spicelib::ZZGFPAIN(&TARG, &ILLUM, &ABCORR, &OBS, ctx)?;
        testutil::CHCKXC(false, b" ", OK, ctx)?;

        spicelib::ZZGFPAX(
            &mut XTARG,
            &mut XILLUM,
            &mut XABCOR,
            &mut XOBS,
            XABLK.as_slice_mut(),
            ctx,
        );

        spicelib::UCASE(&ABCORR.clone(), &mut ABCORR, ctx);
        testutil::CHCKSC(b"ABCORR vs Y", &XABCOR, b"=", &ABCORR, OK, ctx)?;

        for J in 1..=ABATSZ {
            testutil::CHCKSL(&TXT, XABLK[J], ABLK[J], OK, ctx)?;
        }
    }

    //
    // Case 6: Check calculation of phase angle derivative.
    //

    //
    // Occultation of ALPHA by BETA as observed from Sol starts
    // at 0 TDB secs from J2000 epoch (geometric). The occultation
    // lasts ten minutes.
    //
    // Confirm the phase angle decreases prior to occultation
    // and increases post occultation.
    //
    fstr::assign(&mut TARG, b"ALPHA");
    fstr::assign(&mut ILLUM, b"SUN");
    fstr::assign(&mut OBS, b"BETA");

    //
    // Loop over all aberration corrections.
    //
    for I in 1..=NRCORR {
        fstr::assign(&mut ABCORR, save.RCORR.get(I));

        fstr::assign(
            &mut TXT,
            b"Phase angle decreasing prior and increasing post occultaion. ABCORR = #.",
        );
        spicelib::REPMC(&TXT.clone(), b"#", &ABCORR, &mut TXT);

        testutil::TCASE(&TXT, ctx)?;

        spicelib::ZZGFPAIN(&TARG, &ILLUM, &ABCORR, &OBS, ctx)?;

        DECRES = false;

        //
        // Ten minutes prior to start of occultation.
        //
        ET = -(10.0 * 60.0);
        spicelib::ZZGFPAGQ(&mut ET, &mut RVL, ctx)?;
        spicelib::ZZGFPADC(spicelib::UDF, &mut ET, &mut DECRES, ctx)?;

        testutil::CHCKSL(&TXT, DECRES, true, OK, ctx)?;

        //
        // Ten minutes post to start of occultation.
        //
        ET = (10.0 * 60.0);
        spicelib::ZZGFPAGQ(&mut ET, &mut RVL, ctx)?;
        spicelib::ZZGFPADC(spicelib::UDF, &mut ET, &mut DECRES, ctx)?;

        testutil::CHCKSL(&TXT, DECRES, false, OK, ctx)?;
    }

    //
    // Case N:
    //
    testutil::TCASE(b"Clean up:  delete kernels.", ctx)?;

    spicelib::KCLEAR(ctx)?;

    spicelib::DELFIL(PCK, ctx)?;
    testutil::CHCKXC(false, b" ", OK, ctx)?;

    spicelib::DELFIL(SPK, ctx)?;
    testutil::CHCKXC(false, b" ", OK, ctx)?;

    testutil::T_SUCCESS(OK, ctx);

    Ok(())
}