Initial impl of MiltiColorPeriodogram

Author: hombit

Cargo.toml

@@ -65,6 +65,7 @@ clap = { version = "3.2.6", features = ["std", "color", "suggestions", "derive",
 criterion = "0.4"
 hyperdual = "1.1"
 light-curve-common = "0.1.0"
+ndarray = { version = "^0.15", features = ["approx-0_5"] }
 plotters = { version = "0.3.1", default-features = false, features = ["errorbar", "line_series", "ttf"] }
 plotters-bitmap = "0.3.1"
 rand = "0.7"

src/data/mod.rs

@@ -1,12 +1,11 @@
 mod data_sample;
 pub use data_sample::DataSample;
 
-mod multi_color_time_series;
+pub(crate) mod multi_color_time_series;
 pub use multi_color_time_series::MultiColorTimeSeries;
 
 mod sorted_array;
 pub use sorted_array::SortedArray;
 
 mod time_series;
-
 pub use time_series::TimeSeries;

src/data/multi_color_time_series.rs

@@ -3,6 +3,7 @@ use crate::float_trait::Float;
 use crate::multicolor::PassbandTrait;
 use crate::{DataSample, PassbandSet};
 
+use conv::prelude::*;
 use itertools::Either;
 use itertools::EitherOrBoth;
 use itertools::Itertools;
@@ -23,6 +24,22 @@ where
     P: PassbandTrait + 'p,
     T: Float,
 {
+    pub fn total_lenu(&self) -> usize {
+        match self {
+            Self::Mapping(mapping) => mapping.total_lenu(),
+            Self::Flat(flat) => flat.total_lenu(),
+            Self::MappingFlat { flat, .. } => flat.total_lenu(),
+        }
+    }
+
+    pub fn total_lenf(&self) -> T {
+        match self {
+            Self::Mapping(mapping) => mapping.total_lenf(),
+            Self::Flat(flat) => flat.total_lenf(),
+            Self::MappingFlat { flat, .. } => flat.total_lenf(),
+        }
+    }
+
     pub fn from_map(map: impl Into<BTreeMap<P, TimeSeries<'a, T>>>) -> Self {
         Self::Mapping(MappedMultiColorTimeSeries::new(map))
     }
@@ -148,13 +165,30 @@ where
         )
     }
 
+    pub fn total_lenu(&self) -> usize {
+        self.0.values().map(|ts| ts.lenu()).sum()
+    }
+
+    pub fn total_lenf(&self) -> T {
+        self.total_lenu().value_as::<T>().unwrap()
+    }
+
     pub fn passbands<'slf>(
         &'slf self,
     ) -> std::collections::btree_map::Keys<'slf, P, TimeSeries<'a, T>>
     where
         'a: 'slf,
     {
-        self.keys()
+        self.0.keys()
+    }
+
+    pub fn iter_ts<'slf>(
+        &'slf self,
+    ) -> std::collections::btree_map::Values<'slf, P, TimeSeries<'a, T>>
+    where
+        'a: 'slf,
+    {
+        self.0.values()
     }
 
     pub fn iter_passband_set<'slf, 'ps>(
@@ -305,4 +339,12 @@ where
             passband_set: mapping.keys().cloned().collect(),
         }
     }
+
+    pub fn total_lenu(&self) -> usize {
+        self.t.sample.len()
+    }
+
+    pub fn total_lenf(&self) -> T {
+        self.t.sample.len().value_as::<T>().unwrap()
+    }
 }

src/error.rs

@@ -1,3 +1,5 @@
+use crate::data::multi_color_time_series::MappedMultiColorTimeSeries;
+use crate::float_trait::Float;
 use crate::PassbandTrait;
 
 use std::collections::BTreeSet;
@@ -28,6 +30,15 @@ pub enum MultiColorEvaluatorError {
         actual: BTreeSet<String>,
         desired: BTreeSet<String>,
     },
+
+    #[error("No time-series long enough: maximum length found is {maximum_actual}, while minimum required is {minimum_required}")]
+    AllTimeSeriesAreShort {
+        maximum_actual: usize,
+        minimum_required: usize,
+    },
+
+    #[error(r#"Underlying feature caused an error: "{0:?}""#)]
+    UnderlyingEvaluatorError(#[from] EvaluatorError),
 }
 
 impl MultiColorEvaluatorError {
@@ -43,6 +54,20 @@ impl MultiColorEvaluatorError {
             desired: desired.map(|p| p.name().into()).collect(),
         }
     }
+
+    pub fn all_time_series_short<P, T>(
+        mapped: &MappedMultiColorTimeSeries<P, T>,
+        minimum_required: usize,
+    ) -> Self
+    where
+        P: PassbandTrait,
+        T: Float,
+    {
+        Self::AllTimeSeriesAreShort {
+            maximum_actual: mapped.iter_ts().map(|ts| ts.lenu()).max().unwrap_or(0),
+            minimum_required,
+        }
+    }
 }
 
 #[derive(Debug, thiserror::Error, PartialEq, Eq)]

src/features/periodogram.rs

@@ -4,6 +4,7 @@ use crate::features::_periodogram_peaks::PeriodogramPeaks;
 use crate::periodogram;
 use crate::periodogram::{AverageNyquistFreq, NyquistFreq, PeriodogramPower, PeriodogramPowerFft};
 
+use ndarray::Array1;
 use std::convert::TryInto;
 use std::fmt::Debug;
 
@@ -32,7 +33,7 @@ series without observation errors (unity weights are used if required). You can
 #[doc = DOC!()]
 #[derive(Clone, Debug, Deserialize, Serialize)]
 #[serde(
-    bound = "T: Float, F: FeatureEvaluator<T> + From<PeriodogramPeaks> + TryInto<PeriodogramPeaks>, <F as std::convert::TryInto<PeriodogramPeaks>>::Error: Debug,",
+    bound = "T: Float, F: FeatureEvaluator<T> + From<PeriodogramPeaks> + TryInto<PeriodogramPeaks>, <F as TryInto<PeriodogramPeaks>>::Error: Debug,",
     from = "PeriodogramParameters<T, F>",
     into = "PeriodogramParameters<T, F>"
 )]
@@ -43,7 +44,7 @@ where
     resolution: f32,
     max_freq_factor: f32,
     nyquist: NyquistFreq,
-    feature_extractor: FeatureExtractor<T, F>,
+    pub(crate) feature_extractor: FeatureExtractor<T, F>,
     periodogram_algorithm: PeriodogramPower<T>,
     properties: Box<EvaluatorProperties>,
 }
@@ -119,24 +120,24 @@ where
         self
     }
 
-    fn periodogram(&self, ts: &mut TimeSeries<T>) -> periodogram::Periodogram<T> {
+    pub(crate) fn periodogram(&self, t: &[T]) -> periodogram::Periodogram<T> {
         periodogram::Periodogram::from_t(
             self.periodogram_algorithm.clone(),
-            ts.t.as_slice(),
+            t,
             self.resolution,
             self.max_freq_factor,
             self.nyquist.clone(),
         )
     }
 
-    pub fn power(&self, ts: &mut TimeSeries<T>) -> Vec<T> {
-        self.periodogram(ts).power(ts)
+    pub fn power(&self, ts: &mut TimeSeries<T>) -> Array1<T> {
+        self.periodogram(ts.t.as_slice()).power(ts)
     }
 
-    pub fn freq_power(&self, ts: &mut TimeSeries<T>) -> (Vec<T>, Vec<T>) {
-        let p = self.periodogram(ts);
+    pub fn freq_power(&self, ts: &mut TimeSeries<T>) -> (Array1<T>, Array1<T>) {
+        let p = self.periodogram(ts.t.as_slice());
         let power = p.power(ts);
-        let freq = (0..power.len()).map(|i| p.freq(i)).collect::<Vec<_>>();
+        let freq = (0..power.len()).map(|i| p.freq_by_index(i)).collect();
         (freq, power)
     }
 }
@@ -190,15 +191,12 @@ impl<T, F> Periodogram<T, F>
 where
     T: Float,
     F: FeatureEvaluator<T> + From<PeriodogramPeaks> + TryInto<PeriodogramPeaks>,
-    <F as std::convert::TryInto<PeriodogramPeaks>>::Error: Debug,
+    <F as TryInto<PeriodogramPeaks>>::Error: Debug,
 {
     fn transform_ts(&self, ts: &mut TimeSeries<T>) -> Result<TmArrays<T>, EvaluatorError> {
-        self.check_ts_length(ts)?;
+        self.check_ts(ts)?;
         let (freq, power) = self.freq_power(ts);
-        Ok(TmArrays {
-            t: freq.into(),
-            m: power.into(),
-        })
+        Ok(TmArrays { t: freq, m: power })
     }
 }
 
@@ -225,7 +223,7 @@ impl<T, F> EvaluatorInfoTrait for Periodogram<T, F>
 where
     T: Float,
     F: FeatureEvaluator<T> + From<PeriodogramPeaks> + TryInto<PeriodogramPeaks>,
-    <F as std::convert::TryInto<PeriodogramPeaks>>::Error: Debug,
+    <F as TryInto<PeriodogramPeaks>>::Error: Debug,
 {
     fn get_info(&self) -> &EvaluatorInfo {
         &self.properties.info
@@ -236,7 +234,7 @@ impl<T, F> FeatureNamesDescriptionsTrait for Periodogram<T, F>
 where
     T: Float,
     F: FeatureEvaluator<T> + From<PeriodogramPeaks> + TryInto<PeriodogramPeaks>,
-    <F as std::convert::TryInto<PeriodogramPeaks>>::Error: Debug,
+    <F as TryInto<PeriodogramPeaks>>::Error: Debug,
 {
     fn get_names(&self) -> Vec<&str> {
         self.properties.names.iter().map(String::as_str).collect()
@@ -255,7 +253,7 @@ impl<T, F> FeatureEvaluator<T> for Periodogram<T, F>
 where
     T: Float,
     F: FeatureEvaluator<T> + From<PeriodogramPeaks> + TryInto<PeriodogramPeaks>,
-    <F as std::convert::TryInto<PeriodogramPeaks>>::Error: Debug,
+    <F as TryInto<PeriodogramPeaks>>::Error: Debug,
 {
     transformer_eval!();
 }
@@ -279,7 +277,7 @@ impl<T, F> From<Periodogram<T, F>> for PeriodogramParameters<T, F>
 where
     T: Float,
     F: FeatureEvaluator<T> + From<PeriodogramPeaks> + TryInto<PeriodogramPeaks>,
-    <F as std::convert::TryInto<PeriodogramPeaks>>::Error: Debug,
+    <F as TryInto<PeriodogramPeaks>>::Error: Debug,
 {
     fn from(f: Periodogram<T, F>) -> Self {
         let Periodogram {

src/lib.rs

@@ -32,7 +32,7 @@ pub use float_trait::Float;
 
 mod lnerfc;
 
-mod multicolor;
+pub mod multicolor;
 pub use multicolor::*;
 
 mod nl_fit;

src/multicolor/features/mod.rs

@@ -6,3 +6,6 @@ pub use color_of_median::ColorOfMedian;
 
 mod color_of_minimum;
 pub use color_of_minimum::ColorOfMinimum;
+
+mod multi_color_periodogram;
+pub use multi_color_periodogram::MultiColorPeriodogram;