From d8372ba789b4e3aed3e5539e63621918e2482eef Mon Sep 17 00:00:00 2001 From: Thomas Samuel Binns Date: Thu, 5 Sep 2024 17:35:05 +0200 Subject: [PATCH 1/2] Add deprecation warning --- mne/decoding/csp.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/mne/decoding/csp.py b/mne/decoding/csp.py index 7bd77361fa6..b0e5d7b4bc8 100644 --- a/mne/decoding/csp.py +++ b/mne/decoding/csp.py @@ -18,6 +18,7 @@ copy_doc, fill_doc, pinv, + warn, ) from .base import BaseEstimator from .mixin import TransformerMixin @@ -369,6 +370,9 @@ def plot_patterns( if components is None: components = np.arange(self.n_components) + if average is not None: + warn("`average` is deprecated and will be removed in 1.10.", FutureWarning) + # set sampling frequency to have 1 component per time point info = cp.deepcopy(info) with info._unlock(): @@ -500,6 +504,9 @@ def plot_filters( if components is None: components = np.arange(self.n_components) + if average is not None: + warn("`average` is deprecated and will be removed in 1.10.", FutureWarning) + # set sampling frequency to have 1 component per time point info = cp.deepcopy(info) with info._unlock(): From 78ff556cd59a8d24f8b9df45703817685720da8a Mon Sep 17 00:00:00 2001 From: Thomas Samuel Binns Date: Thu, 5 Sep 2024 17:58:45 +0200 Subject: [PATCH 2/2] Add changelog entry --- doc/changes/devel/12829.apichange.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/changes/devel/12829.apichange.rst diff --git a/doc/changes/devel/12829.apichange.rst b/doc/changes/devel/12829.apichange.rst new file mode 100644 index 00000000000..d0bd4c12a46 --- /dev/null +++ b/doc/changes/devel/12829.apichange.rst @@ -0,0 +1 @@ +Deprecate ``average`` parameter in ``plot_filters`` and ``plot_patterns`` methods of the :class:`mne.decoding.CSP` and :class:`mne.decoding.SPoC` classes, by `Thomas Binns`_. \ No newline at end of file