From c79606167848d9180c7588c17e5b5caf1462d2ca Mon Sep 17 00:00:00 2001 From: klounis Date: Fri, 8 Dec 2023 16:38:56 +0100 Subject: [PATCH] Add explanations to alpha values --- rocketpy/mathutils/function.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/rocketpy/mathutils/function.py b/rocketpy/mathutils/function.py index 28bd040e8..9a958fcfa 100644 --- a/rocketpy/mathutils/function.py +++ b/rocketpy/mathutils/function.py @@ -1092,9 +1092,12 @@ def low_pass_filter(self, alpha): Implements a low pass filter with a moving average filter Parameters: - - signal (numpy.ndarray): The input signal - alpha (float): attenuation coefficient, 0 < alpha < 1 + - for a given dataset, the larger alpha is, the more closely the filtered function returned will match the function + - the smaller alpha is, the smoother the filtered function returned will be (but with a phase shift) + + Returns: - filtered_function (Function): The function that filter the incoming source """