mne.baseline.rescale#

mne.baseline.rescale(data, times, baseline, mode='mean', copy=True, picks=None, verbose=None)[source]#

Rescale (baseline correct) data.

Parameters:
dataarray

It can be of any shape. The only constraint is that the last dimension should be time.

times1D array

Time instants is seconds.

baselineNone | tuple of length 2

The time interval to consider as “baseline” when applying baseline correction. If None, do not apply baseline correction. If a tuple (a, b), the interval is between a and b (in seconds), including the endpoints. If a is None, the beginning of the data is used; and if b is None, it is set to the end of the data. If (None, None), the entire time interval is used.

Note

The baseline (a, b) includes both endpoints, i.e. all timepoints t such that a <= t <= b.

mode‘mean’ | ‘ratio’ | ‘logratio’ | ‘meanlogratio’ | ‘percent’ | ‘zscore’ | ‘zlogratio’

Perform baseline correction by:

"mean"

Subtracting the mean of baseline values

"ratio"

Dividing by the mean of baseline values

"logratio"

Dividing by the mean of baseline values and taking the log

"meanlogratio"

Dividing by the mean of baseline values, taking the log and then subtracting the mean ([1])

Note

this baseline mode has not been tested at the source-level!

"percent"

Subtracting the mean of baseline values followed by dividing by the mean of baseline values

"zscore"

Subtracting the mean of baseline values and dividing by the standard deviation of baseline values

"zlogratio"

Dividing by the mean of baseline values, taking the log, and dividing by the standard deviation of log baseline values

copybool

Whether to return a new instance or modify in place.

pickslist of int | None

Data to process along the axis=-2 (None, default, processes all).

verbosebool | str | int | None

Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns:
data_scaled: array

Array of same shape as data after rescaling.

References

Examples using mne.baseline.rescale#

Explore event-related dynamics for specific frequency bands

Explore event-related dynamics for specific frequency bands