Merge pull request #496 from nyx-space/feat/spk-type1-modified-diff

Implement SPK Type 01 Modified Differences

Author: ChristopherRabotin

.cargo/config.toml

@@ -1,2 +1,7 @@
 [env]
 CSPICE_DIR = {value = "./cspice/", relative = true}
+
+# [target.x86_64-unknown-linux-gnu]
+# For flamegraph -- https://github.com/flamegraph-rs/flamegraph
+# linker = "/usr/bin/clang"
+# rustflags = ["-Clink-arg=-fuse-ld=lld", "-Clink-arg=-Wl,--no-rosegment"]

.github/workflows/python.yml

@@ -46,6 +46,7 @@ jobs:
             # Source: https://github.com/sfackler/rust-openssl/issues/2036#issuecomment-1724324145
             # If we're running on rhel centos, install needed packages.
             if command -v yum &> /dev/null; then
+                echo "CENTOS"
                 yum update -y && yum install -y perl-core openssl openssl-devel pkgconfig libatomic
 
                 # If we're running on i686 we need to symlink libatomic
@@ -55,6 +56,7 @@ jobs:
                 fi
             else
                 # If we're running on debian-based system.
+                echo "DEBIAN LIKE"
                 apt update -y && apt-get install -y libssl-dev openssl pkg-config
             fi
 

.github/workflows/rust.yml

@@ -54,6 +54,7 @@ jobs:
           wget -O data/variable-seg-size-hermite.bsp http://public-data.nyxspace.com/anise/ci/variable-seg-size-hermite.bsp
           wget -O data/earth_latest_high_prec.bpc http://public-data.nyxspace.com/anise/ci/earth_latest_high_prec-2023-09-08.bpc
           wget -O data/lro.bsp http://public-data.nyxspace.com/nyx/examples/lrorg_2023349_2024075_v01_LE.bsp
+          wget -O data/mro.bsp https://naif.jpl.nasa.gov/pub/naif/MRO/kernels/spk/spk_psp_rec89118_89113_89888_p-v1.bsp
 
       - name: Install stable toolchain
         uses: dtolnay/rust-toolchain@stable
@@ -119,6 +120,7 @@ jobs:
           wget -O data/variable-seg-size-hermite.bsp http://public-data.nyxspace.com/anise/ci/variable-seg-size-hermite.bsp
           wget -O data/earth_latest_high_prec.bpc http://public-data.nyxspace.com/anise/ci/earth_latest_high_prec-2023-09-08.bpc
           wget -O data/lro.bsp http://public-data.nyxspace.com/nyx/examples/lrorg_2023349_2024075_v01_LE.bsp
+          wget -O data/mro.bsp https://naif.jpl.nasa.gov/pub/naif/MRO/kernels/spk/spk_psp_rec89118_89113_89888_p-v1.bsp
 
       - name: Install stable toolchain
         uses: dtolnay/rust-toolchain@stable
@@ -146,6 +148,9 @@ jobs:
           LAGRANGE_BSP: gmat-lagrange.bsp
         run: RUST_BACKTRACE=1 cargo test validate_lagrange_type9_with_varying_segment_sizes --features validation --release --workspace --exclude anise-gui --exclude anise-py -- --nocapture --include-ignored --test-threads 1
 
+      - name: Rust-SPICE Modified Difference validation
+        run: RUST_BACKTRACE=1 cargo test validate_modified_diff_type01 --features validation --release --workspace --exclude anise-gui --exclude anise-py -- --nocapture --include-ignored --test-threads 1
+
       - name: Rust-SPICE PCK validation
         run: RUST_BACKTRACE=1 cargo test validate_iau_rotation_to_parent --release --workspace --exclude anise-gui --exclude anise-py -- --nocapture --ignored
 
@@ -195,6 +200,7 @@ jobs:
           wget -O data/lro.bsp http://public-data.nyxspace.com/nyx/examples/lrorg_2023349_2024075_v01_LE.bsp
           wget -O data/moon_fk_de440.epa http://public-data.nyxspace.com/anise/v0.5/moon_fk_de440.epa
           wget -O data/moon_pa_de440_200625.bpc http://public-data.nyxspace.com/anise/moon_pa_de440_200625.bpc
+          wget -O data/mro.bsp https://naif.jpl.nasa.gov/pub/naif/MRO/kernels/spk/spk_psp_rec89118_89113_89888_p-v1.bsp 
 
       - name: Install stable toolchain
         uses: dtolnay/rust-toolchain@stable
@@ -224,6 +230,7 @@ jobs:
           cargo llvm-cov test --no-report validate_jplde_de440_type3_no_aberration --features validation -- --nocapture --ignored
           cargo llvm-cov test --no-report validate_hermite_type13_from_gmat --features validation -- --nocapture --ignored
           cargo llvm-cov test --no-report validate_lagrange_type9_with_varying_segment_sizes --features validation -- --nocapture --ignored
+          cargo llvm-cov test --no-report validate_modified_diff_type01 --features validation -- --nocapture --ignored
           cargo llvm-cov test --no-report ut_embed --features embed_ephem
           cargo llvm-cov report --lcov > ../lcov.txt
 

.gitignore

@@ -13,4 +13,5 @@ cspice.tar.Z
 *.epa
 anise-gui/dist/
 anise-py/notebooks/.ipynb_checkpoints/ANISE Tutorial for querying SPK files-checkpoint.ipynb
-data/lro.bsp
+data/lro.bsp
+data/mro.bsp

anise/src/ephemerides/translate_to_parent.rs

@@ -17,6 +17,7 @@ use crate::ephemerides::EphemInterpolationSnafu;
 use crate::hifitime::Epoch;
 use crate::math::cartesian::CartesianState;
 use crate::math::Vector3;
+use crate::naif::daf::datatypes::modified_diff::ModifiedDiffType1;
 use crate::naif::daf::datatypes::{
     HermiteSetType13, LagrangeSetType9, Type2ChebyshevSet, Type3ChebyshevSet,
 };
@@ -56,6 +57,16 @@ impl Almanac {
         // Now let's simply evaluate the data
 
         let (pos_km, vel_km_s) = match summary.data_type()? {
+            DafDataType::Type1ModifiedDifferenceArray => {
+                let data =
+                    spk_data
+                        .nth_data::<ModifiedDiffType1>(idx_in_spk)
+                        .context(SPKSnafu {
+                            action: "fetching data for interpolation",
+                        })?;
+                data.evaluate(epoch, summary)
+                    .context(EphemInterpolationSnafu)?
+            }
             DafDataType::Type2ChebyshevTriplet => {
                 let data =
                     spk_data

anise/src/naif/daf/datatypes/hermite.rs

@@ -160,8 +160,8 @@ impl fmt::Display for HermiteSetType13<'_> {
         write!(
             f,
             "Hermite Type 13 from {:E} to {:E} with degree {} ({} items, {} epoch directories)",
-            Epoch::from_et_seconds(*self.epoch_data.first().unwrap()),
-            Epoch::from_et_seconds(*self.epoch_data.last().unwrap()),
+            Epoch::from_et_seconds(*self.epoch_data.first().unwrap_or(&0.0)),
+            Epoch::from_et_seconds(*self.epoch_data.last().unwrap_or(&0.0)),
             self.degree(),
             self.epoch_data.len(),
             self.epoch_registry.len()
@@ -268,11 +268,7 @@ impl<'a> NAIFDataSet<'a> for HermiteSetType13<'a> {
     ) -> Result<Self::StateKind, InterpolationError> {
         // Start by doing a binary search on the epoch registry to limit the search space in the total number of epochs.
         if self.epoch_data.is_empty() {
-            return Err(InterpolationError::NoInterpolationData {
-                req: epoch,
-                start: Epoch::from_et_seconds(self.epoch_data[0]),
-                end: Epoch::from_et_seconds(*self.epoch_data.last().unwrap()),
-            });
+            return Err(InterpolationError::MissingInterpolationData { epoch });
         }
         // Check that we even have interpolation data for that time
         if epoch.to_et_seconds() < self.epoch_data[0] - 1e-7

anise/src/naif/daf/datatypes/lagrange.rs

@@ -215,6 +215,9 @@ impl<'a> NAIFDataSet<'a> for LagrangeSetType9<'a> {
         // Start by doing a binary search on the epoch registry to limit the search space in the total number of epochs.
         // TODO: use the epoch registry to reduce the search space
         // Check that we even have interpolation data for that time
+        if self.epoch_data.is_empty() {
+            return Err(InterpolationError::MissingInterpolationData { epoch });
+        }
         if epoch.to_et_seconds() < self.epoch_data[0] - 1e-7
             || epoch.to_et_seconds() > *self.epoch_data.last().unwrap() + 1e-7
         {

anise/src/naif/daf/datatypes/mod.rs

@@ -12,6 +12,7 @@ pub mod chebyshev;
 pub mod chebyshev3;
 pub mod hermite;
 pub mod lagrange;
+pub mod modified_diff;
 pub mod posvel;
 
 pub use chebyshev::*;