update to use FOOOFRunMode object

Author: TomDonoghue

fooof/data/__init__.py

@@ -1,3 +1,3 @@
 """Data sub-module for FOOOF."""
 
-from .data import FOOOFSettings, FOOOFMetaData, FOOOFResults, SimParams
+from .data import FOOOFSettings, FOOOFRunModes, FOOOFMetaData, FOOOFResults, SimParams

fooof/data/data.py

@@ -38,6 +38,25 @@ class FOOOFSettings(namedtuple('FOOOFSettings', ['peak_width_limits', 'max_n_pea
     __slots__ = ()
 
 
+class FOOOFRunModes(namedtuple('FOOOFRunModes', ['debug', 'check_freqs', 'check_data'])):
+    """Checks performed and errors raised by the model.
+
+    Parameters
+    ----------
+    debug :  bool
+       Whether to run in debug mode.
+    check_freqs : bool
+        Whether to run in check freqs mode.
+    check_data : bool
+        Whether to run in check data mode.
+
+    Notes
+    -----
+    This object is a data object, based on a NamedTuple, with immutable data attributes.
+    """
+    __slots__ = ()
+
+
 class FOOOFMetaData(namedtuple('FOOOFMetaData', ['freq_range', 'freq_res'])):
     """Metadata information about a power spectrum.
 

fooof/objs/fit.py

@@ -78,7 +78,7 @@
 from fooof.plts.fm import plot_fm
 from fooof.utils.data import trim_spectrum
 from fooof.utils.params import compute_gauss_std
-from fooof.data import FOOOFResults, FOOOFSettings, FOOOFMetaData
+from fooof.data import FOOOFSettings, FOOOFRunModes, FOOOFMetaData, FOOOFResults
 from fooof.data.conversions import model_to_dataframe
 from fooof.sim.gen import gen_freqs, gen_aperiodic, gen_periodic, gen_model
 
@@ -575,11 +575,12 @@ def get_run_modes(self):
 
         Returns
         -------
-        data: dict
-            Dictionary containing the run_modes from the current object.
+        FOOOFRunModes
+            Object containing the run modes from the current object.
         """
 
-        return {key : getattr(self, key) for key in OBJ_DESC['run_modes']}
+        return FOOOFRunModes(**{key.strip('_') : getattr(self, key) \
+                             for key in OBJ_DESC['run_modes']})
 
 
     def get_meta_data(self):

fooof/objs/group.py

@@ -458,7 +458,7 @@ def get_fooof(self, ind, regenerate=True):
 
         # Initialize a FOOOF object, with same settings & run modes as current FOOOFGroup
         fm = FOOOF(*self.get_settings(), verbose=self.verbose)
-        fm.set_run_modes(*self.get_run_modes().values())
+        fm.set_run_modes(*self.get_run_modes())
 
         # Add data for specified single power spectrum, if available
         #   The power spectrum is inverted back to linear, as it is re-logged when added to FOOOF
@@ -496,7 +496,7 @@ def get_group(self, inds):
 
         # Initialize a new FOOOFGroup object, with same settings and run modes as current FOOOFGroup
         fg = FOOOFGroup(*self.get_settings(), verbose=self.verbose)
-        fg.set_run_modes(*self.get_run_modes().values())
+        fg.set_run_modes(*self.get_run_modes())
 
         # Add data for specified power spectra, if available
         #   The power spectra are inverted back to linear, as they are re-logged when added to FOOOF

fooof/tests/data/test_data.py

@@ -19,6 +19,14 @@ def test_fooof_settings():
     for field in OBJ_DESC['settings']:
         assert getattr(settings, field)
 
+def test_fooof_run_modes():
+
+    run_modes = FOOOFRunModes(True, True, True)
+    assert run_modes
+
+    for field in OBJ_DESC['run_modes']:
+        assert getattr(run_modes, field.strip('_'))
+
 def test_fooof_meta_data():
 
     meta_data = FOOOFMetaData([1, 50], 0.5)