Struct FilterSpec 

pub struct FilterSpec {
    pub design: FilterDesign,
    pub mode: FilterMode,
    pub start: FilterStart,
}

A filter to design, the direction(s) it runs in, and where forward passes start.

Fields

design: FilterDesign

mode: FilterMode

start: FilterStart

Implementations

impl FilterSpec

pub fn butterworth(order: usize, band: FilterBand) -> Self

pub fn bandpass(low_hz: f64, high_hz: f64) -> Self

pub fn highpass(cutoff_hz: f64) -> Self

pub fn lowpass(cutoff_hz: f64) -> Self

pub fn bandstop(low_hz: f64, high_hz: f64) -> Self

pub fn chebyshev1(order: usize, ripple_db: f64, band: FilterBand) -> Self

pub fn bessel(order: usize, band: FilterBand) -> Self

Bessel of order per edge (phase-normalised, as scipy.signal.bessel), zero phase.

pub fn notch(freq_hz: f64, q: f64) -> Self

pub fn sos(sos: Sos) -> Self

pub fn with_order(self, new_order: usize) -> Self

Returns the same filter with order (Butterworth / Chebyshev; ignored for notch / explicit SOS).

pub fn with_mode(self, mode: FilterMode) -> Self

pub fn with_start(self, start: FilterStart) -> Self

Returns the same filter starting forward passes at start.

pub fn design(&self, sample_rate: f64) -> Result<Sos, OpsError>

Designs the second-order sections for sample_rate Hz, validating the parameters.

Errors

OpsError when the design is invalid at sample_rate: non-positive sample rate, zero order, a cutoff outside (0, Nyquist), band edges out of order, a bad q or ripple. Explicit sections fail Sos::validate.

pub fn settling(&self, sample_rate: f64) -> Result<(usize, usize), OpsError>

(left, right) samples needed around a chunk for its interior to match whole-recording filtering (impulse response decayed below DEFAULT_SETTLING_TOLERANCE).

Errors

As Self::design.

Trait Implementations

impl Clone for FilterSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilterSpec

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

Formats the value using the given formatter.

impl PartialEq for FilterSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FilterSpec