satkit 0.18.0

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

//! Errors produced by the `frametransform` module.

use std::num::{ParseFloatError, ParseIntError};

use thiserror::Error;

use super::ierstable::IersTableId;
use crate::Frame;

/// Errors produced by the
/// [`frametransform`](crate::frametransform) module.
#[derive(Debug, Error)]
pub enum Error {
    /// [`to_gcrf`](super::to_gcrf) and [`from_gcrf`](super::from_gcrf)
    /// only build rotation matrices for satellite-local orbital frames
    /// (`GCRF`, `LVLH`, `RTN`, `NTW`). Time-dependent inertial /
    /// Earth-fixed frames must use the dedicated quaternion helpers
    /// ([`qitrf2gcrf`](super::qitrf2gcrf),
    /// [`qteme2gcrf`](super::qteme2gcrf), …).
    #[error(
        "to_gcrf: frame {frame} is not a satellite-local orbital frame; use the \
         time-based quaternion helpers (qitrf2gcrf, qteme2gcrf, etc.) instead"
    )]
    UnsupportedFrame { frame: Frame },

    /// [`rotation`](super::rotation) and friends do not handle the
    /// orbit-dependent frames ([`Frame::LVLH`], [`Frame::RTN`],
    /// [`Frame::NTW`]) — they require the satellite's position and velocity
    /// to define their axes. Use [`to_gcrf`](super::to_gcrf) /
    /// [`from_gcrf`](super::from_gcrf) for those.
    #[error(
        "rotation: frame pair ({from}, {to}) involves an orbit-dependent frame; \
         use to_gcrf / from_gcrf with pos and vel"
    )]
    OrbitFrameRequiresState { from: Frame, to: Frame },

    /// [`rotation_approx`](super::rotation_approx) is only valid between
    /// ITRF and the inertial cluster (GCRF, EME2000, ICRF, TEME). The
    /// intermediate frames [`Frame::TIRS`] and [`Frame::CIRS`] are defined
    /// by the IERS 2010 reduction and have no FK5 analogue.
    #[error(
        "rotation_approx: frame {frame} has no FK5 approximate-reduction \
         analogue; use rotation() for full IERS 2010"
    )]
    ApproxNotSupportedForFrame { frame: Frame },

    /// A `j = N` table-definition line in an IERS table file is
    /// malformed.
    #[error("Error parsing file {fname}, invalid table definition line")]
    InvalidIersTableDef { fname: String },

    /// Encountered a coefficient row in an IERS table file before any
    /// table dimension was declared.
    #[error("Error parsing file {fname}, table not initialized")]
    IersTableNotInitialized { fname: String },

    /// Bytes passed to [`IERSTable::from_bytes`](super::ierstable::IERSTable::from_bytes)
    /// or [`init_from_bytes`](super::ierstable::init_from_bytes) were not
    /// valid UTF-8 — the IERS table file is a text format.
    #[error("IERS table byte buffer is not valid UTF-8: {0}")]
    Utf8(#[from] std::str::Utf8Error),

    /// Returned by [`init_from_bytes`](super::ierstable::init_from_bytes) /
    /// [`init_from_path`](super::ierstable::init_from_path) when the IERS
    /// table singleton identified by `id` has already been initialized.
    #[error("IERS table singleton {id:?} is already initialized")]
    IersTableAlreadyInitialized { id: IersTableId },

    #[error(transparent)]
    Io(#[from] std::io::Error),

    #[error(transparent)]
    ParseInt(#[from] ParseIntError),

    #[error(transparent)]
    ParseFloat(#[from] ParseFloatError),

    #[error(transparent)]
    Datadir(#[from] crate::utils::datadir::Error),

    #[error(transparent)]
    Download(#[from] crate::utils::download::Error),
}

/// Convenient type alias used throughout the `frametransform` module.
pub type Result<T> = std::result::Result<T, Error>;