siderust 0.6.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
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

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

//! Cartesian coordinate type aliases for common astronomical systems.
//!
//! This module provides convenient type aliases that combine algebraic cartesian
//! types with standard astronomical reference frames and centers.
//!
//! ## Semantic Types
//!
//! - [`Position`]: Affine points with center, frame, and unit
//! - [`Displacement`]: Displacement vectors with frame and unit (center-independent)
//! - [`Direction`]: Unit vectors with frame only (dimensionless)
//! - [`Velocity`]: Rate-of-change vectors with frame and unit
//! - [`Vector`]: Generic free vector (base type for Displacement and Velocity)

use crate::coordinates::{centers, frames};

/// Re-export the algebraic types
pub use affn::cartesian::*;

// =============================================================================
// Direction type aliases (frame-only, no center, dimensionless)
// =============================================================================

pub mod direction {
    use super::frames;
    pub use super::Direction;

    /// **EclipticMeanJ2000** cartesian direction (unit vector).
    pub type EclipticMeanJ2000 = Direction<frames::EclipticMeanJ2000>;
    /// **Equatorial mean J2000** cartesian direction (unit vector).
    pub type EquatorialMeanJ2000 = Direction<frames::EquatorialMeanJ2000>;
    /// **EME2000** cartesian direction (unit vector).
    pub type EME2000 = Direction<frames::EME2000>;
    /// **Equatorial mean of date** cartesian direction (unit vector).
    pub type EquatorialMeanOfDate = Direction<frames::EquatorialMeanOfDate>;
    /// **Equatorial true of date** cartesian direction (unit vector).
    pub type EquatorialTrueOfDate = Direction<frames::EquatorialTrueOfDate>;
    /// **Horizontal** cartesian direction (unit vector).
    pub type Horizontal = Direction<frames::Horizontal>;
    /// **Geocentric Earth-fixed (ECEF)** cartesian direction (unit vector).
    ///
    /// For geodetic (lon/lat/h) positions, use [`Geodetic<ECEF>`](crate::coordinates::centers::Geodetic)
    /// instead; this type is for unit vectors in the Earth-fixed frame.
    /// Cartesian unit vector in the **Earth-Centred Earth-Fixed** frame.
    pub type EcefCartDir = Direction<frames::ECEF>;
    /// **ICRS** cartesian direction (unit vector).
    pub type ICRS = Direction<frames::ICRS>;
    /// **ICRF** cartesian direction (unit vector).
    pub type ICRF = Direction<frames::ICRF>;
    /// **FK4 B1950** cartesian direction (unit vector).
    pub type FK4B1950 = Direction<frames::FK4B1950>;
    /// **TEME** cartesian direction (unit vector).
    pub type TEME = Direction<frames::TEME>;
    /// **GCRS** cartesian direction (unit vector).
    pub type GCRSDir = Direction<frames::GCRS>;
    /// **Galactic** cartesian direction (unit vector).
    pub type Galactic = Direction<frames::Galactic>;
}

// =============================================================================
// Displacement type aliases (frame + unit, no center)
// =============================================================================

pub mod displacement {
    use super::frames;
    pub use super::Displacement;

    /// **EclipticMeanJ2000** displacement vector.
    pub type EclipticMeanJ2000<U> = Displacement<frames::EclipticMeanJ2000, U>;
    /// **Equatorial mean J2000** displacement vector.
    pub type EquatorialMeanJ2000<U> = Displacement<frames::EquatorialMeanJ2000, U>;
    /// **EME2000** displacement vector.
    pub type EME2000<U> = Displacement<frames::EME2000, U>;
    /// **Equatorial mean of date** displacement vector.
    pub type EquatorialMeanOfDate<U> = Displacement<frames::EquatorialMeanOfDate, U>;
    /// **Equatorial true of date** displacement vector.
    pub type EquatorialTrueOfDate<U> = Displacement<frames::EquatorialTrueOfDate, U>;
    /// **Horizontal** displacement vector.
    pub type Horizontal<U> = Displacement<frames::Horizontal, U>;
    /// **ICRS** displacement vector.
    pub type ICRS<U> = Displacement<frames::ICRS, U>;
    /// **ICRF** displacement vector.
    pub type ICRF<U> = Displacement<frames::ICRF, U>;
    /// **FK4 B1950** displacement vector.
    pub type FK4B1950<U> = Displacement<frames::FK4B1950, U>;
    /// **TEME** displacement vector.
    pub type TEME<U> = Displacement<frames::TEME, U>;
}

// =============================================================================
// Position type aliases (center + frame + unit)
// =============================================================================

pub mod position {
    pub use super::Position;
    use super::{centers, frames};

    /// **Heliocentric EclipticMeanJ2000** cartesian position.
    pub type EclipticMeanJ2000<U, C = centers::Heliocentric> =
        Position<C, frames::EclipticMeanJ2000, U>;
    /// **Geocentric Equatorial mean J2000** cartesian position.
    pub type EquatorialMeanJ2000<U, C = centers::Geocentric> =
        Position<C, frames::EquatorialMeanJ2000, U>;
    /// **Geocentric EME2000** cartesian position.
    pub type EME2000<U, C = centers::Geocentric> = Position<C, frames::EME2000, U>;
    /// **Geocentric Equatorial mean of date** cartesian position.
    pub type EquatorialMeanOfDate<U, C = centers::Geocentric> =
        Position<C, frames::EquatorialMeanOfDate, U>;
    /// **Geocentric Equatorial true of date** cartesian position.
    pub type EquatorialTrueOfDate<U, C = centers::Geocentric> =
        Position<C, frames::EquatorialTrueOfDate, U>;
    /// **Topocentric Horizontal** cartesian position.
    pub type Horizontal<U, C = centers::Topocentric> = Position<C, frames::Horizontal, U>;
    /// **Geocentric Earth-Centered Earth-Fixed (ECEF)** cartesian position.
    ///
    /// For geodetic (lon/lat/h) positions, use [`Geodetic<ECEF>`](crate::coordinates::centers::Geodetic)
    /// instead; this type is for Cartesian XYZ in the Earth-fixed frame.
    /// The ellipsoid-correct conversion is [`to_cartesian`](affn::ellipsoidal::Position::to_cartesian).
    pub type EcefPos<U, C = centers::Geocentric> = Position<C, frames::ECEF, U>;
    /// **Barycentric ICRS** cartesian position.
    pub type ICRS<U, C = centers::Barycentric> = Position<C, frames::ICRS, U>;
    /// **Heliocentric ICRS** cartesian position.
    pub type HCRS<U> = Position<centers::Heliocentric, frames::ICRS, U>;
    /// **Geocentric ICRS** cartesian position.
    ///
    /// # Approximation
    ///
    /// This alias uses [`frames::ICRS`] as a first-order approximation for
    /// the Geocentric Celestial Reference System ([`frames::GCRS`]). The
    /// difference is < 1 mas for typical astronomical directions (neglected:
    /// geocentre offset, relativistic terms). For strictly IAU-correct GCRS,
    /// use `Position<Geocentric, frames::GCRS, U>` directly.
    pub type GCRS<U> = Position<centers::Geocentric, frames::ICRS, U>;
    /// **Topocentric ICRS** cartesian position.
    pub type TCRS<U> = Position<centers::Topocentric, frames::ICRS, U>;

    /// **Barycentric ICRF** cartesian position (BCRS).
    pub type BCRS<U> = Position<centers::Barycentric, frames::ICRF, U>;

    /// **Heliocentric J2000** equatorial cartesian position.
    pub type HeliocentricJ2000<U> = Position<centers::Heliocentric, frames::EquatorialMeanJ2000, U>;

    /// **Geocentric J2000** equatorial cartesian position (FK5-compatible ECI).
    pub type GeocentricJ2000<U> = Position<centers::Geocentric, frames::EquatorialMeanJ2000, U>;

    /// **Geocentric FK4 B1950** cartesian position.
    pub type FK4B1950<U> = Position<centers::Geocentric, frames::FK4B1950, U>;

    /// **Geocentric TEME** cartesian position (SGP4/TLE).
    pub type TEME<U> = Position<centers::Geocentric, frames::TEME, U>;

    /// **Geocentric ITRF** cartesian position.
    pub type ITRF<U> = Position<centers::Geocentric, frames::ITRF, U>;

    /// **Galactic** barycentric cartesian position.
    pub type Galactic<U> = Position<centers::Barycentric, frames::Galactic, U>;

    // --- Planetocentric body-fixed cartesian positions ---

    /// **Mercurycentric** body-fixed cartesian position.
    pub type MercuryFixed<U> = Position<centers::Mercurycentric, frames::MercuryFixed, U>;
    /// **Venuscentric** body-fixed cartesian position.
    pub type VenusFixed<U> = Position<centers::Venuscentric, frames::VenusFixed, U>;
    /// **Marscentric** body-fixed cartesian position.
    pub type MarsFixed<U> = Position<centers::Marscentric, frames::MarsFixed, U>;
    /// **Selenocentric** cartesian position in Moon principal axes frame.
    pub type MoonPrincipalAxes<U> = Position<centers::Selenocentric, frames::MoonPrincipalAxes, U>;
    /// **Jovicentric** System III cartesian position.
    pub type JupiterSystemIII<U> = Position<centers::Jovicentric, frames::JupiterSystemIII, U>;
    /// **Saturnocentric** body-fixed cartesian position.
    pub type SaturnFixed<U> = Position<centers::Saturnocentric, frames::SaturnFixed, U>;
    /// **Uranocentric** body-fixed cartesian position.
    pub type UranusFixed<U> = Position<centers::Uranocentric, frames::UranusFixed, U>;
    /// **Neptunocentric** body-fixed cartesian position.
    pub type NeptuneFixed<U> = Position<centers::Neptunocentric, frames::NeptuneFixed, U>;
    /// **Plutocentric** body-fixed cartesian position.
    pub type PlutoFixed<U> = Position<centers::Plutocentric, frames::PlutoFixed, U>;
}

// =============================================================================
// Velocity type aliases (frame + unit, no center)
// =============================================================================

pub mod velocity {
    use super::frames;
    pub use super::Velocity;

    /// **EclipticMeanJ2000** cartesian velocity vector.
    pub type EclipticMeanJ2000<U> = Velocity<frames::EclipticMeanJ2000, U>;
    /// **Equatorial mean J2000** cartesian velocity vector.
    pub type EquatorialMeanJ2000<U> = Velocity<frames::EquatorialMeanJ2000, U>;
    /// **EME2000** cartesian velocity vector.
    pub type EME2000<U> = Velocity<frames::EME2000, U>;
    /// **Equatorial mean of date** cartesian velocity vector.
    pub type EquatorialMeanOfDate<U> = Velocity<frames::EquatorialMeanOfDate, U>;
    /// **Equatorial true of date** cartesian velocity vector.
    pub type EquatorialTrueOfDate<U> = Velocity<frames::EquatorialTrueOfDate, U>;
    /// **Horizontal** cartesian velocity vector.
    pub type Horizontal<U> = Velocity<frames::Horizontal, U>;
    /// **ICRS** cartesian velocity vector.
    pub type ICRS<U> = Velocity<frames::ICRS, U>;
    /// **ICRF** cartesian velocity vector.
    pub type ICRF<U> = Velocity<frames::ICRF, U>;
    /// **TEME** cartesian velocity vector.
    pub type TEME<U> = Velocity<frames::TEME, U>;
    /// **FK4 B1950** cartesian velocity vector.
    pub type FK4B1950<U> = Velocity<frames::FK4B1950, U>;
}