suggested changes to moving_average

Author: MikeSullivan7

ratapi/utils/plotting.py

@@ -763,7 +763,7 @@ def plot_one_hist(
     results: ratapi.outputs.BayesResults,
     param: int | str,
     smooth: bool = True,
-    sigma: float | None = None,
+    window_size: int = 8,
     estimated_density: Literal["normal", "lognor", "kernel", None] = None,
     axes: Axes | None = None,
     block: bool = False,
@@ -783,9 +783,9 @@ def plot_one_hist(
     smooth : bool, default True
         Whether to apply Gaussian smoothing to the histogram.
         Defaults to True.
-    sigma: float or None, default None
-        If given, is used as the sigma-parameter for the Gaussian smoothing.
-        If None, the default (1/3rd of parameter chain standard deviation) is used.
+    window_size : int, default 8
+        The width of the smoothing window centered around the element being averaged.
+        The window moves down the length of the data, computing an average over the elements within each window.
     estimated_density : 'normal', 'lognor', 'kernel' or None, default None
         If None (default), ignore. Else, add an estimated density
         of the given form on top of the histogram by the following estimations:
@@ -826,7 +826,7 @@ def plot_one_hist(
     sd_y = np.std(parameter_chain)
 
     if smooth:
-        counts = moving_avg(counts)
+        counts = moving_average(counts, window_size=window_size)
     axes.hist(
         bins[:-1],
         bins,
@@ -1233,7 +1233,7 @@ def plot_bayes(project: ratapi.Project, results: ratapi.outputs.BayesResults):
         raise ValueError("Bayes plots are only available for the results of Bayesian analysis (NS or DREAM)")
 
 
-def moving_avg(data: np.ndarray, window_size: int = 8) -> list[float]:
+def moving_average(data: np.ndarray, window_size: int = 8) -> list[float]:
     """Calculate the moving average of an array with a given window size.
 
     This is a python equivalent to MATLABs smoothdata(A, 'movmean')
@@ -1247,10 +1247,10 @@ def moving_avg(data: np.ndarray, window_size: int = 8) -> list[float]:
                   computing an average over the elements within each window.
 
     """
-    i = 0
+    assert 0 <= window_size <= len(data)
     moving_averages = []
 
-    while i < len(data):
+    for i in range(len(data)):
         start_window_ind = floor(float(i - window_size / 2)) if i - window_size / 2 > 0 else 0
         end_window_ind = floor(float(i + window_size / 2)) if i + window_size / 2 < len(data) else len(data)
         window_average = np.sum(data[start_window_ind:end_window_ind]) / (end_window_ind + 0 - start_window_ind)