API reference
API reference
Select your platform
No SDKs available
No versions available

IOneEuroFilter Interface

Core interface for One Euro filter implementations.
An academic relative of the $-family of gesture recognizers, the One Euro filter is designed to make effective and efficient noise reduction in signal processing accessible to non-domain experts. Thus, this filter focuses on balancing result quality (bettering more naive approaches) with developer ease-of-use (contrasted with more sophisticated techniques such as Kalman filters).
The Interaction SDK's canonical implementation of this interface is OneEuroFilter.

Properties

Value : TData
[Get]
The last value returned by Step(TData, float), which is the up-to-date known filtered value of the signal being processed by this filter.
Signature
TData Value

Methods

Reset ()
Clear previous values and reset the filter.
Signature
void Reset()
Returns
void
SetProperties ( properties )
Update the parameters of the filter.
Signature
void SetProperties(in OneEuroFilterPropertyBlock properties)
Parameters
Returns
void
Step ( rawValue , deltaTime )
Update the filter with a new noisy value to be smoothed.
This is a destructive operation that should be run once per frame, as calling this updates the previous frame data.
Signature
TData Step(TData rawValue, float deltaTime=1f/OneEuroFilter._DEFAULT_FREQUENCY_HZ)
Parameters
rawValue: TData  The noisy value to be filtered
deltaTime: float  The time between steps, use to derive filter frequency. Omitting this value will fallback to OneEuroFilter._DEFAULT_FREQUENCY_HZ
Returns
TData  The filtered value, equivalent to Value