anise 0.9.6

Core of the ANISE library
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

/*
 * ANISE Toolkit
 * Copyright (C) 2021-onward Christopher Rabotin <christopher.rabotin@gmail.com> et al. (cf. AUTHORS.md)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 *
 * Documentation: https://nyxspace.com/
 */

use super::Almanac;
use crate::errors::{AlmanacPhysicsSnafu, AlmanacResult};
use crate::{
    errors::AlmanacError,
    math::rotation::Quaternion,
    prelude::Orbit,
    structure::{dataset::DataSetError, instrument::Instrument, lookuptable::LutError},
};

use snafu::ResultExt;

impl Almanac {
    /// Returns the Instrument from its ID, searching through all loaded instrument datasets in reverse order.
    pub fn instrument_from_id(&self, id: i32) -> AlmanacResult<Instrument> {
        for data in self.instrument_data.values().rev() {
            if let Ok(datum) = data.get_by_id(id) {
                return Ok(datum);
            }
        }

        Err(AlmanacError::TLDataSet {
            action: "instrument from ID",
            source: DataSetError::DataSetLut {
                action: "seeking location by ID",
                source: LutError::UnknownId { id },
            },
        })
    }

    /// Returns the Instrument Location from its name, searching through all loaded instrument datasets in reverse order.
    pub fn instrument_from_name(&self, name: &str) -> AlmanacResult<Instrument> {
        for data in self.instrument_data.values().rev() {
            if let Ok(datum) = data.get_by_name(name) {
                return Ok(datum);
            }
        }

        Err(AlmanacError::TLDataSet {
            action: "instrument from name",
            source: DataSetError::DataSetLut {
                action: "seeking location by name",
                source: LutError::UnknownName {
                    name: name.to_string(),
                },
            },
        })
    }

    pub fn instrument_field_of_view_margin(
        &self,
        instrument_id: i32,
        sc_q_to_b: Quaternion,
        sc_state: Orbit,
        target_state: Orbit,
    ) -> AlmanacResult<f64> {
        let instrument = self.instrument_from_id(instrument_id)?;

        instrument
            .fov_margin_deg(sc_q_to_b, sc_state, target_state)
            .context(AlmanacPhysicsSnafu {
                action: "instrument FOV",
            })
    }
}