added more docstrings and moved chirpsim

2023-01-12 09:04:51 +01:00
parent ce1c0fa319
commit 3af4426a26
2 changed files with 8 additions and 6 deletions
--- a/code/modules/filters.py
+++ b/code/modules/filters.py
@@ -17,13 +17,14 @@ def bandpass_filter(
    rate : float
        The sampling rate
    lowf : float
-        The low frequency cutoff
+        The low cutoff frequency
    highf : float
-        The high frequency cutoff
+        The high cutoff frequency

    Returns
    -------
-    np.ndarray : The filtered data
+    np.ndarray
+        The filtered data
    """
    sos = butter(2, (lowf, highf), "bandpass", fs=rate, output="sos")
    fdata = sosfiltfilt(sos, data)