Struct augurs_seasons::PeriodogramDetector

source ·
pub struct PeriodogramDetector { /* private fields */ }
Expand description

A season detector which uses a periodogram to identify seasonal periods.

The detector works by calculating a robust periodogram of the data using Welch’s method. The peaks in the periodogram represent likely seasonal periods in the data.

Implementations§

source§

impl Detector

source

pub fn builder() -> Builder

Create a new detector builder.

source

pub fn periodogram(&self, data: &[f64]) -> Periodogram

Calculate the periodogram of the data.

The periodogram is a frequency domain representation of the data, and is calculated using the Welch method.

The periodogram can then be used to identify peaks, which are returned as periods which correspond to likely seasonal periods in the data.

Trait Implementations§

source§

impl Debug for Detector

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Detector

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Detector for Detector

source§

fn detect(&self, data: &[f64]) -> Vec<u32>

Detects the periods of a time series.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.