API reference

OneEuroFilter Class

The Interaction SDK's canonical implementation of IOneEuroFilter<TData>, based on the paper https://hal.inria.fr/hal-00670496/document.
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).

Fields

_DEFAULT_FREQUENCY_HZ : const float
Default sampling rate expected by the OneEuroFilter.
This is used to determine the default timestep (second argument) for Step(float, float).
Signature
const float Oculus.Interaction.Input.OneEuroFilter._DEFAULT_FREQUENCY_HZ

Properties

Value : float
[Get]
Implementation of IOneEuroFilter<TData>.Value; for details, please refer to the related documentation provided for that interface.
Signature
float Oculus.Interaction.Input.OneEuroFilter.Value

Methods

Reset ()
Implementation of IOneEuroFilter<TData>.Reset; for details, please refer to the related documentation provided for that interface.
Signature
void Oculus.Interaction.Input.OneEuroFilter.Reset()
Returns
void
SetProperties ( properties )
Implementation of IOneEuroFilter<TData>.SetProperties(in OneEuroFilterPropertyBlock); for details, please refer to the related documentation provided for that interface.
Signature
void Oculus.Interaction.Input.OneEuroFilter.SetProperties(in OneEuroFilterPropertyBlock properties)
Parameters
properties: in OneEuroFilterPropertyBlock
Returns
void
Step ( newValue , deltaTime )
Implementation of IOneEuroFilter<TData>.Step(TData, float); for details, please refer to the related documentation provided for that interface.
Signature
float Oculus.Interaction.Input.OneEuroFilter.Step(float newValue, float deltaTime)
Parameters
newValue: float
deltaTime: float
Returns
float

Static Methods

CreateFloat ()
Factory method for creating One Euro filter instances to filter float signals.
Signature
static IOneEuroFilter<float> Oculus.Interaction.Input.OneEuroFilter.CreateFloat()
Returns
IOneEuroFilter< float >  A new instance of an IOneEuroFilter<TData> for float
CreatePose ()
Factory method for creating One Euro filter instances to filter Pose signals.
Signature
static IOneEuroFilter<Pose> Oculus.Interaction.Input.OneEuroFilter.CreatePose()
Returns
IOneEuroFilter< Pose >  A new instance of an IOneEuroFilter<TData> for Pose
CreateQuaternion ()
Factory method for creating One Euro filter instances to filter Quaternion signals.
Signature
static IOneEuroFilter<Quaternion> Oculus.Interaction.Input.OneEuroFilter.CreateQuaternion()
Returns
IOneEuroFilter< Quaternion >  A new instance of an IOneEuroFilter<TData> for Quaternion
CreateVector2 ()
Factory method for creating One Euro filter instances to filter Vector2 signals.
Signature
static IOneEuroFilter<Vector2> Oculus.Interaction.Input.OneEuroFilter.CreateVector2()
Returns
IOneEuroFilter< Vector2 >  A new instance of an IOneEuroFilter<TData> for Vector2
CreateVector3 ()
Factory method for creating One Euro filter instances to filter Vector3 signals.
Signature
static IOneEuroFilter<Vector3> Oculus.Interaction.Input.OneEuroFilter.CreateVector3()
Returns
IOneEuroFilter< Vector3 >  A new instance of an IOneEuroFilter<TData> for Vector3
CreateVector4 ()
Factory method for creating One Euro filter instances to filter Vector4 signals.
Signature
static IOneEuroFilter<Vector4> Oculus.Interaction.Input.OneEuroFilter.CreateVector4()
Returns
IOneEuroFilter< Vector4 >  A new instance of an IOneEuroFilter<TData> for Vector4