Struct nyx_space::cosmic::Cosm

pub struct Cosm {
    pub xb: Xb,
    pub frame_root: FrameTree,
    /* private fields */
}

Fields

xb: Xb

frame_root: FrameTree

Implementations

impl Cosm

pub fn from_xb(filename: &str) -> Result<Self, NyxError>

Builds a Cosm from the *XB files. Path should not contain file extension. Panics if the files could not be loaded.

pub fn try_de438() -> Result<Self, NyxError>

Tries to load a subset of the DE438 XB from the embedded files, bounded between 01 Jan 2000 and 31 Dec 2050 TDB.

pub fn de438() -> Arc<Self>

Load a subset of the DE438 XB from the embedded files, bounded between 01 Jan 2000 and 31 Dec 2050 TAI.

pub fn de438_raw() -> Self

Load a subset of the DE438 XB from the embedded files, bounded between 01 Jan 2000 and 31 Dec 2050 TAI.

pub fn de438_gmat() -> Arc<Self>

Load a subset of the DE438 XB from the embedded files, bounded between 01 Jan 2000 and 31 Dec 2050 TAI.

pub fn try_from_xb(xb: Xb) -> Result<Self, NyxError>

Attempts to build a Cosm from the XB files and the embedded IAU frames

pub fn use_gmat_gm(&mut self)

Switch the GM values to those from GMAT

pub fn load_iau_frames(&mut self) -> Result<(), NyxError>

Load the IAU Frames as defined in Celest Mech Dyn Astr (2018) 130:22 (https://doi.org/10.1007/s10569-017-9805-5)

pub fn frame_find_path_for_orientation( &self, name: &str ) -> Result<Vec<usize>, NyxError>

Returns the machine path of the ephemeris whose orientation is requested

pub fn append_xb(&mut self)

pub fn append_frames(&mut self, toml_content: &str) -> Result<(), NyxError>

Append Cosm with the contents of this TOML (must not be the filename)

pub fn try_frame(&self, name: &str) -> Result<Frame, NyxError>

Fetch the frame associated with this ephemeris name This is slow, so avoid using it.

pub fn frame_from_ephem_path(&self, ephem_path: &[usize]) -> Frame

Provided an ephemeris path and an optional frame name, returns the Frame of that ephemeris. For example, if [3, 1] is provided (Moon in J2000 in the DE file), return Moon J2000 If no frame name is provided, then the storage frame is returned. Otherwise, the correct frame is returned.

pub fn frame_from_frame_path(&self, frame_path: &[usize]) -> Frame

Provided a frame path returns the Frame.

pub fn frames_get_names(&self) -> Vec<String>

pub fn frames_get(&self) -> Vec<Frame>

Returns all of the frames defined in this Cosm

pub fn frame(&self, name: &str) -> Frame

Returns the geoid from the loaded XB, if it is in there, else panics!

pub fn frame_mut_gm(&mut self, name: &str, new_gm: f64)

Mutates the GM value for the provided geoid id. Panics if ID not found.

pub fn raw_celestial_state( &self, path: &[usize], epoch: Epoch ) -> Result<Orbit, NyxError>

Returns the celestial state as computed from a de4xx.{FXB,XB} file in the original frame

pub fn try_celestial_state( &self, target_ephem: &[usize], datetime: Epoch, frame: Frame, correction: LightTimeCalc ) -> Result<Orbit, NyxError>

Attempts to return the state of the celestial object at the provided time

The light time correction is based on SPICE’s implementation: https://naif.jpl.nasa.gov/pub/naif/toolkit_docs/C/cspice/spkezr_c.html . Aberration computation is a conversion of the stelab function in SPICE, available here https://github.com/ChristopherRabotin/cspice/blob/26c72936fb7ff6f366803a1419b7cc3c61e0b6e5/src/cspice/stelab.c#L255

pub fn celestial_state( &self, target_ephem: &[usize], datetime: Epoch, frame: Frame, correction: LightTimeCalc ) -> Orbit

Returns the state of the celestial object (target ephem) as seen in the requested frame at the provided time

pub fn try_position_dcm_from_to( &self, from: &Frame, to: &Frame, dt: Epoch ) -> Result<Matrix3<f64>, NyxError>

Return the position DCM (3x3) to go from the from frame to the to frame

pub fn try_dcm_from_to( &self, from: &Frame, to: &Frame, dt: Epoch ) -> Result<Matrix6<f64>, NyxError>

Return the position and velocity DCM (6x6) to go from the from frame to the to frame

pub fn try_dcm_from_to_in_parts( &self, from: &Frame, to: &Frame, dt: Epoch ) -> Result<(Matrix3<f64>, Matrix3<f64>), NyxError>

Return the position and velocity DCM (two 3x3 matrices) to go from the from frame to the to frame

pub fn try_frame_translation( &self, state: &Orbit, new_frame: Frame ) -> Result<Orbit, NyxError>

Attempts to only perform a translation without rotation between two frames. You really shouldn’t be using this unless you know exactly what you’re doing. Typically, you want to use try_frame_chg. WARNING: This will update the Frame of the Orbit to the requested one EVEN IF it doesn’t rotate it.

pub fn try_frame_chg( &self, state: &Orbit, new_frame: Frame ) -> Result<Orbit, NyxError>

Attempts to return the provided state in the provided frame.

pub fn frame_chg(&self, state: &Orbit, new_frame: Frame) -> Orbit

Return the provided state in the provided frame, or panics

Trait Implementations

impl Debug for Cosm

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Cosm

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.