FitObjects -> ResultsObjects

Author: TomDonoghue

specparam/objs/base.py

@@ -12,7 +12,7 @@
                                load_json, load_jsonlines, get_files)
 from specparam.core.modutils import copy_doc_func_to_method
 from specparam.plts.event import plot_event_model
-from specparam.objs.fit import BaseFit, BaseFit2D, BaseFit2DT, BaseFit3D
+from specparam.objs.results import BaseResults, BaseResults2D, BaseResults2DT, BaseResults3D
 from specparam.objs.data import BaseData, BaseData2D, BaseData2DT, BaseData3D
 
 ###################################################################################################
@@ -117,15 +117,15 @@ def _add_from_dict(self, data):
             setattr(self, key, data[key])
 
 
-class BaseObject(CommonBase, BaseFit, BaseData):
+class BaseObject(CommonBase, BaseResults, BaseData):
     """Define Base object for fitting models to 1D data."""
 
     def __init__(self, aperiodic_mode=None, periodic_mode=None, debug_mode=False, verbose=True):
 
         CommonBase.__init__(self)
         BaseData.__init__(self)
-        BaseFit.__init__(self, aperiodic_mode=aperiodic_mode, periodic_mode=periodic_mode,
-                         debug_mode=debug_mode, verbose=verbose)
+        BaseResults.__init__(self, aperiodic_mode=aperiodic_mode, periodic_mode=periodic_mode,
+                             debug_mode=debug_mode, verbose=verbose)
 
 
     def add_data(self, freqs, power_spectrum, freq_range=None, clear_results=True):
@@ -203,15 +203,15 @@ def _reset_data_results(self, clear_freqs=False, clear_spectrum=False, clear_res
         self._reset_results(clear_results)
 
 
-class BaseObject2D(CommonBase, BaseFit2D, BaseData2D):
+class BaseObject2D(CommonBase, BaseResults2D, BaseData2D):
     """Define Base object for fitting models to 2D data."""
 
     def __init__(self, aperiodic_mode=None, periodic_mode=None, debug_mode=False, verbose=True):
 
         CommonBase.__init__(self)
         BaseData2D.__init__(self)
-        BaseFit2D.__init__(self, aperiodic_mode=aperiodic_mode, periodic_mode=periodic_mode,
-                           debug_mode=debug_mode, verbose=verbose)
+        BaseResults2D.__init__(self, aperiodic_mode=aperiodic_mode, periodic_mode=periodic_mode,
+                               debug_mode=debug_mode, verbose=verbose)
 
 
     def add_data(self, freqs, power_spectra, freq_range=None, clear_results=True):
@@ -315,15 +315,15 @@ def _reset_data_results(self, clear_freqs=False, clear_spectrum=False,
         self._reset_results(clear_results)
 
 
-class BaseObject2DT(BaseObject2D, BaseFit2DT, BaseData2DT):
+class BaseObject2DT(BaseObject2D, BaseResults2DT, BaseData2DT):
     """Define Base object for fitting models to 2D data - tranpose version."""
 
     def __init__(self, aperiodic_mode=None, periodic_mode=None, debug_mode=False, verbose=True):
 
         BaseObject2D.__init__(self)
         BaseData2DT.__init__(self)
-        BaseFit2D.__init__(self, aperiodic_mode=aperiodic_mode, periodic_mode=periodic_mode,
-                           debug_mode=debug_mode, verbose=verbose)
+        BaseResults2D.__init__(self, aperiodic_mode=aperiodic_mode, periodic_mode=periodic_mode,
+                               debug_mode=debug_mode, verbose=verbose)
 
 
     def load(self, file_name, file_path=None, peak_org=None):
@@ -348,15 +348,15 @@ def load(self, file_name, file_path=None, peak_org=None):
             self.convert_results(peak_org)
 
 
-class BaseObject3D(BaseObject2DT, BaseFit3D, BaseData3D):
+class BaseObject3D(BaseObject2DT, BaseResults3D, BaseData3D):
     """Define Base object for fitting models to 3D data."""
 
     def __init__(self, aperiodic_mode=None, periodic_mode=None, debug_mode=False, verbose=True):
 
         BaseObject2DT.__init__(self)
         BaseData3D.__init__(self)
-        BaseFit3D.__init__(self, aperiodic_mode=aperiodic_mode, periodic_mode=periodic_mode,
-                           debug_mode=debug_mode, verbose=verbose)
+        BaseResults3D.__init__(self, aperiodic_mode=aperiodic_mode, periodic_mode=periodic_mode,
+                               debug_mode=debug_mode, verbose=verbose)
 
 
     def add_data(self, freqs, spectrograms, freq_range=None, clear_results=True):

specparam/objs/event.py

@@ -9,7 +9,7 @@
 from specparam.objs import SpectralModel
 from specparam.objs.base import BaseObject3D
 from specparam.objs.algorithm import SpectralFitAlgorithm
-from specparam.objs.fit import _progress
+from specparam.objs.results import _progress
 from specparam.plts.event import plot_event_model
 from specparam.data.conversions import event_group_to_dict, event_group_to_dataframe, dict_to_df
 from specparam.data.utils import get_group_params, get_results_by_row, flatten_results_dict

specparam/objs/fit.py renamed to specparam/objs/results.py

@@ -19,8 +19,8 @@
 ###################################################################################################
 ###################################################################################################
 
-class BaseFit():
-    """Base object for managing fit procedures."""
+class BaseResults():
+    """Base object for managing results."""
     # pylint: disable=attribute-defined-outside-init, arguments-differ
 
     def __init__(self, aperiodic_mode, periodic_mode, debug_mode=False,
@@ -334,12 +334,12 @@ def _calc_error(self, metric=None):
             raise ValueError(error_msg)
 
 
-class BaseFit2D(BaseFit):
-    """Base object for managing fit procedures - 2D version."""
+class BaseResults2D(BaseResults):
+    """Base object for managing results - 2D version."""
 
     def __init__(self, aperiodic_mode, periodic_mode, debug_mode=False, verbose=True):
 
-        BaseFit.__init__(self, aperiodic_mode, periodic_mode, debug_mode=False, verbose=True)
+        BaseResults.__init__(self, aperiodic_mode, periodic_mode, debug_mode=False, verbose=True)
 
         self._reset_group_results()
 
@@ -610,12 +610,12 @@ def get_group(self, inds):
         return group
 
 
-class BaseFit2DT(BaseFit2D):
-    """Base object for managing fit procedures - 2D transpose version."""
+class BaseResults2DT(BaseResults2D):
+    """Base object for managing results - 2D transpose version."""
 
     def __init__(self, aperiodic_mode, periodic_mode, debug_mode=False, verbose=True):
 
-        BaseFit2D.__init__(self, aperiodic_mode, periodic_mode, debug_mode=False, verbose=True)
+        BaseResults2D.__init__(self, aperiodic_mode, periodic_mode, debug_mode=False, verbose=True)
 
         self._reset_time_results()
 
@@ -751,12 +751,12 @@ def convert_results(self, peak_org):
         self.time_results = group_to_dict(self.group_results, peak_org)
 
 
-class BaseFit3D(BaseFit2DT):
-    """Base object for managing fit procedures - 3D version."""
+class BaseResults3D(BaseResults2DT):
+    """Base object for managing results - 3D version."""
 
     def __init__(self, aperiodic_mode, periodic_mode, debug_mode=False, verbose=True):
 
-        BaseFit2DT.__init__(self, aperiodic_mode, periodic_mode, debug_mode=False, verbose=True)
+        BaseResults2DT.__init__(self, aperiodic_mode, periodic_mode, debug_mode=False, verbose=True)
 
         self._reset_event_results()
 

specparam/tests/objs/test_base.py

@@ -48,7 +48,7 @@ def test_base2d():
     tobj2d = BaseObject2D()
     assert isinstance(tobj2d, CommonBase)
     assert isinstance(tobj2d, BaseObject2D)
-    assert isinstance(tobj2d, BaseFit2D)
+    assert isinstance(tobj2d, BaseResults2D)
     assert isinstance(tobj2d, BaseObject2D)
 
 ## 2DT Base Object
@@ -58,7 +58,7 @@ def test_base2dt():
     tobj2dt = BaseObject2DT()
     assert isinstance(tobj2dt, CommonBase)
     assert isinstance(tobj2dt, BaseObject2DT)
-    assert isinstance(tobj2dt, BaseFit2DT)
+    assert isinstance(tobj2dt, BaseResults2DT)
     assert isinstance(tobj2dt, BaseObject2DT)
 
 ## 3D Base Object
@@ -68,6 +68,6 @@ def test_base3d():
     tobj3d = BaseObject3D()
     assert isinstance(tobj3d, CommonBase)
     assert isinstance(tobj3d, BaseObject2DT)
-    assert isinstance(tobj3d, BaseFit2DT)
+    assert isinstance(tobj3d, BaseResults2DT)
     assert isinstance(tobj3d, BaseObject2DT)
     assert isinstance(tobj3d, BaseObject3D)