Struct light_curve_feature::prelude::TimeSeries
source · [−]pub struct TimeSeries<'a, T> where
T: Float, {
pub t: DataSample<'a, T>,
pub m: DataSample<'a, T>,
pub w: DataSample<'a, T>,
/* private fields */
}
Expand description
Time series object to be put into Feature
This struct caches it’s properties, like mean magnitude value, etc., that’s why mutable reference is required fot feature evaluation
Fields
t: DataSample<'a, T>
m: DataSample<'a, T>
w: DataSample<'a, T>
Implementations
sourceimpl<'a, T> TimeSeries<'a, T> where
T: Float,
impl<'a, T> TimeSeries<'a, T> where
T: Float,
sourcepub fn new(
t: impl Into<DataSample<'a, T>>,
m: impl Into<DataSample<'a, T>>,
w: impl Into<DataSample<'a, T>>
) -> Self
pub fn new(
t: impl Into<DataSample<'a, T>>,
m: impl Into<DataSample<'a, T>>,
w: impl Into<DataSample<'a, T>>
) -> Self
Construct TimeSeries
from array-like objects
t
is time, m
is magnitude (or flux), w
is weights.
All arrays must have the same length, t
must increase monotonically. Input arrays could be
ndarray::Array1
, ndarray::ArrayView1
, 1-D ndarray::CowArray
, or &[T]
. Several
features assumes that w
array corresponds to inverse square errors of m
.
sourcepub fn new_without_weight(
t: impl Into<DataSample<'a, T>>,
m: impl Into<DataSample<'a, T>>
) -> Self
pub fn new_without_weight(
t: impl Into<DataSample<'a, T>>,
m: impl Into<DataSample<'a, T>>
) -> Self
Construct TimeSeries
from time and magnitude (flux)
It is the same as TimeSeries::new
, but sets unity weights. It doesn’t recommended to use
it for features dependent on weights / observation errors like crate::StetsonK
or
crate::LinearFit
.
pub fn get_m_weighted_mean(&mut self) -> T
pub fn get_m_reduced_chi2(&mut self) -> T
pub fn is_plateau(&mut self) -> bool
pub fn get_t_min_m(&mut self) -> T
pub fn get_t_max_m(&mut self) -> T
Trait Implementations
sourceimpl<'a, T: Clone> Clone for TimeSeries<'a, T> where
T: Float,
impl<'a, T: Clone> Clone for TimeSeries<'a, T> where
T: Float,
sourcefn clone(&self) -> TimeSeries<'a, T>
fn clone(&self) -> TimeSeries<'a, T>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl<'a, T> RefUnwindSafe for TimeSeries<'a, T> where
T: RefUnwindSafe,
impl<'a, T> Send for TimeSeries<'a, T>
impl<'a, T> Sync for TimeSeries<'a, T>
impl<'a, T> Unpin for TimeSeries<'a, T> where
T: Unpin,
impl<'a, T> UnwindSafe for TimeSeries<'a, T> where
T: UnwindSafe + RefUnwindSafe,
Blanket Implementations
sourceimpl<Src, Scheme> ApproxFrom<Src, Scheme> for Src where
Scheme: ApproxScheme,
impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src where
Scheme: ApproxScheme,
sourcefn 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.
sourceimpl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src where
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,
impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src where
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.
sourcefn 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.
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T, Dst> ConvAsUtil<Dst> for T
impl<T, Dst> ConvAsUtil<Dst> for T
sourcefn approx(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,
fn approx(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,
Approximate the subject with the default scheme.
sourcefn approx_by<Scheme>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,
fn approx_by<Scheme>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,
Approximate the subject with a specific scheme.
sourceimpl<T> ConvUtil for T
impl<T> ConvUtil for T
sourcefn approx_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,
fn approx_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,
Approximate the subject to a given type with the default scheme.
sourcefn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,
fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,
Approximate the subject to a given type with a specific scheme.