From cac829ed9632fce7c88d3e0e12f52b90ae2c6e99 Mon Sep 17 00:00:00 2001
From: pswain <peter.swain@ed.ac.uk>
Date: Thu, 9 May 2024 16:47:15 +0100
Subject: [PATCH] change: renamed butterfilter to butterworth

---
 src/wela/{butterfilter.py => butterworth_filter.py} | 2 +-
 src/wela/plotting.py                                | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)
 rename src/wela/{butterfilter.py => butterworth_filter.py} (96%)

diff --git a/src/wela/butterfilter.py b/src/wela/butterworth_filter.py
similarity index 96%
rename from src/wela/butterfilter.py
rename to src/wela/butterworth_filter.py
index 7322a9d..a9e100b 100644
--- a/src/wela/butterfilter.py
+++ b/src/wela/butterworth_filter.py
@@ -2,7 +2,7 @@ import numpy as np
 from scipy import signal
 
 
-def butterfilter(timeseries, params=None):
+def butterworth_filter(timeseries, params=None):
     """Apply Butterworth filter to time series arranged in rows."""
     # second-order-sections output
     # by default, using a digital filter
diff --git a/src/wela/plotting.py b/src/wela/plotting.py
index 0d9de10..99189d9 100644
--- a/src/wela/plotting.py
+++ b/src/wela/plotting.py
@@ -4,7 +4,7 @@ import matplotlib.cm
 import matplotlib.pylab as plt
 import numpy as np
 import numpy.matlib
-from wela.butterfilter import butterfilter
+from wela.butterworth_filter import butterworth_filter
 
 
 def kymograph(
@@ -571,7 +571,7 @@ def bud_to_bud_plot(
     title: str, optional
         Title for plot.
     filter: boolean
-        If True, apply a butter filter to each time series.
+        If True, apply a butterworth filter to each time series.
 
     Example
     -------
@@ -585,7 +585,7 @@ def bud_to_bud_plot(
         t, signal_data = dl.get_time_series(signal, group=group, df=df)
         t, buddings = dl.get_time_series("buddings", group=group, df=df)
     if filter:
-        signal_data = butterfilter(signal_data)
+        signal_data = butterworth_filter(signal_data)
     if np.max(t) > 48:
         # convert to hours
         t = t / 60
-- 
GitLab