From d8dce0cd775efedc3d16b46f6f3f5c42df8636af Mon Sep 17 00:00:00 2001 From: clementm Date: Tue, 12 Dec 2023 16:14:06 +0100 Subject: [PATCH] low pass filter docstring updated --- rocketpy/mathutils/function.py | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/rocketpy/mathutils/function.py b/rocketpy/mathutils/function.py index 84ec9853c..2a161e905 100644 --- a/rocketpy/mathutils/function.py +++ b/rocketpy/mathutils/function.py @@ -1092,14 +1092,18 @@ def low_pass_filter(self, alpha): Implements a low pass filter with a moving average filter Parameters: - - 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) - + ---------- + - 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 + ---------- + - filtered_function : Function + The function with the incoming source filtered """ filtered_signal = np.zeros_like(self.source) filtered_signal[0] = self.source[0]