Merge pull request #39 from rtk-rs/track_fit

Track fit

Author: gwbres

Cargo.toml

@@ -21,7 +21,10 @@ default = [] # no features by default
 scheduler = []
 
 # Satellite tracker and fit method
-tracker = ["polyfit-rs"]
+tracker = [
+    "dep:polyfit-rs",
+    "dep:log",
+]
 
 [dependencies]
 thiserror = "2"
@@ -30,13 +33,12 @@ strum = "0.27"
 itertools = "0.14"
 strum_macros = "0.27"
 flate2 = { version = "1", optional = true }
-serde = { version = "1.0", optional = true, features = ["derive"] }
+log = { version = "0.4", optional = true }
+polyfit-rs = { version = "0.2", optional = true }
 gnss-rs = { version = "2.3.5", features = ["serde"] }
+serde = { version = "1.0", optional = true, features = ["derive"] }
 hifitime = { version = "4.0", features = ["serde", "std"] }
 
-# track scheduling
-polyfit-rs = { version = "0.2", optional = true }
-
 [dev-dependencies]
 rand = "0.8"
 

src/lib.rs

@@ -36,9 +36,9 @@ mod header;
 #[cfg_attr(docsrs, doc(cfg(feature = "scheduler")))]
 mod scheduler;
 
-// #[cfg(feature = "tracker")]
-// #[cfg_attr(docsrs, doc(cfg(feature = "tracker")))]
-// mod track_fit;
+#[cfg(feature = "tracker")]
+#[cfg_attr(docsrs, doc(cfg(feature = "tracker")))]
+mod tracker;
 
 #[cfg(test)]
 mod tests;
@@ -63,8 +63,8 @@ pub mod prelude {
     #[cfg(feature = "scheduler")]
     pub use crate::scheduler::{calendar::CommonViewCalendar, period::CommonViewPeriod};
 
-    // #[cfg(feature = "tracker")]
-    // pub use crate::track_fit::{Observation, FittedData, SVTracker, SkyTracker, FitError};
+    #[cfg(feature = "tracker")]
+    pub use crate::tracker::{FitError, FittedData, Observation, SVTracker, SkyTracker};
 
     // pub re-export
     pub use gnss::prelude::{Constellation, SV};
@@ -81,9 +81,6 @@ use crate::{
     track::{CommonViewClass, Track},
 };
 
-// /// Latest CGGTTS release : only version we truly support
-// pub const CURRENT_RELEASE: &str = "2E";
-
 /// [CGGTTS] is a structure split in two:
 /// - the [Header] section gives general information
 /// about the measurement system and context

src/scheduler/calendar.rs

@@ -29,15 +29,17 @@ pub struct CommonViewCalendar {
 }
 
 impl CommonViewCalendar {
-    /// Design a new [CommonViewCalendar] (planification table).
+    /// Design a new [CommonViewCalendar] to plan your common view measurements
+    /// and CGGTTS realizations.
     ///
     /// ## Input
     /// - reference_epoch: reference [Epoch] used in the scheduling process.  
-    /// In historical CGGTTS, this is MJD 50_722 +2'.
+    /// In [Self::bipm], this is MJD 50_722 00:00:02.
     ///
     /// - period: [CommonViewPeriod] specifications.
     /// The total [CommonViewPeriod] must be a perfect multiple of a day,
     /// we do not support a fractional number of daily periods.
+    /// In [Self::bipm], this is [CommonViewPeriod::bipm_common_view_period].
     pub fn new(reference_epoch: Epoch, period: CommonViewPeriod) -> Result<Self, Error> {
         let total_duration = period.total_duration().to_seconds();
         let one_day = Duration::from_days(1.0).to_seconds();
@@ -241,15 +243,15 @@ impl CommonViewCalendar {
 
     /// Returns remaining time (as [Duration]) until start of next
     /// [CommonViewPeriod] after specified [Epoch].
-    pub fn time_to_next_start(&self, t: Epoch) -> Duration {
+    pub fn time_to_next_period(&self, t: Epoch) -> Duration {
         let next_start = self.next_period_start_after(t);
         t - next_start
     }
 
     /// Returns remaining time (as [Duration]) until start of next
     /// active data collection, after specified [Epoch].
     pub fn time_to_next_data_collection(&self, t: Epoch) -> Duration {
-        let mut dt = self.time_to_next_start(t);
+        let mut dt = self.time_to_next_period(t);
         if self.period.setup_duration == Duration::ZERO {
             dt += self.period.setup_duration;
         }