siderust 0.11.0

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

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

//! Pixel values stored in stellar surface-brightness maps.
//!
//! The v1 representation keeps both diagnostic S10 surface-brightness values
//! and the integrated photon radiance used by downstream night-sky-brightness
//! calculations.

/// Pixel value for a stellar surface-brightness map.
#[derive(Debug, Copy, Clone, PartialEq)]
pub struct StellarSurfaceBrightness {
    /// Integrated photon radiance in photons per square centimeter per nanosecond per steradian.
    pub integrated_ph_cm2_ns_sr: f64,
    /// B-band tenth-magnitude-star surface brightness per square degree.
    pub b_s10: f64,
    /// V-band tenth-magnitude-star surface brightness per square degree.
    pub v_s10: f64,
}

impl StellarSurfaceBrightness {
    /// Return an empty pixel value.
    #[must_use]
    pub fn zero() -> Self {
        Self {
            integrated_ph_cm2_ns_sr: 0.0,
            b_s10: 0.0,
            v_s10: 0.0,
        }
    }

    /// Return true when all values are finite and non-negative.
    #[must_use]
    pub fn is_valid(self) -> bool {
        self.integrated_ph_cm2_ns_sr.is_finite()
            && self.b_s10.is_finite()
            && self.v_s10.is_finite()
            && self.integrated_ph_cm2_ns_sr >= 0.0
            && self.b_s10 >= 0.0
            && self.v_s10 >= 0.0
    }
}