Update core.info names

Author: TomDonoghue

fooof/core/info.py

@@ -1,7 +1,10 @@
 """Internal functions to manage info related to FOOOF objects."""
 
-def get_obj_desc():
-    """Get dictionary specifying FOOOF object names and kind of attributes.
+###################################################################################################
+###################################################################################################
+
+def get_description():
+    """Get dictionary specifying FOOOF attributes, and what kind of data they store.
 
     Returns
     -------
@@ -24,8 +27,8 @@ def get_obj_desc():
     return attributes
 
 
-def get_data_indices(aperiodic_mode):
-    """Get a dictionary mapping the column labels to indices in FOOOF data (FOOOFResults).
+def get_indices(aperiodic_mode):
+    """Get a dictionary mapping indices of FOOOF params to column labels.
 
     Parameters
     ----------
@@ -35,7 +38,7 @@ def get_data_indices(aperiodic_mode):
     Returns
     -------
     indices : dict
-        Mapping for data columns to the column indices in which they appear.
+        Mapping of the column indices for the FOOOF model fit params.
     """
 
     indices = {

fooof/core/io.py

@@ -5,7 +5,7 @@
 import json
 from json import JSONDecodeError
 
-from fooof.core.info import get_obj_desc
+from fooof.core.info import get_description
 from fooof.core.utils import dict_array_to_lst, dict_select_keys, dict_lst_to_array
 
 ###################################################################################################
@@ -89,7 +89,7 @@ def save_fm(fm, file_name, file_path=None, append=False,
 
     # Set and select which variables to keep. Use a set to drop any potential overlap
     #  Note that results also saves frequency information to be able to recreate freq vector
-    attributes = get_obj_desc()
+    attributes = get_description()
     keep = set((attributes['results'] + attributes['meta_data'] if save_results else []) + \
                (attributes['settings'] if save_settings else []) + \
                (attributes['data'] if save_data else []))
@@ -183,7 +183,7 @@ def load_json(file_name, file_path):
         dat = json.loads(file_name.readline())
 
     # Get dictionary of available attributes, and convert specified lists back into arrays
-    dat = dict_lst_to_array(dat, get_obj_desc()['arrays'])
+    dat = dict_lst_to_array(dat, get_description()['arrays'])
 
     return dat
 

fooof/fit.py

@@ -39,7 +39,7 @@
 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
-from fooof.core.info import get_obj_desc, get_data_indices
+from fooof.core.info import get_description, get_indices
 from fooof.core.modutils import copy_doc_func_to_method
 from fooof.core.strings import (gen_settings_str, gen_results_fm_str,
                                 gen_issue_str, gen_width_warning_str)
@@ -256,7 +256,7 @@ def add_settings(self, fooof_settings):
             A FOOOF data object containing the settings for a FOOOF model.
         """
 
-        for setting in get_obj_desc()['settings']:
+        for setting in get_description()['settings']:
             setattr(self, setting, getattr(fooof_settings, setting))
 
         self._check_loaded_settings(fooof_settings._asdict())
@@ -271,7 +271,7 @@ def add_meta_data(self, fooof_meta_data):
             A FOOOF meta data object containing meta data information.
         """
 
-        for meta_dat in get_obj_desc()['meta_data']:
+        for meta_dat in get_description()['meta_data']:
             setattr(self, meta_dat, getattr(fooof_meta_data, meta_dat))
 
         self._regenerate_freqs()
@@ -449,7 +449,7 @@ def get_settings(self):
             Object containing the settings from the current FOOOF object.
         """
 
-        return FOOOFSettings(**{key : getattr(self, key) for key in get_obj_desc()['settings']})
+        return FOOOFSettings(**{key : getattr(self, key) for key in get_description()['settings']})
 
 
     def get_meta_data(self):
@@ -461,7 +461,7 @@ def get_meta_data(self):
             Object containing meta data from the current FOOOF object.
         """
 
-        return FOOOFMetaData(**{key : getattr(self, key) for key in get_obj_desc()['meta_data']})
+        return FOOOFMetaData(**{key : getattr(self, key) for key in get_description()['meta_data']})
 
 
     def get_params(self, name, col=None):
@@ -492,7 +492,7 @@ def get_params(self, name, col=None):
 
         # If col specified as string, get mapping back to integer
         if isinstance(col, str):
-            col = get_data_indices(self.aperiodic_mode)[col]
+            col = get_indices(self.aperiodic_mode)[col]
 
         # Extract the request data field from object
         out = getattr(self, name + '_')
@@ -521,7 +521,7 @@ def get_results(self):
         """
 
         return FOOOFResults(**{key.strip('_') : getattr(self, key) \
-            for key in get_obj_desc()['results']})
+            for key in get_description()['results']})
 
 
     @copy_doc_func_to_method(plot_fm)
@@ -1028,7 +1028,7 @@ def _check_loaded_results(self, data):
 
         # If results loaded, check dimensions of peak parameters
         #  This fixes an issue where they end up the wrong shape if they are empty (no peaks)
-        if set(get_obj_desc()['results']).issubset(set(data.keys())):
+        if set(get_description()['results']).issubset(set(data.keys())):
             self.peak_params_ = check_array_dim(self.peak_params_)
             self.gaussian_params_ = check_array_dim(self.gaussian_params_)
 
@@ -1044,10 +1044,10 @@ def _check_loaded_settings(self, data):
 
         # If settings not loaded from file, clear from object, so that default
         #  settings, which are potentially wrong for loaded data, aren't kept
-        if not set(get_obj_desc()['settings']).issubset(set(data.keys())):
+        if not set(get_description()['settings']).issubset(set(data.keys())):
 
             # Reset all public settings to None
-            for setting in get_obj_desc()['settings']:
+            for setting in get_description()['settings']:
                 setattr(self, setting, None)
 
             # Infer whether knee fitting was used, if aperiodic params have been loaded

fooof/group.py

@@ -16,7 +16,7 @@
 from fooof.core.reports import save_report_fg
 from fooof.core.strings import gen_results_fg_str
 from fooof.core.io import save_fg, load_jsonlines
-from fooof.core.info import get_data_indices
+from fooof.core.info import get_indices
 from fooof.core.modutils import copy_doc_func_to_method, copy_doc_class, safe_import
 
 ###################################################################################################
@@ -221,7 +221,7 @@ def get_params(self, name, col=None):
 
         # If col specified as string, get mapping back to integer
         if isinstance(col, str):
-            col = get_data_indices(self.aperiodic_mode)[col]
+            col = get_indices(self.aperiodic_mode)[col]
 
         # Pull out the requested data field from the group data
         # As a special case, peak_params are pulled out in a way that appends

fooof/sim/params.py

@@ -4,7 +4,7 @@
 
 from fooof.core.funcs import infer_ap_func
 from fooof.core.utils import check_flat
-from fooof.core.info import get_data_indices
+from fooof.core.info import get_indices
 from fooof.data import SimParams
 
 ###################################################################################################
@@ -45,7 +45,7 @@ def update_sim_ap_params(sim_params, delta, field=None):
         delta = list([delta]) if not isinstance(delta, list) else delta
 
         for cur_field, cur_delta in zip(field, delta):
-            dat_ind = get_data_indices(infer_ap_func(sim_params.aperiodic_params))[cur_field]
+            dat_ind = get_indices(infer_ap_func(sim_params.aperiodic_params))[cur_field]
             ap_params[dat_ind] = ap_params[dat_ind] + cur_delta
 
     new_sim_params = SimParams(ap_params, *sim_params[1:])

fooof/tests/test_core_info.py

@@ -5,27 +5,27 @@
 ###################################################################################################
 ###################################################################################################
 
-def test_get_obj_desc(tfm):
+def test_get_description(tfm):
 
-    desc =  get_obj_desc()
+    desc =  get_description()
     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():
+def test_get_indices():
 
-    indices_fixed = get_data_indices('fixed')
+    indices_fixed = get_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')
+    indices_knee = get_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.info import get_obj_desc
+from fooof.core.info import get_description
 
 from fooof.core.io import *
 
@@ -142,7 +142,7 @@ def test_load_file_contents():
 
     loaded_data = load_json(file_name, file_path)
 
-    desc = get_obj_desc()
+    desc = get_description()
 
     # Check settings
     for setting in desc['settings']:

fooof/tests/test_data.py

@@ -1,6 +1,6 @@
 """Tests for the fooof.data."""
 
-from fooof.core.info import get_obj_desc
+from fooof.core.info import get_description
 
 from fooof.data import *
 
@@ -13,7 +13,7 @@ def test_fooof_settings():
     assert settings
 
     # Check that the object has the correct fields, given the object description
-    settings_fields = get_obj_desc()['settings']
+    settings_fields = get_description()['settings']
     for field in settings_fields:
         getattr(settings, field)
     assert True
@@ -24,7 +24,7 @@ def test_fooof_results():
     assert results
 
     # Check that the object has the correct fields, given the object description
-    results_fields = get_obj_desc()['results']
+    results_fields = get_description()['results']
     for field in results_fields:
         getattr(results, field.strip('_'))
     assert True

fooof/tests/test_fit.py

@@ -15,7 +15,7 @@
 from fooof.data import FOOOFSettings, FOOOFMetaData, FOOOFResults
 from fooof.sim import gen_power_spectrum
 from fooof.core.utils import group_three
-from fooof.core.info import get_obj_desc
+from fooof.core.info import get_description
 
 from fooof.tests.utils import get_tfm, plot_test
 
@@ -125,19 +125,19 @@ def test_adds():
     # Test adding settings
     fooof_settings = FOOOFSettings([1, 4], 6, 0, 2, 'fixed')
     tfm.add_settings(fooof_settings)
-    for setting in get_obj_desc()['settings']:
+    for setting in get_description()['settings']:
         assert getattr(tfm, setting) == getattr(fooof_settings, setting)
 
     # Test adding meta data
     fooof_meta_data = FOOOFMetaData([3, 40], 0.5)
     tfm.add_meta_data(fooof_meta_data)
-    for meta_dat in get_obj_desc()['meta_data']:
+    for meta_dat in get_description()['meta_data']:
         assert getattr(tfm, meta_dat) == getattr(fooof_meta_data, meta_dat)
 
     # Test adding results
     fooof_results = FOOOFResults([1, 1], [10, 0.5, 0.5], 0.95, 0.02, [10, 0.5, 0.25])
     tfm.add_results(fooof_results)
-    for setting in get_obj_desc()['results']:
+    for setting in get_description()['results']:
         assert getattr(tfm, setting) == getattr(fooof_results, setting.strip('_'))
 
 def test_obj_gets(tfm):
@@ -200,7 +200,7 @@ def test_fooof_resets():
     tfm._reset_data_results()
     tfm._reset_internal_settings()
 
-    desc = get_obj_desc()
+    desc = get_description()
 
     for data in ['data', 'results', 'model_components']:
         for field in desc[data]:
@@ -230,6 +230,6 @@ def raise_runtime_error(*args, **kwargs):
     tfm.fit(*gen_power_spectrum([3, 50], [50, 2], [10, 0.5, 2, 20, 0.3, 4]))
 
     # Check after failing out of fit, all results are reset
-    for result in get_obj_desc()['results']:
+    for result in get_description()['results']:
         cur_res = getattr(tfm, result)
         assert cur_res is None or np.all(np.isnan(cur_res))

fooof/tests/test_group.py

@@ -13,7 +13,7 @@
 from fooof.group import *
 from fooof.fit import FOOOFResults
 from fooof.sim import gen_group_power_spectra
-from fooof.core.info import get_obj_desc
+from fooof.core.info import get_description
 
 from fooof.tests.utils import default_group_params, plot_test
 
@@ -129,7 +129,7 @@ def test_fg_report(skip_if_no_mpl):
 def test_fg_get_fooof(tfg):
     """Check return of an individual model fit to a FOOOF object from FOOOFGroup."""
 
-    desc = get_obj_desc()
+    desc = get_description()
 
     # Check without regenerating
     tfm0 = tfg.get_fooof(0, False)