Struct light_curve_feature::features::ReducedChi2

pub struct ReducedChi2 {}

Reduced $\chi^2$ of magnitude measurements

$$ \mathrm{reduced~}\chi^2 \equiv \frac1{N-1} \sum_i\left(\frac{m_i - \bar{m}}{\delta_i}\right)^2, $$ where $N$ is the number of observations, and $\bar{m}$ is the weighted mean magnitude.

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

This is a good measure of variability which takes into account observations uncertainties.

Wikipedia

Implementations

impl ReducedChi2

pub fn new() -> Self

pub fn doc() -> &'static str

Trait Implementations

impl Clone for ReducedChi2

fn clone(&self) -> ReducedChi2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReducedChi2

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

Formats the value using the given formatter.

impl Default for ReducedChi2

fn default() -> ReducedChi2

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReducedChi2

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

Deserialize this value from the given Serde deserializer.

impl EvaluatorInfoTrait for ReducedChi2

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 ReducedChi2 where
    T: Float, 

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

Vector of feature values or EvaluatorError

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

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

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

Checks if TimeSeries has enough points to evaluate the feature

impl FeatureNamesDescriptionsTrait for ReducedChi2

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<ReducedChi2> for Feature<T> where
    T: Float, 

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

Converts to this type from the input type.

impl JsonSchema for ReducedChi2

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 Serialize for ReducedChi2

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<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.