roiextract.filter.SpatialFilter

class roiextract.filter.SpatialFilter(w, method='', method_params={}, ch_names=None, name='')

Convenience wrapper around a NumPy array that contains the spatial filter.

Parameters:

w: array_like, shape (n_channels,)

The weights of the spatial filter.

method: str, optional

Can be used to store the name of the method that was used to obtain the filter.

method_params: dict, optional

Can be used to store key parameters of the method for obtaining the filter.

ch_names: list or None, optional

Can be used to store names of the channels that the weights correspond to.

name: str, optional

Can be used to add a unique name to the filter (e.g., name of the ROI).

__init__(w, method='', method_params={}, ch_names=None, name='') → None

Methods

__init__(w[, method, method_params, ...])
apply(data[, ch_names])
apply_raw(raw)
from_inverse(fwd, inv, label, inv_method, ...)
get_ctf(L[, mode, normalize])
get_ctf_fwd(fwd[, mode, normalize, subject])
plot(info, **topomap_kwargs)

Attributes

size