allow for null Modes in Results

Author: TomDonoghue

specparam/modes/modes.py

@@ -32,8 +32,10 @@ def __init__(self, aperiodic, periodic):
     def check_params(self):
         """Check the description of the parameters for each mode."""
 
-        self.aperiodic.check_params()
-        self.periodic.check_params()
+        if self.aperiodic:
+            self.aperiodic.check_params()
+        if self.periodic:
+            self.periodic.check_params()
 
 
     def get_modes(self):
@@ -45,19 +47,25 @@ def get_modes(self):
             Modes definition.
         """
 
-        return ModelModes(aperiodic_mode=self.aperiodic.name, periodic_mode=self.periodic.name)
+        return ModelModes(aperiodic_mode=self.aperiodic.name if self.aperiodic else None,
+                          periodic_mode=self.periodic.name if self.periodic else None)
 
 
 def check_mode_definition(mode, options):
     """Check a mode specification.
 
     Parameters
     ----------
-    mode : str or Mode
+    mode : str or None or Mode
         Fit mode. If str, should be a label corresponding to an entry in `options`.
     options : dict
         Available modes.
 
+    Returns
+    -------
+    mode : Mode or None
+        Mode object, if defined, or None if not defined.
+
     Raises
     ------
     ValueError
@@ -68,7 +76,9 @@ def check_mode_definition(mode, options):
         assert mode in list(options.keys()), 'Specific Mode not found.'
         mode = options[mode]
 
-    if not isinstance(mode, Mode):
+    if mode is None:
+        mode = None
+    elif not isinstance(mode, Mode):
         raise ValueError('Mode input not understood.')
 
     return mode

specparam/objs/results.py

@@ -6,6 +6,7 @@
 import numpy as np
 
 from specparam.bands.bands import check_bands
+from specparam.modes.modes import Modes
 from specparam.objs.metrics import Metrics
 from specparam.objs.params import ModelParameters
 from specparam.objs.components import ModelComponents
@@ -57,7 +58,7 @@ class Results():
     def __init__(self, modes=None, metrics=None, bands=None):
         """Initialize Results object."""
 
-        self.modes = modes
+        self.modes = modes if modes else Modes(None, None)
 
         self.add_bands(bands)
         self.add_metrics(metrics)
@@ -148,7 +149,7 @@ def add_results(self, results):
 
         # TODO: use check_array_dim for peak arrays? Or is / should this be done in `add_params`
 
-        for component in ['aperiodic', 'periodic']:
+        for component in self.modes.components:
             for version in ['fit', 'converted']:
                 attr_comp = 'peak' if component == 'periodic' else component
                 getattr(self.params, component).add_params(\

specparam/tests/objs/test_results.py

@@ -12,13 +12,13 @@ def test_results():
     tres = Results()
     assert isinstance(tres, Results)
 
-def test_results_results(tresults):
+def test_results_results(tresults, tmodes):
 
     tres = Results()
 
     tres.add_results(tresults)
     assert tres.has_model
-    for component in ['aperiodic', 'periodic']:
+    for component in tmodes.components:
         attr_comp = 'peak' if component == 'periodic' else component
         assert np.array_equal(getattr(tres.params, component).get_params('fit'),
                               getattr(tresults, attr_comp + '_fit'))