Struct augurs_seasons::PeriodogramDetectorBuilder

pub struct PeriodogramDetectorBuilder { /* private fields */ }

A builder for a periodogram detector.

Implementations

impl Builder

pub fn min_period(self, min_period: u32) -> Self

Set the minimum period to consider when detecting seasonal periods.

The default is 4.

pub fn max_period(self, max_period: u32) -> Self

Set the maximum period to consider when detecting seasonal periods.

The default is the length of the data divided by 3, or 512, whichever is smaller.

pub fn threshold(self, threshold: f64) -> Self

Set the threshold for detecting peaks in the periodogram.

The value will be clamped to the range 0.01 to 0.99.

The default is 0.9.

pub fn build(self) -> Detector

Build the periodogram detector.

The data is the time series to detect seasonal periods in.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.