MovingQuantileFilter

hrv_algos::preprocessing::outliers

Struct MovingQuantileFilter 

Source 
pub struct MovingQuantileFilter { /* private fields */ }
Expand description

Detects artefacts (ectopic, long, short, missed, extra beats) in an RR interval series using rolling quantiles and threshold-based classification.

The algorithm is based on the Systole Python package by Legrand and Allen (2022). Link: https://github.com/embodied-computation-group/systole

§References

  • Legrand, N. & Allen, M., (2022). Systole: A python package for cardiac signal synchrony and analysis. Journal of Open Source Software, 7(69), 3832, https://doi.org/10.21105/joss.03832

Implementations§

Source§

impl MovingQuantileFilter

Source

pub fn new( slope: Option<f64>, intercept: Option<f64>, quantile_scale: Option<f64>, ) -> Self

Creates a new MovingQuantileFilter instance. The default values for slope, intercept, and quantile scale are 0.13, 0.17, and 5.2, respectively. The default window sizes for median and threshold calculations are 11 and 91, respectively.

§Arguments
  • slope - The slope value for the threshold calculation. Default is 0.13.
  • intercept - The intercept value for the threshold calculation. Default is 0.17.
  • quantile_scale - The scaling factor for the threshold calculation. Default is 5.2.
§Returns

A new MovingQuantileFilter instance.

Source

pub fn set_slope(&mut self, slope: f64) -> Result<()>

Sets the slope value for the threshold comparison.

§Arguments
  • slope - The slope value for the threshold calculation.
§Returns

A Result indicating success or failure of reclassification.

Source

pub fn set_intercept(&mut self, intercept: f64) -> Result<()>

Sets the intercept value for the threshold comparison.

§Arguments
  • intercept - The intercept value for the threshold calculation.
§Returns

A Result indicating success or failure of reclassification.

Source

pub fn set_quantile_scale(&mut self, quantile_scale: f64) -> Result<()>

Sets the quantile scale value for the threshold comparison.

§Arguments
  • quantile_scale - The scaling factor for the threshold calculation.
§Returns

A Result indicating success or failure of reclassification.

Source

pub fn get_slope(&self) -> f64

Source

pub fn get_intercept(&self) -> f64

Source

pub fn get_quantile_scale(&self) -> f64

Trait Implementations§

Source§

impl Clone for MovingQuantileFilter

Source§

fn clone(&self) -> MovingQuantileFilter

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 MovingQuantileFilter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl OutlierClassifier for MovingQuantileFilter

Source§

fn add_data(&mut self, data: &[f64]) -> Result<()>

Adds a slice of data to the classifier for outlier detection. Read more
Source§

fn get_data(&self) -> &[f64]

Access to the classified time-series data. Read more
Source§

fn get_classification(&self) -> &[OutlierType]

Access to the classification of the time-series data. Read more
Source§

fn get_filtered_data(&self) -> Vec<f64>

Returns the filtered data without any outliers. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V