Updates tutorials & examples for recent API updates

Author: TomDonoghue

examples/plot_fit_fooof_3d.py

@@ -68,7 +68,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_all_data('aperiodic_params', 'exponent'))))
+        ind, np.mean(fg.get_params('aperiodic_params', 'exponent'))))
 
 ###################################################################################################
 # combine_fooofs

tutorials/plot_02-FOOOF.py

@@ -140,14 +140,14 @@
 ###################################################################################################
 #
 # The underlying gaussian parameters are also availabe from the FOOOF object,
-# in the '_gaussian_params' attribute.
+# in the `gaussian_params_` attribute.
 #
 
 ###################################################################################################
 #
 # Compare the 'peak\_params_', as compared to the underlying gaussian parameters
 print('  Peak Parameters \t Gaussian Parameters')
-for peak, gau in zip(fm.peak_params_, fm._gaussian_params):
+for peak, gau in zip(fm.peak_params_, fm.gaussian_params_):
     print('{:5.2f} {:5.2f} {:5.2f} \t {:5.2f} {:5.2f} {:5.2f}'.format(*peak, *gau))
 
 ####################################################################################################

tutorials/plot_06-FOOOFGroup.py

@@ -132,33 +132,33 @@
 print(fg.group_results[0:2])
 
 ###################################################################################################
-# get_all_data
-# ------------
+# get_params
+# ----------
 #
 # To collect data across all model fits, and to select specific data results from this data
-# you can use the :func:`get_all_data` method. This method lets you extract specific results
+# you can use the :func:`get_params` method. This method lets you extract specific results
 # by specifying a field, as a string, and (optionally) a specific column of that data, also
 # as a string (or, optionally, as an integer index).
 #
 
 ###################################################################################################
 
 # Extract aperiodic data
-aps = fg.get_all_data('aperiodic_params')
-exps = fg.get_all_data('aperiodic_params', 'exponent')
+aps = fg.get_params('aperiodic_params')
+exps = fg.get_params('aperiodic_params', 'exponent')
 
 # Extract peak data
-peaks = fg.get_all_data('peak_params')
-cfs = fg.get_all_data('peak_params', 'CF')
+peaks = fg.get_params('peak_params')
+cfs = fg.get_params('peak_params', 'CF')
 
 # Extract metadata about the model fit
-errors = fg.get_all_data('error')
-r2s = fg.get_all_data('r_squared')
+errors = fg.get_params('error')
+r2s = fg.get_params('r_squared')
 
 ###################################################################################################
 
-# The full list of data you can specify is available in the documentation of :func:`get_all_data`
-print(fg.get_all_data.__doc__)
+# The full list of data you can specify is available in the documentation of :func:`get_params`
+print(fg.get_params.__doc__)
 
 ###################################################################################################
 #

tutorials/plot_07-TroubleShooting.py

@@ -173,7 +173,7 @@
 
 # Compare ground truth simulated parameters to model fit results
 print('Ground Truth \t\t FOOOF Reconstructions')
-for sy, fi in zip(np.array(group_three(gauss_params)), fm._gaussian_params):
+for sy, fi in zip(np.array(group_three(gauss_params)), fm.gaussian_params_):
     print('{:5.2f} {:5.2f} {:5.2f} \t {:5.2f} {:5.2f} {:5.2f}'.format(*sy, *fi))
 
 ###################################################################################################
@@ -226,7 +226,7 @@
 
 # Check reconstructed parameters from simulated definition
 print('Ground Truth \t\t FOOOF Reconstructions')
-for sy, fi in zip(np.array(group_three(gauss_params)), fm._gaussian_params):
+for sy, fi in zip(np.array(group_three(gauss_params)), fm.gaussian_params_):
     print('{:5.2f} {:5.2f} {:5.2f} \t {:5.2f} {:5.2f} {:5.2f}'.format(*sy, *fi))
 
 ###################################################################################################
@@ -253,7 +253,7 @@
 ###################################################################################################
 
 # Find the index of the worst FOOOF fit from the group
-worst_fit_ind = np.argmax(fg.get_all_data('error'))
+worst_fit_ind = np.argmax(fg.get_params('error'))
 
 # Extract this FOOOF fit from the group, into a FOOOF object
 fm = fg.get_fooof(worst_fit_ind, regenerate=True)

tutorials/plot_08-FurtherAnalysis.py

@@ -119,7 +119,7 @@
 ###################################################################################################
 
 # Get all alpha oscillations from a FOOOFGroup object
-alphas = get_band_peak_group(fg.get_all_data('peak_params'), alpha_band, len(fg))
+alphas = get_band_peak_group(fg.get_params('peak_params'), alpha_band, len(fg))
 
 ###################################################################################################
 
@@ -170,7 +170,7 @@
 ###################################################################################################
 
 # Extract aperiodic exponent data from group results
-exps = fg.get_all_data('aperiodic_params', 'exponent')
+exps = fg.get_params('aperiodic_params', 'exponent')
 
 # Check out the aperiodic exponent results
 print(exps)