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
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

/*
 * 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 core::cmp::Ordering;
use core::fmt;

use crate::{constants::celestial_objects::SUN, frames::Frame};

use hifitime::Epoch;
#[cfg(feature = "python")]
use pyo3::prelude::*;

/// Stores the result of an occultation computation with the occultation percentage
/// Refer to the [MathSpec](https://nyxspace.com/nyxspace/MathSpec/celestial/eclipse/) for modeling details.
#[derive(Copy, Clone, Debug, PartialEq)]
#[cfg_attr(feature = "python", pyclass)]
#[cfg_attr(feature = "python", pyo3(module = "anise.astro"))]
pub struct Occultation {
    pub epoch: Epoch,
    /// Percetnage is 100 for an umbra, 0 for full visibility, and in between for penumbra
    pub percentage: f64,
    pub back_frame: Frame,
    pub front_frame: Frame,
}

#[cfg_attr(feature = "python", pymethods)]
impl Occultation {
    /// Returns the percentage as a factor between 0 and 1
    ///
    /// :rtype: float
    pub fn factor(&self) -> f64 {
        self.percentage / 100.0
    }

    /// Returns true if the back object is the Sun, false otherwise
    ///
    /// :rtype: bool
    pub const fn is_eclipse_computation(&self) -> bool {
        self.back_frame.ephem_origin_id_match(SUN)
    }

    /// Returns true if the occultation percentage is less than or equal 0.001%
    ///
    /// :rtype: bool
    pub fn is_visible(&self) -> bool {
        self.percentage < 1e-3
    }

    /// Returns true if the occultation percentage is greater than or equal 99.999%
    ///
    /// :rtype: bool
    pub fn is_obstructed(&self) -> bool {
        self.percentage > 99.999
    }

    /// Returns true if neither occulted nor visible (i.e. penumbra for solar eclipsing)
    ///
    /// :rtype: bool
    pub fn is_partial(&self) -> bool {
        !self.is_visible() && !self.is_obstructed()
    }
}

#[cfg_attr(feature = "python", pymethods)]
#[cfg(feature = "python")]
impl Occultation {
    /// :rtype: Epoch
    #[getter]
    fn get_epoch(&self) -> PyResult<Epoch> {
        Ok(self.epoch)
    }
    /// :type epoch: Epoch
    #[setter]
    fn set_epoch(&mut self, epoch: Epoch) -> PyResult<()> {
        self.epoch = epoch;
        Ok(())
    }

    /// :rtype: float
    #[getter]
    fn get_percentage(&self) -> PyResult<f64> {
        Ok(self.percentage)
    }
    /// :type percentage: float
    #[setter]
    fn set_percentage(&mut self, percentage: f64) -> PyResult<()> {
        self.percentage = percentage;
        Ok(())
    }

    /// :rtype: Frame
    #[getter]
    fn get_back_frame(&self) -> PyResult<Frame> {
        Ok(self.back_frame)
    }
    /// :type back_frame: Frame
    #[setter]
    fn set_back_frame(&mut self, back_frame: Frame) -> PyResult<()> {
        self.back_frame = back_frame;
        Ok(())
    }

    /// :rtype: Frame
    #[getter]
    fn get_front_frame(&self) -> PyResult<Frame> {
        Ok(self.front_frame)
    }
    /// :type front_frame: Frame
    #[setter]
    fn set_front_frame(&mut self, front_frame: Frame) -> PyResult<()> {
        self.front_frame = front_frame;
        Ok(())
    }

    fn __str__(&self) -> String {
        format!("{self}")
    }

    fn __repr__(&self) -> String {
        format!("{self} (@{self:p})")
    }
}

impl fmt::Display for Occultation {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if self.is_eclipse_computation() {
            // This is an eclipse computation
            if self.is_visible() {
                write!(
                    f,
                    "{}: no eclipse due to {:e}",
                    self.epoch, self.front_frame
                )
            } else if self.is_obstructed() {
                write!(f, "{}: umbra due to {:e}", self.epoch, self.front_frame)
            } else {
                write!(
                    f,
                    "{}: penumbra of {:.3}% due to {:e}",
                    self.epoch, self.percentage, self.front_frame
                )
            }
        } else {
            write!(
                f,
                "{}: {:.3}% occultation of {:e} due to {:e}",
                self.epoch, self.percentage, self.front_frame, self.back_frame
            )
        }
    }
}

impl PartialOrd for Occultation {
    /// Provides an ordering of the occultation by percentage, if the back and front objects match
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        if self.front_frame != other.front_frame || self.back_frame != other.back_frame {
            None
        } else {
            self.percentage.partial_cmp(&other.percentage)
        }
    }
}