Struct light_curve_feature::features::Bins
source · pub struct Bins<T, F>where
T: Float,
F: FeatureEvaluator<T>,{ /* private fields */ }
Expand description
Sampled time series meta-feature
Binning time series to bins with width $\mathrm{window}$ with respect to some $\mathrm{offset}$. $j-th$ bin interval is $[j \cdot \mathrm{window} + \mathrm{offset}; (j + 1) \cdot \mathrm{window} + \mathrm{offset})$. Binned time series is defined by $$ t_j^* = (j + \frac12) \cdot \mathrm{window} + \mathrm{offset}, $$ $$ m_j^* = \frac{\sum{m_i / \delta_i^2}}{\sum{\delta_i^{-2}}}, $$ $$ \delta_j^* = \frac{N_j}{\sum{\delta_i^{-2}}}, $$ where $N_j$ is a number of sampling observations and all sums are over observations inside considering bin. Bins takes any other feature evaluators to extract features from sample time series
- Depends on: time, magnitude, magnitude error
- Minimum number of observations: as required by sub-features, but at least 1
- Number of features: as provided by sub-features
Implementations§
source§impl<T, F> Bins<T, F>where
T: Float,
F: FeatureEvaluator<T>,
impl<T, F> Bins<T, F>where
T: Float,
F: FeatureEvaluator<T>,
pub fn new(window: T, offset: T) -> Self
pub fn set_window(&mut self, window: T) -> &mut Self
pub fn set_offset(&mut self, offset: T) -> &mut Self
sourcepub fn add_feature(&mut self, feature: F) -> &mut Self
pub fn add_feature(&mut self, feature: F) -> &mut Self
Extend a feature to extract from binned time series
pub fn default_window() -> T
pub fn default_offset() -> T
Trait Implementations§
source§impl<'de, T, F> Deserialize<'de> for Bins<T, F>where
T: Float,
F: FeatureEvaluator<T>,
impl<'de, T, F> Deserialize<'de> for Bins<T, F>where
T: Float,
F: FeatureEvaluator<T>,
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl<T, F> EvaluatorInfoTrait for Bins<T, F>where
T: Float,
F: FeatureEvaluator<T>,
impl<T, F> EvaluatorInfoTrait for Bins<T, F>where
T: Float,
F: FeatureEvaluator<T>,
source§fn min_ts_length(&self) -> usize
fn min_ts_length(&self) -> usize
Minimum time series length required to successfully evaluate feature
source§fn is_t_required(&self) -> bool
fn is_t_required(&self) -> bool
If time array used by the feature
source§fn is_m_required(&self) -> bool
fn is_m_required(&self) -> bool
If magnitude array is used by the feature
source§fn is_w_required(&self) -> bool
fn is_w_required(&self) -> bool
If weight array is used by the feature
source§fn is_sorting_required(&self) -> bool
fn is_sorting_required(&self) -> bool
If feature requires time-sorting on the input TimeSeries
source§impl<T, F> FeatureEvaluator<T> for Bins<T, F>where
T: Float,
F: FeatureEvaluator<T>,
impl<T, F> FeatureEvaluator<T> for Bins<T, F>where
T: Float,
F: FeatureEvaluator<T>,
source§fn eval(&self, ts: &mut TimeSeries<'_, T>) -> Result<Vec<T>, EvaluatorError>
fn eval(&self, ts: &mut TimeSeries<'_, T>) -> Result<Vec<T>, EvaluatorError>
Vector of feature values or
EvaluatorError
source§fn eval_or_fill(&self, ts: &mut TimeSeries<'_, T>, fill_value: T) -> Vec<T>
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
source§fn check_ts_length(
&self,
ts: &TimeSeries<'_, T>
) -> Result<usize, EvaluatorError>
fn check_ts_length( &self, ts: &TimeSeries<'_, T> ) -> Result<usize, EvaluatorError>
Checks if TimeSeries has enough points to evaluate the feature
source§impl<T, F> FeatureNamesDescriptionsTrait for Bins<T, F>where
T: Float,
F: FeatureEvaluator<T>,
impl<T, F> FeatureNamesDescriptionsTrait for Bins<T, F>where
T: Float,
F: FeatureEvaluator<T>,
source§impl<T, F> JsonSchema for Bins<T, F>where
T: Float,
F: FeatureEvaluator<T>,
impl<T, F> JsonSchema for Bins<T, F>where
T: Float,
F: FeatureEvaluator<T>,
source§fn is_referenceable() -> bool
fn is_referenceable() -> bool
Whether JSON Schemas generated for this type should be re-used where possible using the
$ref
keyword. Read moresource§fn schema_name() -> String
fn schema_name() -> String
The name of the generated JSON Schema. Read more
source§fn json_schema(gen: &mut SchemaGenerator) -> Schema
fn json_schema(gen: &mut SchemaGenerator) -> Schema
Generates a JSON Schema for this type. Read more
Auto Trait Implementations§
impl<T, F> Freeze for Bins<T, F>where
T: Freeze,
impl<T, F> RefUnwindSafe for Bins<T, F>where
T: RefUnwindSafe,
F: RefUnwindSafe,
impl<T, F> Send for Bins<T, F>
impl<T, F> Sync for Bins<T, F>where
F: Sync,
impl<T, F> Unpin for Bins<T, F>
impl<T, F> UnwindSafe for Bins<T, F>where
T: UnwindSafe,
F: UnwindSafe,
Blanket Implementations§
source§impl<Src, Scheme> ApproxFrom<Src, Scheme> for Srcwhere
Scheme: ApproxScheme,
impl<Src, Scheme> ApproxFrom<Src, Scheme> for Srcwhere
Scheme: ApproxScheme,
source§fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>
fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>
Convert the given value into an approximately equivalent representation.
source§impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Srcwhere
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,
impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Srcwhere
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,
§type Err = <Dst as ApproxFrom<Src, Scheme>>::Err
type Err = <Dst as ApproxFrom<Src, Scheme>>::Err
The error type produced by a failed conversion.
source§fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>
fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>
Convert the subject into an approximately equivalent representation.
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T, Dst> ConvAsUtil<Dst> for T
impl<T, Dst> ConvAsUtil<Dst> for T
source§impl<T> ConvUtil for T
impl<T> ConvUtil for T
source§fn approx_as<Dst>(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst>,
fn approx_as<Dst>(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst>,
Approximate the subject to a given type with the default scheme.
source§fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>
fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>
Approximate the subject to a given type with a specific scheme.
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more