Skip to content

Commit

Permalink
DOC: Refactor low_pass_filter docstring to pass sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
Gui-FernandesBR committed Dec 17, 2023
1 parent 18881b2 commit 7eb4a73
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions rocketpy/mathutils/function.py
Original file line number Diff line number Diff line change
Expand Up @@ -1087,21 +1087,20 @@ def to_frequency_domain(self, lower, upper, sampling_frequency, remove_dc=True):
)

def low_pass_filter(self, alpha):
"""
Implements a low pass filter with a moving average filter
"""Implements a low pass filter with a moving average filter
Parameters:
Parameters
----------
- alpha : float
Attenuation coefficient, 0 < alpha < 1
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
Returns
-------
Function
The function with the incoming source filtered
"""
filtered_signal = np.zeros_like(self.source)
Expand Down

0 comments on commit 7eb4a73

Please sign in to comment.