fooof-tools · TomDonoghue · Oct 28, 2025 · Apr 12, 2025 · Apr 12, 2025 · Apr 12, 2025
diff --git a/doc/api.rst b/doc/api.rst
@@ -144,6 +144,7 @@ The following functions operate on arrays of peak parameters, which may be usefu
     get_band_peak_group_arr
     get_highest_peak
     threshold_peaks
+    sort_peaks
 
 Measures
 --------

diff --git a/examples/analyses/plot_dev_demo.py b/examples/analyses/plot_dev_demo.py
@@ -127,9 +127,9 @@
 ###################################################################################################
 
 # Access the model fit parameters & related attributes from the model object
-print('Aperiodic parameters: \n', fm.results.aperiodic_params_, '\n')
-print('Peak parameters: \n', fm.results.peak_params_, '\n')
-print('Number of fit peaks: \n', fm.results.n_peaks_)
+print('Aperiodic parameters: \n', fm.results.params.aperiodic.params, '\n')
+print('Peak parameters: \n', fm.results.params.periodic.params, '\n')
+print('Number of fit peaks: \n', fm.results.n_peaks)
 
 ###################################################################################################
 
@@ -148,21 +148,21 @@
 
 ###################################################################################################
 
-# Extract aperiodic and periodic parameter
-aps = fm.get_params('aperiodic_params')
-peaks = fm.get_params('peak_params')
+# Extract aperiodic and periodic parameters
+aps = fm.get_params('aperiodic')
+peaks = fm.get_params('peak')
 
 ###################################################################################################
 
-# Extract goodness of fit information
-err = fm.get_params('metrics', 'error_mae')
-r2s = fm.get_params('metrics', 'gof_rsquared')
+# Extract specific parameters
+exp = fm.get_params('aperiodic', 'exponent')
+cfs = fm.get_params('peak', 'CF')
 
 ###################################################################################################
 
-# Extract specific parameters
-exp = fm.get_params('aperiodic_params', 'exponent')
-cfs = fm.get_params('peak_params', 'CF')
+# Extract goodness of fit information
+err = fm.get_metrics('error')
+r2s = fm.get_metrics('gof')
 
 ###################################################################################################
 
@@ -323,19 +323,19 @@
 ###################################################################################################
 
 # Extract aperiodic and full periodic parameters
-aps = fg.get_params('aperiodic_params')
-per = fg.get_params('peak_params')
+aps = fg.get_params('aperiodic')
+per = fg.get_params('peak')
 
 ###################################################################################################
 
 # Extract group fit information
-err = fg.get_params('metrics', 'error_mae')
-r2s = fg.get_params('metrics', 'gof_rsquared')
+err = fg.get_metrics('error')
+r2s = fg.get_metrics('gof')
 
 ###################################################################################################
 
 # Check the average number of fit peaks, per model
-print('Average number of fit peaks: ', np.mean(fg.results.n_peaks_))
+print('Average number of fit peaks: ', np.mean(fg.results.n_peaks))
 
 ###################################################################################################
 
@@ -551,7 +551,7 @@
 ###################################################################################################
 
 # Find the index of the worst model fit from the group
-worst_fit_ind = np.argmax(fg.get_params('metrics', 'error_mae'))
+worst_fit_ind = np.argmax(fg.get_metrics('error'))
 
 # Extract this model fit from the group
 fm = fg.get_model(worst_fit_ind, regenerate=True)
@@ -669,7 +669,7 @@
 ###################################################################################################
 
 # Drop poor model fits based on MAE
-fg.results.drop(fg.get_params('metrics', 'error_mae') > 0.10)
+fg.results.drop(fg.get_metrics('error', 'mae') > 0.10)
 
 ###################################################################################################
 # Conclusions

diff --git a/examples/analyses/plot_mne_example.py b/examples/analyses/plot_mne_example.py
@@ -260,7 +260,7 @@ def check_nans(data, nan_policy='zero'):
 ###################################################################################################
 
 # Extract aperiodic exponent values
-exps = fg.get_params('aperiodic_params', 'exponent')
+exps = fg.get_params('aperiodic', 'exponent')
 
 ###################################################################################################
 

diff --git a/examples/manage/plot_failed_fits.py b/examples/manage/plot_failed_fits.py
@@ -59,15 +59,15 @@
 #
 # These attributes are:
 #
-# - ``n_null_`` : the number of model results that are null
-# - ``null_inds_`` : the indices of any null model results
+# - ``n_null`` : the number of model results that are null
+# - ``null_inds`` : the indices of any null model results
 #
 
 ###################################################################################################
 
 # Check for failed model fits
-print('Number of Null models  : \t', fg.results.n_null_)
-print('Indices of Null models : \t', fg.results.null_inds_)
+print('Number of Null models  : \t', fg.results.n_null)
+print('Indices of Null models : \t', fg.results.null_inds)
 
 ###################################################################################################
 # Inducing Model Fit Failures
@@ -86,7 +86,7 @@
 ###################################################################################################
 
 # Hack the object to induce model failures
-fg._maxfev = 50
+fg.algorithm._cf_settings.maxfev = 50
 
 ###################################################################################################
 
@@ -102,8 +102,8 @@
 ###################################################################################################
 
 # Check how many model fit failures we have failed model fits
-print('Number of Null models  : \t', fg.results.n_null_)
-print('Indices of Null models : \t', fg.results.null_inds_)
+print('Number of Null models  : \t', fg.results.n_null)
+print('Indices of Null models : \t', fg.results.null_inds)
 
 ###################################################################################################
 # Debug Mode

diff --git a/examples/manage/plot_fit_models_3d.py b/examples/manage/plot_fit_models_3d.py
@@ -205,7 +205,7 @@
 # Compare the aperiodic exponent results across conditions
 for ind, fg in enumerate(fgs):
     print("Aperiodic exponent for condition {} is {:1.4f}".format(
-        ind, np.mean(fg.get_params('aperiodic_params', 'exponent'))))
+        ind, np.mean(fg.get_params('aperiodic', 'exponent'))))
 
 ###################################################################################################
 # Managing Model Objects

diff --git a/examples/manage/plot_manipulating_models.py b/examples/manage/plot_manipulating_models.py
@@ -168,7 +168,7 @@
 ###################################################################################################
 
 # Drop all model fits above an error threshold
-fg.results.drop(fg.get_params('metrics', 'error_mae') > 0.01)
+fg.results.drop(fg.get_metrics('error') > 0.01)
 
 ###################################################################################################
 # Note on Dropped or Failed Fits
@@ -186,8 +186,8 @@
 ###################################################################################################
 
 # Check information on null models (dropped models)
-print('Number of Null models  : \t', fg.results.n_null_)
-print('Indices of Null models : \t', fg.results.null_inds_)
+print('Number of Null models  : \t', fg.results.n_null)
+print('Indices of Null models : \t', fg.results.null_inds)
 
 # Despite the dropped model, the total number of models in the object is the same
 #   This means that the indices are still the same as before dropping models
@@ -196,7 +196,7 @@
 ###################################################################################################
 
 # Null models are defined as all NaN (not a number)
-for ind in fg.results.null_inds_:
+for ind in fg.results.null_inds:
     print(fg.results[ind])
 
 ###################################################################################################

diff --git a/examples/models/plot_aperiodic_params.py b/examples/models/plot_aperiodic_params.py
@@ -40,7 +40,7 @@
 ###################################################################################################
 
 # Check the aperiodic parameters
-fm.results.aperiodic_params_
+fm.results.params.aperiodic.params
 
 ###################################################################################################
 
@@ -140,7 +140,7 @@
 ###################################################################################################
 
 # Check the measured aperiodic parameters
-fm.results.aperiodic_params_
+fm.results.params.aperiodic.params
 
 ###################################################################################################
 # Knee Frequency
@@ -158,7 +158,7 @@
 ###################################################################################################
 
 # Compute the knee frequency from aperiodic parameters
-knee_frequency = compute_knee_frequency(*fm.results.aperiodic_params_[1:])
+knee_frequency = compute_knee_frequency(*fm.results.params.aperiodic.params[1:])
 print('Knee frequency: ', knee_frequency)
 
 ###################################################################################################

diff --git a/examples/models/plot_data_components.py b/examples/models/plot_data_components.py
@@ -57,7 +57,7 @@
 ###################################################################################################
 
 # Plot the power spectrum model from the object
-plot_spectra(fm.data.freqs, fm.results.modeled_spectrum_, color='red')
+plot_spectra(fm.data.freqs, fm.results.model.modeled_spectrum, color='red')
 
 ###################################################################################################
 # Isolated Components
@@ -70,7 +70,7 @@
 # To access these components, we can use the following `getter` methods:
 #
 # - :meth:`~specparam.SpectralModel.get_data`: allows for accessing data components
-# - :meth:`~specparam.SpectralModel.results.get_component`: allows for accessing model components
+# - :meth:`~specparam.SpectralModel.results.model.get_component`: allows for accessing model components
 #
 
 ###################################################################################################
@@ -91,7 +91,7 @@
 ###################################################################################################
 
 # Plot the peak removed spectrum, with the model aperiodic fit
-plot_spectra(fm.data.freqs, [fm.get_data('aperiodic'), fm.results.get_component('aperiodic')],
+plot_spectra(fm.data.freqs, [fm.get_data('aperiodic'), fm.results.model.get_component('aperiodic')],
              colors=['black', 'blue'], linestyle=['-', '--'])
 
 ###################################################################################################
@@ -113,7 +113,7 @@
 ###################################################################################################
 
 # Plot the flattened spectrum data with the model peak fit
-plot_spectra(fm.data.freqs, [fm.get_data('peak'), fm.results.get_component('peak')],
+plot_spectra(fm.data.freqs, [fm.get_data('peak'), fm.results.model.get_component('peak')],
              colors=['black', 'green'], linestyle=['-', '--'])
 
 ###################################################################################################
@@ -128,7 +128,7 @@
 
 # Plot the full model fit, as the combination of the aperiodic and peak model components
 plot_spectra(fm.data.freqs,
-             [fm.results.get_component('aperiodic') + fm.results.get_component('peak')],
+             [fm.results.model.get_component('aperiodic') + fm.results.model.get_component('peak')],
              color='red')
 
 ###################################################################################################
@@ -157,7 +157,7 @@
 
 # Plot the peak removed spectrum, with the model aperiodic fit
 plot_spectra(fm.data.freqs, [fm.get_data('aperiodic', 'linear'),
-             fm.results.get_component('aperiodic', 'linear')],
+             fm.results.model.get_component('aperiodic', 'linear')],
              colors=['black', 'blue'], linestyle=['-', '--'])
 
 ###################################################################################################
@@ -171,7 +171,7 @@
 
 # Plot the flattened spectrum data with the model peak fit
 plot_spectra(fm.data.freqs,
-             [fm.get_data('peak', 'linear'), fm.results.get_component('peak', 'linear')],
+             [fm.get_data('peak', 'linear'), fm.results.model.get_component('peak', 'linear')],
              colors=['black', 'green'], linestyle=['-', '--'])
 
 ###################################################################################################
@@ -199,8 +199,8 @@
 
 # Plot the linear model, showing the combination of peak + aperiodic matches the full model
 plot_spectra(fm.data.freqs,
-             [fm.results.get_component('full', 'linear'),
-              fm.results.get_component('aperiodic', 'linear') + fm.results.get_component('peak', 'linear')],
+             [fm.results.model.get_component('full', 'linear'),
+              fm.results.model.get_component('aperiodic', 'linear') + fm.results.model.get_component('peak', 'linear')],
              linestyle=['-', 'dashed'], colors=['black', 'red'], alpha=[0.3, 0.75])
 
 ###################################################################################################

diff --git a/examples/plots/plot_model_components.py b/examples/plots/plot_model_components.py
@@ -181,8 +181,8 @@
 ###################################################################################################
 
 # Extract the aperiodic parameters for each group
-aps1 = fg1.get_params('aperiodic_params')
-aps2 = fg2.get_params('aperiodic_params')
+aps1 = fg1.get_params('aperiodic')
+aps2 = fg2.get_params('aperiodic')
 
 ###################################################################################################
 # Plotting Aperiodic Parameters

diff --git a/examples/sims/plot_transforms.py b/examples/sims/plot_transforms.py
@@ -78,9 +78,9 @@
 
 # Check the measured exponent values
 print("Original exponent value:\t {:1.2f}".format(\
-    fm1.get_params('aperiodic_params', 'exponent')))
+    fm1.get_params('aperiodic', 'exponent')))
 print("Rotated exponent value:\t{:1.2f}".format(\
-    fm2.get_params('aperiodic_params', 'exponent')))
+    fm2.get_params('aperiodic', 'exponent')))
 
 ###################################################################################################
 # Rotation Related Offset Changes

diff --git a/motivations/measurements/plot_BandByBand.py b/motivations/measurements/plot_BandByBand.py
@@ -107,8 +107,8 @@
 def compare_exp(fm1, fm2):
     """Compare exponent values."""
 
-    exp1 = fm1.get_params('aperiodic_params', 'exponent')
-    exp2 = fm2.get_params('aperiodic_params', 'exponent')
+    exp1 = fm1.get_params('aperiodic', 'exponent')
+    exp2 = fm2.get_params('aperiodic', 'exponent')
 
     return exp1 - exp2
 
@@ -203,7 +203,7 @@ def compare_band_pw(fm1, fm2, band_def):
 
 # Plot the power spectra differences
 plot_spectra_shading(freqs,
-                     [fm_bands_g1.results._spectrum_flat, fm_bands_g2.results._spectrum_flat],
+                     [fm_bands_g1.get_data('peak'), fm_bands_g2.get_data('peak')],
                      log_powers=False, linewidth=3,
                      shades=bands.definitions, shade_colors=shade_cols,
                      labels=labels)
@@ -294,7 +294,7 @@ def compare_band_pw(fm1, fm2, band_def):
 
 # Plot the power spectra differences
 plot_spectra_shading(freqs,
-                     [fm_pa_g1.results._spectrum_flat, fm_pa_g2.results._spectrum_flat],
+                     [fm_pa_g1.get_data('peak'), fm_pa_g2.get_data('peak')],
                      log_powers=False, linewidth=3,
                      shades=bands.definitions, shade_colors=shade_cols,
                      labels=labels)