Struct Dejitterer 

pub struct Dejitterer {
    pub t0: u32,
    pub samples_since_t0: u32,
    pub w0: f64,
    pub w1: f64,
    pub p00: f64,
    pub p11: f64,
    pub p01: f64,
    pub lam: f64,
}

The recursive least squares filter that removes jitter.

The filter fits t = w0 + w1 * n over the sample index n. SPEC.md 8.5.

Fields

t0: u32

The first timestamp, truncated to a whole number.

liblsl stores this in an unsigned integer (src/time_postprocessor.h:18). The truncation is part of the behavior, because the value comes back at the end of every call.

samples_since_t0: u32

The number of samples since t0.

w0: f64

The intercept of the fit.

w1: f64

The slope of the fit.

p00: f64

The inverse covariance element P00.

p11: f64

The inverse covariance element P11.

p01: f64

The off-diagonal inverse covariance element.

lam: f64

The forgetting factor.

Implementations

impl Dejitterer

pub fn new(t0: f64, srate: f64, halftime: f64) -> Self

Build a filter for a stream.

src/time_postprocessor.cpp:104-110. A rate of zero or less leaves the forgetting factor at zero, and the filter then returns every timestamp unchanged.

pub fn is_initialized(&self) -> bool

True once a first timestamp has set the baseline.

liblsl tests the baseline against zero (src/time_postprocessor.h:35). A first timestamp below 1.0 therefore truncates to zero, and the filter reads as uninitialized.

pub fn smoothing_applicable(&self) -> bool

True when the filter changes a timestamp.

pub fn dejitter(&mut self, t: f64) -> f64

Take one timestamp and return the fitted value.

The operation order matches src/time_postprocessor.cpp:112-131 line for line. Do not tidy this function.

pub fn skip_samples(&mut self, skipped: u32)

Move the sample counter forward for samples that never arrived.

src/time_postprocessor.cpp:133-135.

Trait Implementations

impl Clone for Dejitterer

fn clone(&self) -> Dejitterer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dejitterer

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

Formats the value using the given formatter.

impl Default for Dejitterer

fn default() -> Self

The state before the first sample.

src/time_postprocessor.h:20-26 gives every initial value.

impl PartialEq for Dejitterer

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Dejitterer