Struct SignalFilterSeries

pub struct SignalFilterSeries { /* private fields */ }

Applies IIR-based signal filtering to input series. Includes low-pass, high-pass, band-pass, and band-stop filters. Currently supports variable-order bidirectional Butterworth filters, with fixed-size padding based on SciPy output.

Implementations

impl SignalFilterSeries

pub fn builder() -> Builder<InputStage>

Returns a new builder.

impl SignalFilterSeries

pub fn new( input: NumericSeries, signal_filter_configuration: SignalFilterConfiguration, order: IntegerConstant, ) -> Self

Constructs a new instance of the type.

pub fn input(&self) -> &NumericSeries

pub fn signal_filter_configuration(&self) -> &SignalFilterConfiguration

Filter type and cutoff frequencies.

pub fn order(&self) -> &IntegerConstant

Order of filter. Must be a positive integer, and is effectively doubled for bidirectional filters.

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

The sampling frequency of the input series. Used to calculate normalized frequency for cutoff frequencies.

Trait Implementations

impl Clone for SignalFilterSeries

fn clone(&self) -> SignalFilterSeries

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignalFilterSeries

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SignalFilterSeries

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SignalFilterSeries> for Builder<Complete>

fn from(v: SignalFilterSeries) -> Self

Converts to this type from the input type.

impl Hash for SignalFilterSeries

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 SignalFilterSeries

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 SignalFilterSeries

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 SignalFilterSeries

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 SignalFilterSeries

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 SignalFilterSeries