Struct light_curve_feature::Amplitude

pub struct Amplitude {}

Half amplitude of magnitude

$$ \mathrm{amplitude} \equiv \frac{\left( \max{(m)} - \min{(m)} \right)}{2} $$

• Depends on: magnitude
• Minimum number of observations: 1
• Number of features: 1

use light_curve_feature::*;

let fe = feat_extr!(Amplitude::default());
let time = [0.0, 1.0];  // Doesn't depend on time
let magn = [0.0, 2.0];
let mut ts = TimeSeries::new(&time[..], &magn[..], None);
assert_eq!(vec![1.0], fe.eval(&mut ts).unwrap());

Implementations

impl Amplitude

pub fn new() -> Self

Trait Implementations

impl Clone for Amplitude

fn clone(&self) -> Amplitude

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Amplitude

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Amplitude

fn default() -> Amplitude

Returns the "default value" for a type.

impl<T> FeatureEvaluator<T> for Amplitude where
    T: Float, 

fn eval(&self, ts: &mut TimeSeries<'_, T>) -> Result<Vec<T>, EvaluatorError>

Should return the vector of feature values

fn get_info(&self) -> &EvaluatorInfo

Get feature evaluator meta-information

fn get_names(&self) -> Vec<&str>

Should return the vector of feature names. The length and feature order should correspond to eval() output

fn eval_or_fill(&self, ts: &mut TimeSeries<'_, T>, fill_value: T) -> Vec<T>

fn size_hint(&self) -> usize

Should return the size of vectors returned by eval() and get_names()

fn min_ts_length(&self) -> usize

Should return minimum time series length to successfully find feature value

fn is_t_required(&self) -> bool

fn is_m_required(&self) -> bool

fn is_w_required(&self) -> bool

fn is_sorting_required(&self) -> bool

fn check_ts_length(
    &self,
    ts: &TimeSeries<'_, T>
) -> Result<usize, EvaluatorError>