Struct StftOptions 

pub struct StftOptions { /* private fields */ }

Options for frequency analyses that are backed by short-time Fourier transforms.

Implementations

impl StftOptions

pub fn builder() -> Builder<Complete>

Returns a new builder.

impl StftOptions

pub fn new() -> Self

Constructs a new instance of the type.

pub fn window(&self) -> Option<&FftWindow>

Window function type to use

pub fn window_symmetry(&self) -> Option<&WindowSymmetry>

Either DFT_EVEN or SYMMETRIC

pub fn sampling_frequency(&self) -> Option<f64>

Sampling frequency of the series in Hz. If absent, will calculate using the input series.

pub fn nperseg(&self) -> Option<i32>

Number of points per window segment.

pub fn noverlap(&self) -> Option<i32>

Number of points of overlap between windows. Must be less than nperseg.

pub fn nfft(&self) -> Option<i32>

Number of points to use in the FFT. Must be greater than or equal to nperseg.

pub fn detrend(&self) -> Option<&DetrendType>

Detrend the points in each window segment. If absent, will use the default detrend for that function.

Trait Implementations

impl Clone for StftOptions

fn clone(&self) -> StftOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StftOptions

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StftOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<StftOptions> for Builder<Complete>

fn from(v: StftOptions) -> Self

Converts to this type from the input type.

impl Hash for StftOptions

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for StftOptions

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StftOptions

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for StftOptions

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for StftOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for StftOptions