mne.beamformer.apply_dics_epochs

mne.beamformer.apply_dics_epochs(epochs, filters, return_generator=False, verbose=None)[source]

Apply Dynamic Imaging of Coherent Sources (DICS) beamformer weights.

Apply Dynamic Imaging of Coherent Sources (DICS) beamformer weights on single trial data.

Warning

The result of this function is meant as an intermediate step for further processing (such as computing connectivity). If you are interested in estimating source time courses, use an LCMV beamformer (make_lcmv(), apply_lcmv()) instead. If you are interested in estimating spectral power at the source level, use apply_dics_csd().

Warning

This implementation has not been heavily tested so please report any issue or suggestions.

Parameters
epochsEpochs

Single trial epochs.

filtersinstance of Beamformer

DICS spatial filter (beamformer weights) Filter weights returned from make_dics(). The DICS filters must have been computed for a single frequency only.

return_generatorbool

Return a generator object instead of a list. This allows iterating over the stcs without having to keep them all in memory.

verbosebool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more). If used, it should be passed as a keyword-argument only.

Returns
stc: list | generator of (SourceEstimate | VolSourceEstimate)

The source estimates for all epochs.

Examples using mne.beamformer.apply_dics_epochs