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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

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

//! Generated stellar surface-brightness map wrapper.
//!
//! The wrapper keeps the typed Galactic HEALPix map and its provenance metadata
//! together as one generated data product.

use crate::coordinates::frames::Galactic;
use crate::healpix::{HealpixGrid, HealpixMap};
use crate::starlight::{StellarMapProvenance, StellarSurfaceBrightness};

/// Generated Galactic stellar surface-brightness map with provenance.
#[derive(Debug, Clone, PartialEq)]
pub struct StellarSurfaceBrightnessMap {
    map: HealpixMap<Galactic, StellarSurfaceBrightness>,
    provenance: StellarMapProvenance,
}

impl StellarSurfaceBrightnessMap {
    /// Construct a generated stellar map from validated map data and provenance.
    #[must_use]
    pub fn new(
        map: HealpixMap<Galactic, StellarSurfaceBrightness>,
        provenance: StellarMapProvenance,
    ) -> Self {
        Self { map, provenance }
    }

    /// Return the underlying HEALPix grid.
    #[must_use]
    pub fn grid(&self) -> HealpixGrid {
        self.map.grid()
    }

    /// Return the pixel values in grid ordering.
    #[must_use]
    pub fn values(&self) -> &[StellarSurfaceBrightness] {
        self.map.values()
    }

    /// Return the provenance metadata attached to this generated map.
    #[must_use]
    pub fn provenance(&self) -> &StellarMapProvenance {
        &self.provenance
    }

    /// Return the inner typed HEALPix map.
    #[must_use]
    pub fn healpix_map(&self) -> &HealpixMap<Galactic, StellarSurfaceBrightness> {
        &self.map
    }

    /// Consume the wrapper and return the map and provenance.
    #[must_use]
    pub fn into_parts(
        self,
    ) -> (
        HealpixMap<Galactic, StellarSurfaceBrightness>,
        StellarMapProvenance,
    ) {
        (self.map, self.provenance)
    }
}