Timeshift implementation and new transposition methods (#340)

* Implement new Timeshift trait
* make error module public
* proposing timeshift implementations
* Add MSRV job
* flate2 by default
* Add MSRV badge

---------

Signed-off-by: Guillaume W. Bres <[email protected]>

Author: gwbres

.github/workflows/benchmarks.yml

@@ -34,10 +34,11 @@ jobs:
           submodules: recursive
           fetch-depth: 0
 
-      - name: Install stable toolchain
+      - name: Install Rust
         uses: dtolnay/rust-toolchain@master
         with:
-          toolchain: stable
+          toolchain: 1.81.0
+          override: true
 
       - name: Bench
         run: cargo bench --bench ${{ matrix.bench }} -- --sample-size ${{ matrix.sample_size }}  > ${{ matrix.bench }}.txt

.github/workflows/daily.yml

@@ -22,7 +22,7 @@ jobs:
     - uses: actions-rs/toolchain@v1
       name: Install Rust
       with:
-        toolchain: stable
+        toolchain: 1.81.0
         override: true
 
     - uses: actions-rs/cargo@v1

.github/workflows/rust.yml

@@ -33,7 +33,7 @@ jobs:
     - uses: actions-rs/toolchain@v1
       name: Install Rust
       with:
-        toolchain: stable
+        toolchain: 1.81.0
         override: true
 
     - uses: actions-rs/cargo@v1

Cargo.toml

@@ -10,11 +10,17 @@ keywords = ["geo", "gnss", "gps", "galileo"]
 categories = ["science", "science::geo", "parsing"]
 edition = "2021"
 readme = "README.md"
-rust-version = "1.64"
 exclude = [
     "data/*",
 ]
 
+[package.metadata]
+msrv = "1.81"
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docrs", "--generate-link-to-definition"]
+
 #####################################################################
 # To understand the lib features, please read the following comments.
 # 
@@ -35,7 +41,7 @@ exclude = [
 ################################################################
 
 [features]
-default = []
+default = ["flate2"] # gzip files supported by default
 
 # OBSERVATION RINEX Iterators & methods. Unlocks signal combinations.
 obs = []
@@ -105,10 +111,6 @@ full = [
     "rtcm",
 ]
 
-[package.metadata.docs.rs]
-all-features = true
-rustdoc-args = ["--cfg", "docrs", "--generate-link-to-definition"]
-
 [build-dependencies]
 serde_json = { version = "1.0", features = ["preserve_order"] }
 serde = { version = "1.0", default-features = false, features = ["derive"] }
@@ -140,7 +142,8 @@ 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"] }
-gnss-qc-traits = { version = "0.1.1", features = ["html"], optional = true }
+
+gnss-qc-traits = { git = "https://github.com/rtk-rs/qc-traits", branch = "main", features = ["html"], optional = true }
 
 maud = { version = "0.26", optional = true }
 

README.md

@@ -6,6 +6,7 @@ RINEX
 [![crates.io](https://docs.rs/rinex/badge.svg)](https://docs.rs/rinex/)
 [![crates.io](https://img.shields.io/crates/d/rinex.svg)](https://crates.io/crates/rinex)
 
+[![MRSV](https://img.shields.io/badge/MSRV-1.81.0-orange?style=for-the-badge)](https://github.com/rust-lang/rust/releases/tag/1.81.0)
 [![License](https://img.shields.io/badge/license-MPL_2.0-orange?style=for-the-badge&logo=mozilla)](https://github.com/rtk-rs/rinex/blob/main/LICENSE)
 
 [RINEX (Receiver Independent EXchange)](https://en.wikipedia.org/wiki/RINEX) parser and formatter.   

src/lib.rs

@@ -31,6 +31,7 @@ pub mod antex;
 pub mod carrier;
 pub mod clock;
 pub mod doris;
+pub mod error;
 pub mod hardware;
 pub mod hatanaka;
 pub mod header;
@@ -47,7 +48,6 @@ pub mod version;
 mod bibliography;
 mod constants;
 mod epoch;
-mod error;
 mod iterators;
 mod leap;
 mod linspace;
@@ -190,7 +190,8 @@ pub mod prelude {
     #[cfg_attr(docsrs, doc(cfg(feature = "processing")))]
     pub mod processing {
         pub use qc_traits::{
-            Decimate, DecimationFilter, Filter, MaskFilter, Masking, Preprocessing, Split,
+            Decimate, DecimationFilter, Filter, GnssAbsoluteTime, MaskFilter, Masking,
+            Preprocessing, Split, Timeshift,
         };
     }
 

src/processing/mod.rs

@@ -5,5 +5,6 @@ use crate::prelude::Rinex;
 mod decim;
 mod repair;
 mod split;
+mod timeshift;
 
 impl Preprocessing for Rinex {}

src/processing/timeshift.rs

@@ -0,0 +1,69 @@
+use crate::{
+    observation::{ObsKey, Observations},
+    prelude::{Header, Rinex, TimeScale},
+};
+
+use qc_traits::{GnssAbsoluteTime, Timeshift};
+
+use std::collections::BTreeMap;
+
+impl Timeshift for Header {
+    fn timeshift(&self, solver: &GnssAbsoluteTime, target: TimeScale) -> Self
+    where
+        Self: Sized,
+    {
+        let mut s = self.clone();
+        s.timeshift_mut(solver, target);
+        s
+    }
+
+    fn timeshift_mut(&mut self, solver: &GnssAbsoluteTime, target: TimeScale) {
+        if let Some(obs) = &mut self.obs {
+            if let Some(epoch) = &mut obs.timeof_first_obs {
+                if let Some(converted) = solver.epoch_time_correction(*epoch, target) {
+                    *epoch = converted;
+                } else {
+                    obs.timeof_first_obs = None;
+                }
+            }
+
+            if let Some(epoch) = &mut obs.timeof_last_obs {
+                if let Some(converted) = solver.epoch_time_correction(*epoch, target) {
+                    *epoch = converted;
+                } else {
+                    obs.timeof_last_obs = None;
+                }
+            }
+        }
+    }
+}
+
+impl Timeshift for Rinex {
+    fn timeshift(&self, solver: &GnssAbsoluteTime, target: TimeScale) -> Self
+    where
+        Self: Sized,
+    {
+        let mut s = self.clone();
+        s.timeshift_mut(solver, target);
+        s
+    }
+
+    fn timeshift_mut(&mut self, solver: &GnssAbsoluteTime, target: TimeScale) {
+        self.header.timeshift_mut(solver, target);
+
+        if let Some(obs_rec) = self.record.as_mut_obs() {
+            let mut new_rec = BTreeMap::<ObsKey, Observations>::new();
+
+            for (k, values) in obs_rec.iter() {
+                if let Some(converted) = solver.epoch_time_correction(k.epoch, target) {
+                    let mut key = k.clone();
+                    key.epoch = converted;
+
+                    new_rec.insert(key, values.clone());
+                }
+            }
+
+            *obs_rec = new_rec;
+        }
+    }
+}