Skip to content

Commit 3a312e6

Browse files
committed
Add option to generate the average model when averaging FOOOFs
1 parent 98d183b commit 3a312e6

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

fooof/funcs.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
###################################################################################################
1111
###################################################################################################
1212

13-
def average_fg(fg, bands, avg_method='mean'):
13+
def average_fg(fg, bands, avg_method='mean', generate_model=True):
1414
"""Average across a FOOOFGroup object.
1515
1616
Parameters
@@ -21,6 +21,8 @@ def average_fg(fg, bands, avg_method='mean'):
2121
Bands object that defines the frequency bands to collapse peaks across.
2222
avg : {'mean', 'median'}
2323
Averaging function to use.
24+
generate_model : bool, optional, default: True
25+
Whether to generate the model for the averaged parameters.
2426
2527
Returns
2628
-------
@@ -56,6 +58,10 @@ def average_fg(fg, bands, avg_method='mean'):
5658
fm.add_meta_data(fg.get_meta_data())
5759
fm.add_results(results)
5860

61+
# Generate the model from the average parameters
62+
if generate_model:
63+
fm._regenerate_model()
64+
5965
return fm
6066

6167

0 commit comments

Comments
 (0)