Struct LowpassFilter

pub struct LowpassFilter<T> { /* private fields */ }

A single-order lowpass filter with single precision that consumes and emits items one by one.

It is mandatory to operate on f32 values in range -1.0..=1.0, which is also the default in DSP.

More Info

• https://en.wikipedia.org/wiki/Low-pass_filter#Simple_infinite_impulse_response_filter

Implementations

impl LowpassFilter<f32>

pub fn new(sample_rate_hz: f32, cutoff_frequency_hz: f32) -> Self

Create a new lowpass filter.

Arguments

• sample_rate_hz: Sample rate in Hz (e.g., 48000.0).
• cutoff_frequency_hz: Cutoff frequency in Hz (e.g., 1000.0).

pub fn run(&mut self, input: f32) -> f32

Filter a single sample and return the filtered result.

It is mandatory to operate on f32 values in range -1.0..=1.0, which is also the default in DSP. The returned value is also guaranteed to be in that range.

pub const fn reset(&mut self)

Reset the internal filter state.

impl LowpassFilter<f64>

pub fn new(sample_rate_hz: f64, cutoff_frequency_hz: f64) -> Self

Create a new lowpass filter.

Arguments

• sample_rate_hz: Sample rate in Hz (e.g., 48000.0).
• cutoff_frequency_hz: Cutoff frequency in Hz (e.g., 1000.0).

pub fn run(&mut self, input: f64) -> f64

Filter a single sample and return the filtered result.

It is mandatory to operate on f32 values in range -1.0..=1.0, which is also the default in DSP. The returned value is also guaranteed to be in that range.

pub const fn reset(&mut self)

Reset the internal filter state.

Trait Implementations

impl<T: Clone> Clone for LowpassFilter<T>

fn clone(&self) -> LowpassFilter<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for LowpassFilter<T>

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

Formats the value using the given formatter.