Enum light_curve_feature::Feature

#[non_exhaustive]
pub enum Feature<T> where
    T: Float,  {
    FeatureExtractor(FeatureExtractor<T, Self>),
    Amplitude(Amplitude),
    AndersonDarlingNormal(AndersonDarlingNormal),
    Bins(Bins<T, Self>),
    BazinFit(BazinFit),
    BeyondNStd(BeyondNStd<T>),
    Cusum(Cusum),
    Duration(Duration),
    Eta(Eta),
    EtaE(EtaE),
    ExcessVariance(ExcessVariance),
    InterPercentileRange(InterPercentileRange),
    Kurtosis(Kurtosis),
    LinearFit(LinearFit),
    LinearTrend(LinearTrend),
    MagnitudePercentageRatio(MagnitudePercentageRatio),
    MaximumSlope(MaximumSlope),
    MaximumTimeInterval(MaximumTimeInterval),
    MinimumTimeInterval(MinimumTimeInterval),
    Mean(Mean),
    MeanVariance(MeanVariance),
    Median(Median),
    MedianAbsoluteDeviation(MedianAbsoluteDeviation),
    MedianBufferRangePercentage(MedianBufferRangePercentage<T>),
    ObservationCount(ObservationCount),
    PercentAmplitude(PercentAmplitude),
    PercentDifferenceMagnitudePercentile(PercentDifferenceMagnitudePercentile),
    Periodogram(Periodogram<T, Self>),
    _PeriodogramPeaks(_PeriodogramPeaks),
    ReducedChi2(ReducedChi2),
    Skew(Skew),
    StandardDeviation(StandardDeviation),
    StetsonK(StetsonK),
    TimeMean(TimeMean),
    TimeStandardDeviation(TimeStandardDeviation),
    VillarFit(VillarFit),
    WeightedMean(WeightedMean),
}

All features are available as variants of this enum

Consider to import crate::FeatureEvaluator as well

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

FeatureExtractor(FeatureExtractor<T, Self>)

Amplitude(Amplitude)

AndersonDarlingNormal(AndersonDarlingNormal)

Bins(Bins<T, Self>)

BazinFit(BazinFit)

BeyondNStd(BeyondNStd<T>)

Cusum(Cusum)

Duration(Duration)

Eta(Eta)

EtaE(EtaE)

ExcessVariance(ExcessVariance)

InterPercentileRange(InterPercentileRange)

Kurtosis(Kurtosis)

LinearFit(LinearFit)

LinearTrend(LinearTrend)

MagnitudePercentageRatio(MagnitudePercentageRatio)

MaximumSlope(MaximumSlope)

MaximumTimeInterval(MaximumTimeInterval)

MinimumTimeInterval(MinimumTimeInterval)

Mean(Mean)

MeanVariance(MeanVariance)

Median(Median)

MedianAbsoluteDeviation(MedianAbsoluteDeviation)

MedianBufferRangePercentage(MedianBufferRangePercentage<T>)

ObservationCount(ObservationCount)

PercentAmplitude(PercentAmplitude)

PercentDifferenceMagnitudePercentile(PercentDifferenceMagnitudePercentile)

Periodogram(Periodogram<T, Self>)

_PeriodogramPeaks(_PeriodogramPeaks)

ReducedChi2(ReducedChi2)

Skew(Skew)

StandardDeviation(StandardDeviation)

StetsonK(StetsonK)

TimeMean(TimeMean)

TimeStandardDeviation(TimeStandardDeviation)

VillarFit(VillarFit)

WeightedMean(WeightedMean)

Trait Implementations

impl<T: Clone> Clone for Feature<T> where
    T: Float, 

fn clone(&self) -> Feature<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Feature<T> where
    T: Float, 

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Feature<T> where
    T: Float,
    T: Float, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T> EvaluatorInfoTrait for Feature<T> where
    T: Float, 

fn get_info(&self) -> &EvaluatorInfo

Get feature evaluator meta-information

fn size_hint(&self) -> usize

Size of vectors returned by eval(), get_names() and get_descriptions()

fn min_ts_length(&self) -> usize

Minimum time series length required to successfully evaluate feature

fn is_t_required(&self) -> bool

If time array used by the feature

fn is_m_required(&self) -> bool

If magnitude array is used by the feature

fn is_w_required(&self) -> bool

If weight array is used by the feature

fn is_sorting_required(&self) -> bool

If feature requires time-sorting on the input TimeSeries

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

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

Vector of feature values or EvaluatorError

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

Returns vector of feature values and fill invalid components with given value

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

Checks if TimeSeries has enough points to evaluate the feature

impl<T> FeatureNamesDescriptionsTrait for Feature<T> where
    T: Float, 

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

Vector of feature names. The length and feature order corresponds to eval() output

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

Vector of feature descriptions. The length and feature order corresponds to eval() output

impl<T> From<Amplitude> for Feature<T> where
    T: Float, 

fn from(v: Amplitude) -> Feature<T>

Converts to this type from the input type.

impl<T> From<AndersonDarlingNormal> for Feature<T> where
    T: Float, 

fn from(v: AndersonDarlingNormal) -> Feature<T>

Converts to this type from the input type.

impl<T> From<BazinFit> for Feature<T> where
    T: Float, 

fn from(v: BazinFit) -> Feature<T>

Converts to this type from the input type.

impl<T> From<BeyondNStd<T>> for Feature<T> where
    T: Float, 

fn from(v: BeyondNStd<T>) -> Feature<T>

Converts to this type from the input type.

impl<T> From<Bins<T, Feature<T>>> for Feature<T> where
    T: Float, 

fn from(v: Bins<T, Self>) -> Feature<T>

Converts to this type from the input type.

impl<T> From<Cusum> for Feature<T> where
    T: Float, 

fn from(v: Cusum) -> Feature<T>

Converts to this type from the input type.

impl<T> From<Duration> for Feature<T> where
    T: Float, 

fn from(v: Duration) -> Feature<T>

Converts to this type from the input type.

impl<T> From<Eta> for Feature<T> where
    T: Float, 

fn from(v: Eta) -> Feature<T>

Converts to this type from the input type.

impl<T> From<EtaE> for Feature<T> where
    T: Float, 

fn from(v: EtaE) -> Feature<T>

Converts to this type from the input type.

impl<T> From<ExcessVariance> for Feature<T> where
    T: Float, 

fn from(v: ExcessVariance) -> Feature<T>

Converts to this type from the input type.

impl<T> From<FeatureExtractor<T, Feature<T>>> for Feature<T> where
    T: Float, 

fn from(v: FeatureExtractor<T, Self>) -> Feature<T>

Converts to this type from the input type.

impl<T> From<InterPercentileRange> for Feature<T> where
    T: Float, 

fn from(v: InterPercentileRange) -> Feature<T>

Converts to this type from the input type.

impl<T> From<Kurtosis> for Feature<T> where
    T: Float, 

fn from(v: Kurtosis) -> Feature<T>

Converts to this type from the input type.

impl<T> From<LinearFit> for Feature<T> where
    T: Float, 

fn from(v: LinearFit) -> Feature<T>

Converts to this type from the input type.

impl<T> From<LinearTrend> for Feature<T> where
    T: Float, 

fn from(v: LinearTrend) -> Feature<T>

Converts to this type from the input type.

impl<T> From<MagnitudePercentageRatio> for Feature<T> where
    T: Float, 

fn from(v: MagnitudePercentageRatio) -> Feature<T>

Converts to this type from the input type.

impl<T> From<MaximumSlope> for Feature<T> where
    T: Float, 

fn from(v: MaximumSlope) -> Feature<T>

Converts to this type from the input type.

impl<T> From<MaximumTimeInterval> for Feature<T> where
    T: Float, 

fn from(v: MaximumTimeInterval) -> Feature<T>

Converts to this type from the input type.

impl<T> From<Mean> for Feature<T> where
    T: Float, 

fn from(v: Mean) -> Feature<T>

Converts to this type from the input type.

impl<T> From<MeanVariance> for Feature<T> where
    T: Float, 

fn from(v: MeanVariance) -> Feature<T>

Converts to this type from the input type.

impl<T> From<Median> for Feature<T> where
    T: Float, 

fn from(v: Median) -> Feature<T>

Converts to this type from the input type.

impl<T> From<MedianAbsoluteDeviation> for Feature<T> where
    T: Float, 

fn from(v: MedianAbsoluteDeviation) -> Feature<T>

Converts to this type from the input type.

impl<T> From<MedianBufferRangePercentage<T>> for Feature<T> where
    T: Float, 

fn from(v: MedianBufferRangePercentage<T>) -> Feature<T>

Converts to this type from the input type.

impl<T> From<MinimumTimeInterval> for Feature<T> where
    T: Float, 

fn from(v: MinimumTimeInterval) -> Feature<T>

Converts to this type from the input type.

impl<T> From<ObservationCount> for Feature<T> where
    T: Float, 

fn from(v: ObservationCount) -> Feature<T>

Converts to this type from the input type.

impl<T> From<PercentAmplitude> for Feature<T> where
    T: Float, 

fn from(v: PercentAmplitude) -> Feature<T>

Converts to this type from the input type.

impl<T> From<PercentDifferenceMagnitudePercentile> for Feature<T> where
    T: Float, 

fn from(v: PercentDifferenceMagnitudePercentile) -> Feature<T>

Converts to this type from the input type.

impl<T> From<Periodogram<T, Feature<T>>> for Feature<T> where
    T: Float, 

fn from(v: Periodogram<T, Self>) -> Feature<T>

Converts to this type from the input type.

impl<T> From<ReducedChi2> for Feature<T> where
    T: Float, 

fn from(v: ReducedChi2) -> Feature<T>

Converts to this type from the input type.

impl<T> From<Skew> for Feature<T> where
    T: Float, 

fn from(v: Skew) -> Feature<T>

Converts to this type from the input type.

impl<T> From<StandardDeviation> for Feature<T> where
    T: Float, 

fn from(v: StandardDeviation) -> Feature<T>

Converts to this type from the input type.

impl<T> From<StetsonK> for Feature<T> where
    T: Float, 

fn from(v: StetsonK) -> Feature<T>

Converts to this type from the input type.

impl<T> From<TimeMean> for Feature<T> where
    T: Float, 

fn from(v: TimeMean) -> Feature<T>

Converts to this type from the input type.

impl<T> From<TimeStandardDeviation> for Feature<T> where
    T: Float, 

fn from(v: TimeStandardDeviation) -> Feature<T>

Converts to this type from the input type.

impl<T> From<VillarFit> for Feature<T> where
    T: Float, 

fn from(v: VillarFit) -> Feature<T>

Converts to this type from the input type.

impl<T> From<WeightedMean> for Feature<T> where
    T: Float, 

fn from(v: WeightedMean) -> Feature<T>

Converts to this type from the input type.

impl<T: JsonSchema> JsonSchema for Feature<T> where
    T: Float, 

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<T> Serialize for Feature<T> where
    T: Float,
    T: Float, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T> TryInto<Amplitude> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Amplitude, <Self as TryInto<Amplitude>>::Error>

Performs the conversion.

impl<T> TryInto<AndersonDarlingNormal> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<AndersonDarlingNormal, <Self as TryInto<AndersonDarlingNormal>>::Error>

Performs the conversion.

impl<T> TryInto<BazinFit> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<BazinFit, <Self as TryInto<BazinFit>>::Error>

Performs the conversion.

impl<T> TryInto<BeyondNStd<T>> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<BeyondNStd<T>, <Self as TryInto<BeyondNStd<T>>>::Error>

Performs the conversion.

impl<T> TryInto<Bins<T, Feature<T>>> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<Bins<T, Self>, <Self as TryInto<Bins<T, Self>>>::Error>

Performs the conversion.

impl<T> TryInto<Cusum> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Cusum, <Self as TryInto<Cusum>>::Error>

Performs the conversion.

impl<T> TryInto<Duration> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Duration, <Self as TryInto<Duration>>::Error>

Performs the conversion.

impl<T> TryInto<Eta> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Eta, <Self as TryInto<Eta>>::Error>

Performs the conversion.

impl<T> TryInto<EtaE> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<EtaE, <Self as TryInto<EtaE>>::Error>

Performs the conversion.

impl<T> TryInto<ExcessVariance> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<ExcessVariance, <Self as TryInto<ExcessVariance>>::Error>

Performs the conversion.

impl<T> TryInto<FeatureExtractor<T, Feature<T>>> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<FeatureExtractor<T, Self>, <Self as TryInto<FeatureExtractor<T, Self>>>::Error>

Performs the conversion.

impl<T> TryInto<InterPercentileRange> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<InterPercentileRange, <Self as TryInto<InterPercentileRange>>::Error>

Performs the conversion.

impl<T> TryInto<Kurtosis> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Kurtosis, <Self as TryInto<Kurtosis>>::Error>

Performs the conversion.

impl<T> TryInto<LinearFit> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<LinearFit, <Self as TryInto<LinearFit>>::Error>

Performs the conversion.

impl<T> TryInto<LinearTrend> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<LinearTrend, <Self as TryInto<LinearTrend>>::Error>

Performs the conversion.

impl<T> TryInto<MagnitudePercentageRatio> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<MagnitudePercentageRatio, <Self as TryInto<MagnitudePercentageRatio>>::Error>

Performs the conversion.

impl<T> TryInto<MaximumSlope> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<MaximumSlope, <Self as TryInto<MaximumSlope>>::Error>

Performs the conversion.

impl<T> TryInto<MaximumTimeInterval> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<MaximumTimeInterval, <Self as TryInto<MaximumTimeInterval>>::Error>

Performs the conversion.

impl<T> TryInto<Mean> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Mean, <Self as TryInto<Mean>>::Error>

Performs the conversion.

impl<T> TryInto<MeanVariance> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<MeanVariance, <Self as TryInto<MeanVariance>>::Error>

Performs the conversion.

impl<T> TryInto<Median> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Median, <Self as TryInto<Median>>::Error>

Performs the conversion.

impl<T> TryInto<MedianAbsoluteDeviation> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<MedianAbsoluteDeviation, <Self as TryInto<MedianAbsoluteDeviation>>::Error>

Performs the conversion.

impl<T> TryInto<MedianBufferRangePercentage<T>> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<MedianBufferRangePercentage<T>, <Self as TryInto<MedianBufferRangePercentage<T>>>::Error>

Performs the conversion.

impl<T> TryInto<MinimumTimeInterval> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<MinimumTimeInterval, <Self as TryInto<MinimumTimeInterval>>::Error>

Performs the conversion.

impl<T> TryInto<ObservationCount> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<ObservationCount, <Self as TryInto<ObservationCount>>::Error>

Performs the conversion.

impl<T> TryInto<PercentAmplitude> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<PercentAmplitude, <Self as TryInto<PercentAmplitude>>::Error>

Performs the conversion.

impl<T> TryInto<PercentDifferenceMagnitudePercentile> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<PercentDifferenceMagnitudePercentile, <Self as TryInto<PercentDifferenceMagnitudePercentile>>::Error>

Performs the conversion.

impl<T> TryInto<Periodogram<T, Feature<T>>> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<Periodogram<T, Self>, <Self as TryInto<Periodogram<T, Self>>>::Error>

Performs the conversion.

impl<T> TryInto<ReducedChi2> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<ReducedChi2, <Self as TryInto<ReducedChi2>>::Error>

Performs the conversion.

impl<T> TryInto<Skew> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Skew, <Self as TryInto<Skew>>::Error>

Performs the conversion.

impl<T> TryInto<StandardDeviation> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<StandardDeviation, <Self as TryInto<StandardDeviation>>::Error>

Performs the conversion.

impl<T> TryInto<StetsonK> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<StetsonK, <Self as TryInto<StetsonK>>::Error>

Performs the conversion.

impl<T> TryInto<TimeMean> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<TimeMean, <Self as TryInto<TimeMean>>::Error>

Performs the conversion.

impl<T> TryInto<TimeStandardDeviation> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<TimeStandardDeviation, <Self as TryInto<TimeStandardDeviation>>::Error>

Performs the conversion.

impl<T> TryInto<VillarFit> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<VillarFit, <Self as TryInto<VillarFit>>::Error>

Performs the conversion.

impl<T> TryInto<WeightedMean> for Feature<T> where
    T: Float, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(
    self
) -> Result<WeightedMean, <Self as TryInto<WeightedMean>>::Error>

Performs the conversion.