Dep/hifitime (#345)

gwbres · web-flow · commit 61dc7d4b74fd · 2025-04-20T15:09:18.000+02:00
* update deps
* Improved SBAS formatting
* Improved header processing
* Improved docs
* Fixed SBAS formatting &amp; compression
* dep/hifitime integration for testing

---------

Signed-off-by: Guillaume W. Bres &lt;guillaume.bressaix@gmail.com&gt;
diff --git a/Cargo.toml b/Cargo.toml
@@ -135,20 +135,21 @@ bitflags = { version = "2.3", features = ["serde"] }
 serde = { version = "1.0", optional = true, default-features = false, features = ["derive"] }
 
 geo = { version = "0.28", optional = true }
-wkt = { version = "0.10.0", default-features = false, optional = true }
 flate2 = { version = "1", optional = true }
+wkt = { version = "0.10.0", default-features = false, optional = true }
 
-anise = { version = "0.5.3", optional = true }
 nalgebra = { version = "0.33.0", optional = true }
-hifitime = { version = "4.0.0", features = ["serde", "std"] }
-gnss-rs = { version = "2.3.5", features = ["serde", "domes", "cospar"] }
 
+anise = { git = "https://github.com/nyx-space/anise", branch = "dep/hifitime-github", optional = true }
+hifitime = { git = "https://github.com/nyx-space/hifitime", branch = "master", features = ["serde", "std"] }
+
+gnss-rs = { git = "https://github.com/rtk-rs/gnss", branch = "main", features = ["serde", "domes", "cospar"] }
 gnss-qc-traits = { git = "https://github.com/rtk-rs/qc-traits", branch = "main", features = ["html"], optional = true }
 
 maud = { version = "0.26", optional = true }
 
 # BINEX
-binex = { version = "0.4.2", optional = true }
+binex = { git = "https://github.com/rtk-rs/binex", branch = "main", optional = true }
 
 # RTCM
 rtcm-rs = { version = "0.11", optional = true }
diff --git a/src/hatanaka/compressor.rs b/src/hatanaka/compressor.rs
@@ -5,7 +5,7 @@ use crate::{
     error::FormattingError,
     hatanaka::{NumDiff, TextDiff},
     observation::{HeaderFields, Record},
-    prelude::{Observable, SV},
+    prelude::{Constellation, Observable, SV},
     BufWriter,
 };
 
@@ -147,12 +147,30 @@ impl<const M: usize> CompressorExpert<M> {
             // For each SV
             for sv in svnn.iter() {
                 // Following header specs
-                let observables = header
-                    .codes
-                    .get(&sv.constellation)
-                    .ok_or(FormattingError::MissingObservableDefinition)?;
+                let sv_observables = header.codes.get(&sv.constellation);
+
+                let sv_observables = match sv_observables {
+                    Some(observables) => observables, // correctly identified,
+                    None => {
+                        // handles SBAS case
+                        if sv.constellation.is_sbas() {
+                            match header.codes.get(&Constellation::SBAS) {
+                                Some(observables) => observables,
+                                None => {
+                                    // correctly formatted RINEX will never
+                                    // end up here
+                                    continue;
+                                },
+                            }
+                        } else {
+                            // correctly formatted RINEX will never
+                            // end up here
+                            continue;
+                        }
+                    },
+                };
 
-                for observable in observables.iter() {
+                for observable in sv_observables.iter() {
                     if let Some(signal) = v
                         .signals
                         .iter()
diff --git a/src/hatanaka/decompressor/mod.rs b/src/hatanaka/decompressor/mod.rs
@@ -859,7 +859,12 @@ impl<const M: usize> DecompressorExpert<M> {
         if let Some(mixed) = self.gnss_observables.get(&Constellation::Mixed) {
             Some(mixed)
         } else {
-            self.gnss_observables.get(constell)
+            // SBAS special case
+            if constell.is_sbas() {
+                self.gnss_observables.get(&Constellation::SBAS)
+            } else {
+                self.gnss_observables.get(constell)
+            }
         }
     }
 
diff --git a/src/header/processing.rs b/src/header/processing.rs
@@ -9,8 +9,12 @@ fn header_mask_eq(hd: &mut Header, item: &FilterItem) {
             hd.pcv_compensations
                 .retain(|pcv| constellations.contains(&pcv.constellation));
 
+            if constellations.len() == 1 {
+                hd.constellation = Some(constellations[0]);
+            }
+
             if !constellations.contains(&Constellation::Glonass) {
-                // remove glonass specs
+                // remove glonass specs in case it is no longer contained
                 hd.glo_channels.clear();
             }
         },
diff --git a/src/lib.rs b/src/lib.rs
@@ -1076,7 +1076,7 @@ impl Rinex {
         }
     }
 
-    /// Returns [SV] iterator.
+    /// Returns a [SV] iterator, from all satellites encountered in this [Rinex].
     pub fn sv_iter(&self) -> Box<dyn Iterator<Item = SV> + '_> {
         if self.is_observation_rinex() {
             Box::new(
diff --git a/src/observation/formatting.rs b/src/observation/formatting.rs
@@ -36,7 +36,7 @@ impl Observations {
         }
     }
 
-    /// Format [Observations] according to V2 RINEX format
+    /// Formats [Observations] according to RINEXv2 standards.
     fn format_v2<W: Write>(
         &self,
         w: &mut BufWriter<W>,
@@ -53,22 +53,29 @@ impl Observations {
         self.format_epoch_v2(w, key, sv_list, numsat)?;
 
         for sv in sv_list.iter() {
-            // V2 is too badly specified to permit correct SBAS handling
-            let observables = if sv.constellation.is_sbas() {
-                observables.get(&Constellation::SBAS)
-            } else {
-                observables.get(&sv.constellation)
-            };
-
-            let observables = match observables {
-                Some(observables) => observables, // correctly identified
-                None => continue,                 // abort
+            let sv_observables = observables.get(&sv.constellation);
+
+            let sv_observables = match sv_observables {
+                Some(sv_observables) => sv_observables, // correctly identified
+                None => {
+                    // handles SBAS case
+                    if sv.constellation.is_sbas() {
+                        match observables.get(&Constellation::SBAS) {
+                            Some(sv_observables) => sv_observables,
+                            _ => continue, // abort
+                        }
+                    } else {
+                        // abort: normally formatted RINEX
+                        // will never end up here
+                        continue;
+                    }
+                },
             };
 
             let mut modulo = 0;
 
             // following header specs (strictly)
-            for (nth, observable) in observables.iter().enumerate() {
+            for (nth, observable) in sv_observables.iter().enumerate() {
                 // retrieve observed signal (if any)
                 if let Some(observation) = self
                     .signals
@@ -153,6 +160,7 @@ impl Observations {
         Ok(())
     }
 
+    /// Formats [Observations] according to RINEXv3 standards.
     fn format_v3<W: Write>(
         &self,
         w: &mut BufWriter<W>,
@@ -183,14 +191,26 @@ impl Observations {
                 write!(w, "{:x}", sv)?;
 
                 // following header definitions
-                let observables = observables.get(&sv.constellation);
+                let sv_observables = observables.get(&sv.constellation);
 
-                let observables = match observables {
+                let sv_observables = match sv_observables {
                     Some(observables) => observables, // correctly identified
-                    None => continue,                 // abort
+                    None => {
+                        // handles SBAS case
+                        if sv.constellation.is_sbas() {
+                            match observables.get(&Constellation::SBAS) {
+                                Some(sv_observables) => sv_observables,
+                                _ => continue, // abort
+                            }
+                        } else {
+                            // abort: normally formatted RINEX
+                            // will never end up here
+                            continue;
+                        }
+                    },
                 };
 
-                for observable in observables.iter() {
+                for observable in sv_observables.iter() {
                     if let Some(observation) = self
                         .signals
                         .iter()
diff --git a/src/tests/mod.rs b/src/tests/mod.rs
@@ -8,6 +8,9 @@ mod filename;
 pub mod formatting;
 mod parsing;
 
+#[cfg(feature = "flate2")]
+mod sbas;
+
 #[cfg(feature = "flate2")]
 mod production;
 
diff --git a/src/tests/sbas.rs b/src/tests/sbas.rs
@@ -0,0 +1,83 @@
+// SBAS specific tests
+use crate::prelude::{Constellation, Rinex, SV};
+use qc_traits::{Filter, FilterItem, MaskOperand, Preprocessing};
+use std::str::FromStr;
+
+// Formatting issue
+#[test]
+#[cfg(feature = "flate2")]
+fn test_sbas_obs_v3_formatting() {
+    let rinex =
+        Rinex::from_gzip_file("data/CRNX/V3/ESBC00DNK_R_20201770000_01D_30S_MO.crx.gz").unwrap();
+
+    // basic initial verifications..
+    let (mut s23_found, mut s25_found, mut s36_found) = (false, false, false);
+    let s23 = SV::from_str("S23").unwrap();
+    let s25 = SV::from_str("S25").unwrap();
+    let s36 = SV::from_str("S36").unwrap();
+
+    for sv in rinex.sv_iter() {
+        s23_found |= sv == s23;
+        s25_found |= sv == s25;
+        s36_found |= sv == s36;
+    }
+
+    assert!(s23_found, "S23 not present in initial setup!");
+    assert!(s25_found, "S25 not present in initial setup!");
+    assert!(s36_found, "S36 not present in initial setup!");
+
+    let geo_only = Filter::mask(
+        MaskOperand::Equals,
+        FilterItem::ConstellationItem(vec![Constellation::SBAS]),
+    );
+
+    let mut geo_only = rinex.filter(&geo_only);
+
+    // RINEX
+    let rinex_geo_only = geo_only.crnx2rnx();
+
+    // dump
+    rinex_geo_only
+        .to_file("test_geo-only.txt")
+        .unwrap_or_else(|e| panic!("SBAS only formatting issue: {}", e));
+
+    // parse back
+    let dut = Rinex::from_file("test_geo-only.txt")
+        .unwrap_or_else(|e| panic!("SABS only: failed to parse back: {}", e));
+
+    // test
+    let (mut s23_found, mut s25_found, mut s36_found) = (false, false, false);
+    for sv in dut.sv_iter() {
+        s23_found |= sv == s23;
+        s25_found |= sv == s25;
+        s36_found |= sv == s36;
+    }
+
+    assert!(s23_found, "S23 not present in parsed-back RINEX!");
+    assert!(s25_found, "S25 not present in parsed-back RINEX!");
+    assert!(s36_found, "S36 not present in parsed-back RINEX!");
+
+    // CRINEX dump
+    geo_only
+        .to_file("test_geo-only.txt")
+        .unwrap_or_else(|e| panic!("SBAS only CRINEX formatting issue: {}", e));
+
+    // parse back
+    let dut = Rinex::from_file("test_geo-only.txt")
+        .unwrap_or_else(|e| panic!("SABS only: failed to parse back: {}", e));
+
+    // test
+    let (mut s23_found, mut s25_found, mut s36_found) = (false, false, false);
+    for sv in dut.sv_iter() {
+        s23_found |= sv == s23;
+        s25_found |= sv == s25;
+        s36_found |= sv == s36;
+    }
+
+    assert!(s23_found, "S23 not present in parsed-back RINEX!");
+    assert!(s25_found, "S25 not present in parsed-back RINEX!");
+    assert!(s36_found, "S36 not present in parsed-back RINEX!");
+
+    // delete
+    let _ = std::fs::remove_file("test_geo-only.txt");
+}

Original file line number	Diff line number	Diff line change
`@@ -859,7 +859,12 @@ impl<const M: usize> DecompressorExpert<M> {`
`859`	`859`	`if let Some(mixed) = self.gnss_observables.get(&Constellation::Mixed) {`
`860`	`860`	`Some(mixed)`
`861`	`861`	`} else {`
`862`		`- self.gnss_observables.get(constell)`
	`862`	`+ // SBAS special case`
	`863`	`+ if constell.is_sbas() {`
	`864`	`+ self.gnss_observables.get(&Constellation::SBAS)`
	`865`	`+ } else {`
	`866`	`+ self.gnss_observables.get(constell)`
	`867`	`+ }`
`863`	`868`	`}`
`864`	`869`	`}`
`865`	`870`
Original file line number	Diff line number	Diff line change
`@@ -1076,7 +1076,7 @@ impl Rinex {`
`1076`	`1076`	`}`
`1077`	`1077`	`}`
`1078`	`1078`
`1079`		`- /// Returns [SV] iterator.`
	`1079`	`+ /// Returns a [SV] iterator, from all satellites encountered in this [Rinex].`
`1080`	`1080`	`pub fn sv_iter(&self) -> Box<dyn Iterator<Item = SV> + '_> {`
`1081`	`1081`	`if self.is_observation_rinex() {`
`1082`	`1082`	`Box::new(`