Skip to content

Commit fe946da

Browse files
committed
chore: create FOOOFRunModes data object for getter
1 parent b502591 commit fe946da

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

fooof/data/data.py

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,25 @@ class FOOOFSettings(namedtuple('FOOOFSettings', ['peak_width_limits', 'max_n_pea
3838
__slots__ = ()
3939

4040

41+
class FOOOFRunModes(namedtuple('FOOOFRunModes', ['_debug', '_check_freqs',
42+
'_check_data'])):
43+
"""Checks performed and errors raised by the model.
44+
45+
Parameters
46+
----------
47+
_debug : bool
48+
Whether to run in debug mode.
49+
_check_freqs : bool
50+
Whether to run in check freqs mode.
51+
_check_data : bool
52+
Whether to run in check data mode.
53+
Notes
54+
-----
55+
This object is a data object, based on a NamedTuple, with immutable data attributes.
56+
"""
57+
__slots__ = ()
58+
59+
4160
class FOOOFMetaData(namedtuple('FOOOFMetaData', ['freq_range', 'freq_res'])):
4261
"""Metadata information about a power spectrum.
4362

0 commit comments

Comments
 (0)