Move info & index related tools to their own internal file

Author: TomDonoghue

fooof/core/info.py

@@ -0,0 +1,47 @@
+"""Internal functions to manage info related to FOOOF objects."""
+
+def get_obj_desc():
+    """Get dictionary specifying FOOOF object names and kind of attributes.
+
+    Returns
+    -------
+    attibutes : dict
+        Mapping of FOOOF object attributes, and what kind of data they are.
+    """
+
+    attributes = {'results' : ['aperiodic_params_', 'peak_params_', 'error_',
+                               'r_squared_', '_gaussian_params'],
+                  'settings' : ['peak_width_limits', 'max_n_peaks', 'min_peak_amplitude',
+                                'peak_threshold', 'aperiodic_mode'],
+                  'data' : ['power_spectrum', 'freq_range', 'freq_res'],
+                  'data_info' : ['freq_range', 'freq_res'],
+                  'arrays' : ['freqs', 'power_spectrum', 'aperiodic_params_',
+                              'peak_params_', '_gaussian_params']}
+
+    return attributes
+
+
+def get_data_indices(aperiodic_mode):
+    """Get a dictionary mapping the column labels to indices in FOOOF data (FOOOFResults).
+
+    Parameters
+    ----------
+    aperiodic_mode : {'fixed', 'knee'}
+        Which approach taken to fit the aperiodic component.
+
+    Returns
+    -------
+    indices : dict
+        Mapping for data columns to the column indices in which they appear.
+    """
+
+    indices = {
+        'CF'  : 0,
+        'Amp' : 1,
+        'BW'  : 2,
+        'offset' : 0,
+        'knee'      : 1 if aperiodic_mode == 'knee' else None,
+        'exponent'  : 1 if aperiodic_mode == 'fixed' else 2
+    }
+
+    return indices

fooof/core/io.py

@@ -5,7 +5,8 @@
 import json
 from json import JSONDecodeError
 
-from fooof.core.utils import dict_array_to_lst, dict_select_keys, dict_lst_to_array, get_obj_desc
+from fooof.core.info import get_obj_desc
+from fooof.core.utils import dict_array_to_lst, dict_select_keys, dict_lst_to_array
 
 ###################################################################################################
 ###################################################################################################

fooof/core/utils.py

@@ -100,53 +100,6 @@ def check_array_dim(arr):
     return np.empty([0, 3]) if arr.ndim == 1 else arr
 
 
-def get_obj_desc():
-    """Get dictionary specifying FOOOF object names and kind of attributes.
-
-    Returns
-    -------
-    attibutes : dict
-        Mapping of FOOOF object attributes, and what kind of data they are.
-    """
-
-    attributes = {'results' : ['aperiodic_params_', 'peak_params_', 'error_',
-                               'r_squared_', '_gaussian_params'],
-                  'settings' : ['peak_width_limits', 'max_n_peaks', 'min_peak_amplitude',
-                                'peak_threshold', 'aperiodic_mode'],
-                  'data' : ['power_spectrum', 'freq_range', 'freq_res'],
-                  'data_info' : ['freq_range', 'freq_res'],
-                  'arrays' : ['freqs', 'power_spectrum', 'aperiodic_params_',
-                              'peak_params_', '_gaussian_params']}
-
-    return attributes
-
-
-def get_data_indices(aperiodic_mode):
-    """Get a dictionary mapping the column labels to indices in FOOOF data (FOOOFResults).
-
-    Parameters
-    ----------
-    aperiodic_mode : {'fixed', 'knee'}
-        Which approach taken to fit the aperiodic component.
-
-    Returns
-    -------
-    indices : dict
-        Mapping for data columns to the column indices in which they appear.
-    """
-
-    indices = {
-        'CF'  : 0,
-        'Amp' : 1,
-        'BW'  : 2,
-        'offset' : 0,
-        'knee'      : 1 if aperiodic_mode == 'knee' else None,
-        'exponent'  : 1 if aperiodic_mode == 'fixed' else 2
-    }
-
-    return indices
-
-
 def check_iter(obj, length):
     """Check an object to ensure that it is iterable, and make it iterable if not.
 

fooof/fit.py

@@ -40,7 +40,8 @@
 from fooof.core.io import save_fm, load_json
 from fooof.core.reports import save_report_fm
 from fooof.core.funcs import gaussian_function, get_ap_func, infer_ap_func
-from fooof.core.utils import group_three, check_array_dim, get_obj_desc
+from fooof.core.utils import group_three, check_array_dim
+from fooof.core.info import get_obj_desc
 from fooof.core.modutils import copy_doc_func_to_method
 from fooof.core.strings import gen_settings_str, gen_results_str_fm, gen_issue_str, gen_wid_warn_str
 

fooof/funcs.py

@@ -4,7 +4,8 @@
 
 from fooof import FOOOFGroup
 from fooof.synth.gen import gen_freqs
-from fooof.utils import get_obj_desc, compare_info
+from fooof.utils import compare_info
+from fooof.core.info import get_obj_desc
 
 ###################################################################################################
 ###################################################################################################

fooof/group.py

@@ -16,7 +16,7 @@
 from fooof.core.reports import save_report_fg
 from fooof.core.strings import gen_results_str_fg
 from fooof.core.io import save_fg, load_jsonlines
-from fooof.core.utils import get_data_indices
+from fooof.core.info import get_data_indices
 from fooof.core.modutils import copy_doc_func_to_method, copy_doc_class, safe_import
 
 ###################################################################################################

fooof/synth/params.py

@@ -3,7 +3,8 @@
 import numpy as np
 
 from fooof.core.funcs import infer_ap_func
-from fooof.core.utils import check_flat, get_data_indices
+from fooof.core.utils import check_flat
+from fooof.core.info import get_data_indices
 from fooof.data import SynParams
 
 ###################################################################################################

fooof/tests/test_core_info.py

@@ -0,0 +1,31 @@
+"""Tests for FOOOF core.info."""
+
+from fooof.core.info import *
+
+###################################################################################################
+###################################################################################################
+
+def test_get_obj_desc(tfm):
+
+    desc =  get_obj_desc()
+    objs = dir(tfm)
+
+    # Test that everything in dict is a valid component of the fooof object
+    for ke, va in desc.items():
+        for it in va:
+            assert it in objs
+
+def test_get_data_indices():
+
+    indices_fixed = get_data_indices('fixed')
+    assert indices_fixed
+    for ke, va in indices_fixed.items():
+        if ke == 'knee':
+            assert not va
+        else:
+            assert isinstance(va, int)
+
+    indices_knee = get_data_indices('knee')
+    assert indices_knee
+    for ke, va in indices_knee.items():
+        assert isinstance(va, int)

fooof/tests/test_core_io.py

@@ -4,7 +4,7 @@
 import pkg_resources as pkg
 
 from fooof import FOOOF
-from fooof.core.utils import get_obj_desc
+from fooof.core.info import get_obj_desc
 
 from fooof.core.io import *
 

fooof/tests/test_core_utils.py

@@ -59,33 +59,6 @@ def test_check_array_dim():
     out = check_array_dim(np.array([1, 2, 3]))
     assert out.shape == (0, 3)
 
-def test_get_obj_desc():
-
-    desc =  get_obj_desc()
-
-    tfm = FOOOF()
-    objs = dir(tfm)
-
-    # Test that everything in dict is a valid component of the fooof object
-    for ke, va in desc.items():
-        for it in va:
-            assert it in objs
-
-def test_get_data_indices():
-
-    indices_fixed = get_data_indices('fixed')
-    assert indices_fixed
-    for ke, va in indices_fixed.items():
-        if ke == 'knee':
-            assert not va
-        else:
-            assert isinstance(va, int)
-
-    indices_knee = get_data_indices('knee')
-    assert indices_knee
-    for ke, va in indices_knee.items():
-        assert isinstance(va, int)
-
 def test_check_iter():
 
     # Note: generator case not tested