FilterConfig

rustneuro::filter

Struct FilterConfig 

Source 
pub struct FilterConfig {
    pub filter_type: FilterType,
    pub cutoff: f64,
    pub q: f64,
    pub sample_rate: f64,
    pub gain: Option<f64>,
}
Expand description

Configuration parameters for a filter.

  • For most filters, gain is ignored.
  • For a Peak filter, a non-zero gain in dB is required.

Fields§

§filter_type: FilterType§cutoff: f64§q: f64§sample_rate: f64§gain: Option<f64>

Implementations§

Source§

impl FilterConfig

Source

pub fn new( filter_type: FilterType, cutoff: f64, q: f64, sample_rate: f64, gain: Option<f64>, ) -> Result<Self, EEGError>

Creates a new FilterConfig.

§Errors
  • Returns an error if the sampling rate or Q factor are not positive.
  • Returns an error if the cutoff frequency is not below the Nyquist limit.
  • For Peak filters, returns an error if gain is not provided.

Trait Implementations§

Source§

impl Clone for FilterConfig

Source§

fn clone(&self) -> FilterConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FilterConfig

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.