lints

Author: TomDonoghue

specparam/objs/algorithm.py

@@ -45,8 +45,9 @@ class SpectralFitAlgorithm():
     _maxfev : int
         The maximum number of calls to the curve fitting function.
     _error_metric : str
-        The error metric to use for post-hoc measures of model fit error. See `_calc_error` for options.
+        The error metric to use for post-hoc measures of model fit error.
         Note: this is for checking error post fitting, not an objective function for fitting.
+        See `_calc_error` for options.
     _debug : bool
         Run mode: whether the object is set in debug mode.
         If in debug mode, an error is raised if model fitting is unsuccessful.
@@ -55,7 +56,7 @@ class SpectralFitAlgorithm():
     Attributes
     ----------
     _gauss_std_limits : list of [float, float]
-        Settings attribute: peak width limits, converted to use for gaussian standard deviation parameter.
+        Settings attribute: peak width limits, to use for gaussian standard deviation parameter.
         This attribute is computed based on `peak_width_limits` and should not be updated directly.
     _spectrum_flat : 1d array
         Data attribute: flattened power spectrum, with the aperiodic component removed.
@@ -194,7 +195,8 @@ def _reset_internal_settings(self):
             self._gauss_std_limits = None
 
 
-    # ToCheck: this currently overrides basefit - but once modes are used, this can be dropped (I think)
+    # ToCheck: this currently overrides basefit
+    #   Once modes are used, this can be dropped (I think)
     def _reset_results(self, clear_results=False):
         """Set, or reset, results attributes to empty.
 

specparam/objs/base.py

@@ -11,7 +11,6 @@
 from specparam.core.io import (save_model, save_group, save_event,
                                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.results import BaseResults, BaseResults2D, BaseResults2DT, BaseResults3D
 from specparam.objs.data import BaseData, BaseData2D, BaseData2DT, BaseData3D
 
@@ -443,5 +442,5 @@ def _reset_data_results(self, clear_freqs=False, clear_spectrum=False, clear_res
             Whether to clear spectrograms attribute.
         """
 
-        self._reset_data(clear_freqs, clear_spectrum, clear_spectra)
+        self._reset_data(clear_freqs, clear_spectrum, clear_spectra, clear_spectrograms)
         self._reset_results(clear_results)

specparam/objs/event.py

@@ -1,24 +1,17 @@
 """Event model object and associated code for fitting the model to spectrograms across events."""
 
-from itertools import repeat
-from functools import partial
-from multiprocessing import Pool, cpu_count
-
 import numpy as np
 
 from specparam.objs import SpectralModel
 from specparam.objs.base import BaseObject3D
 from specparam.objs.algorithm import SpectralFitAlgorithm
-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
+from specparam.data.conversions import event_group_to_dataframe, dict_to_df
+from specparam.data.utils import flatten_results_dict
 from specparam.core.modutils import (copy_doc_func_to_method, docs_get_section,
                                      replace_docstring_sections)
 from specparam.core.reports import save_event_report
 from specparam.core.strings import gen_event_results_str
-from specparam.core.utils import check_inds
-from specparam.core.io import get_files, save_event
 
 ###################################################################################################
 ###################################################################################################
@@ -105,7 +98,7 @@ def report(self, freqs=None, spectrograms=None, freq_range=None,
         Data is optional, if data has already been added to the object.
         """
 
-        self.fit(freqs, spectrograms, freq_range, peak_org, n_jobs=n_jobs, progress=progress)
+        self.fit(freqs, spectrograms, freq_range, peak_org, n_jobs, progress)
         self.plot()
         self.print_results()
 

specparam/objs/results.py

@@ -554,7 +554,7 @@ def get_model(self, ind, regenerate=True):
             The FitResults data loaded into a model object.
         """
 
-        # TEMP IMPORT
+        # Local import - avoid circular
         from specparam.objs.model import SpectralModel
 
         # Initialize model object, with same settings, metadata, & check mode as current object
@@ -588,7 +588,7 @@ def get_group(self, inds):
             The requested selection of results data loaded into a new group model object.
         """
 
-        # TEMP IMPORT
+        # Local import - avoid circular
         from specparam.objs.group import SpectralGroupModel
 
         # Initialize a new model object, with same settings as current object
@@ -690,12 +690,9 @@ def get_group(self, inds, output_type='time'):
             The requested selection of results data loaded into a new model object.
         """
 
-        # TEMP IMPORT
-        from specparam.objs.time import SpectralTimeModel
-
         if output_type == 'time':
 
-            # TEMP IMPORT
+            # Local import - avoid circular
             from specparam.objs.time import SpectralTimeModel
 
             # Initialize a new model object, with same settings as current object
@@ -874,7 +871,7 @@ def drop(self, drop_inds=None, window_inds=None):
         This method sets the model fits as null, and preserves the shape of the model fits.
         """
 
-        # TEMP IMPORT
+        # Local import - avoid circular
         from specparam.objs.model import SpectralModel
 
         null_model = SpectralModel(**self.get_settings()._asdict()).get_results()
@@ -966,7 +963,7 @@ def get_group(self, event_inds, window_inds, output_type='event'):
             The requested selection of results data loaded into a new model object.
         """
 
-        # TEMP IMPORT
+        # Local import - avoid circular
         from specparam.objs.event import SpectralTimeEventModel
 
         # Check and convert indices encoding to list of int

specparam/utils/data.py

@@ -92,9 +92,9 @@ def compute_presence(data, average=False, output='ratio'):
     data : 1d or 2d array
         Data array to check presence of.
     average : bool, optional, default: False
-        Whether to average across . Only used for 2d array inputs.
-        If False, for 2d array, the output is an array matching the length of the 0th dimension of the input.
-        If True, for 2d arrays, the output is a single value averaged across the whole array.
+        Whether to average across. Only used for 2d array inputs.
+        If False, the output is an array matching the length of the 0th dimension of the input.
+        If True, the output is a single value averaged across the whole array.
     output : {'ratio', 'percent'}
         Representation for the output:
             'ratio' - ratio value, between 0.0, 1.0.