Skip to content

Commit

Permalink
Add explanations to alpha values
Browse files Browse the repository at this point in the history
  • Loading branch information
klounis committed Dec 8, 2023
1 parent 37c5744 commit c796061
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion rocketpy/mathutils/function.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""
Expand Down

0 comments on commit c796061

Please sign in to comment.