mne.verbose#

mne.verbose(function: _FuncT) → _FuncT[source]#

Verbose decorator to allow functions to override log-level.

Parameters:
functioncallable()

Function to be decorated by setting the verbosity level.

Returns:
deccallable()

The decorated function.

See also

set_log_level
set_config

Notes

This decorator is used to set the verbose level during a function or method call, such as mne.compute_covariance(). The verbose keyword argument can be ‘DEBUG’, ‘INFO’, ‘WARNING’, ‘ERROR’, ‘CRITICAL’, True (an alias for ‘INFO’), or False (an alias for ‘WARNING’). To set the global verbosity level for all functions, use mne.set_log_level().

This function also serves as a docstring filler.

Examples

You can use the verbose argument to set the verbose level on the fly:

>>> import mne
>>> cov = mne.compute_raw_covariance(raw, verbose='WARNING')
>>> cov = mne.compute_raw_covariance(raw, verbose='INFO')
Using up to 49 segments
Number of samples used : 5880
[done]
On this page