diff --git a/common/src/core/Utils/Animation/LowpassFilter.cs b/common/src/core/Utils/Animation/LowpassFilter.cs index a4f3e0b94..40bc397b2 100644 --- a/common/src/core/Utils/Animation/LowpassFilter.cs +++ b/common/src/core/Utils/Animation/LowpassFilter.cs @@ -7,6 +7,9 @@ namespace VVVV.Utils.Animation /// public class LowpassFilter { + /// + /// Initialize the filter + /// public LowpassFilter() { FFirstTime = true; @@ -15,6 +18,9 @@ public LowpassFilter() protected bool FFirstTime; protected double FLastFilterValue; + /// + /// Last filter value + /// public double Last { get @@ -23,17 +29,23 @@ public double Last } } - public double Filter(double x, double alpha) + /// + /// Gets the next filter value, applies alpha * value + (1 - alpha) * lastValue + /// + /// + /// + /// + public double Filter(double value, double alpha = 1) { double filterValue = 0; if (FFirstTime) { FFirstTime = false; - filterValue = x; + filterValue = value; } else { - filterValue = alpha * x + (1 - alpha) * FLastFilterValue; + filterValue = alpha * value + (1 - alpha) * FLastFilterValue; } FLastFilterValue = filterValue;