[ENH] - Add get_freq_ind

specparam/tests/utils/test_data.py

@@ -9,6 +9,13 @@
 ###################################################################################################
 ###################################################################################################
 
+def test_get_freq_ind():
+
+    freqs = np.array([1, 2, 3, 4, 5])
+
+    assert get_freq_ind(freqs, 2.2) == 1
+    assert get_freq_ind(freqs, 3.7) == 3
+
 def test_compute_average():
 
     data = np.array([[0., 1., 2., 3., 4., 5.],

specparam/utils/data.py

@@ -30,6 +30,25 @@
 ###################################################################################################
 ###################################################################################################
 
+def get_freq_ind(freqs, freq):
+    """Get the index of the  closest frequency value to a specified input frequency.
+
+    Parameters
+    ----------
+    freqs : 1d array
+        Frequency values.
+    freq : float
+        Frequency value to select closest index to.
+
+    Returns
+    -------
+    int
+        Index of closest value in `freqs` to `freq`.
+    """
+
+    return np.argmin(np.abs(freqs - freq))
+
+
 def compute_average(data, average='mean'):
     """Compute the average across an array of data.
 

specparam/utils/reports.py

@@ -29,6 +29,7 @@ def methods_report_info(model_obj=None, concise=False):
         print(gen_settings_str(model_obj, concise=concise))
         print(gen_freq_range_str(model_obj, concise=concise))
 
+
 def methods_report_text(model_obj=None):
     """Prints out a text template of methods reporting information.