roiextract.filter.apply_batch#

roiextract.filter.apply_batch(data, filters, ch_names=None)#

Apply a set of spatial filters to the provided data.

Parameters:
dataarray, shape (n_sensors, n_times)

The continuous data.

filterslist of SpatialFilter

Spatial filters to be applied to the data.

ch_nameslist of str, optional

The names of the channels in the data. If provided, the function will ensure that the channels and filter weights are matched properly. An error is raised if the number of channels differs between the filters and the data, or if the names of channels do not match.

Returns:
tcarray, shape (n_filters, n_times)

Array with time courses that correspond to the provided spatial filters.