mne.decoding.get_coef#
- mne.decoding.get_coef(estimator, attr='filters_', inverse_transform=False, *, step_name=None, verbose=None)[source]#
Retrieve the coefficients of an estimator ending with a Linear Model.
This is typically useful to retrieve “spatial filters” or “spatial patterns” of decoding models [1].
- Parameters:
- estimatorobject |
None
An estimator from scikit-learn.
- attr
str
The name of the coefficient attribute to retrieve, typically
'filters_'
(default) or'patterns_'
.- inverse_transformbool
If True, returns the coefficients after inverse transforming them with the transformer steps of the estimator.
- step_name
str
|None
Name of the sklearn’s pipeline step to get the coef from. If inverse_transform is True, the inverse transformations will be applied using transformers before this step. If None, the last step will be used. Defaults to None.
New in v1.11.
- verbosebool |
str
|int
|None
Control verbosity of the logging output. If
None
, use the default verbosity level. See the logging documentation andmne.verbose()
for details. Should only be passed as a keyword argument.
- estimatorobject |
- Returns:
- coef
array
The coefficients.
- coef
References