mne.beamformer.dics_epochs¶

mne.beamformer.dics_epochs(epochs, forward, noise_csd, data_csd, reg=0.05, label=None, pick_ori=None, return_generator=False, real_filter=False, verbose=None)[source]¶

Dynamic Imaging of Coherent Sources (DICS).

Compute a Dynamic Imaging of Coherent Sources (DICS) beamformer on single trial data and return estimates of source time courses.

Note

Fixed orientation forward operators with real_filter=False will result in complex time courses, in which case absolute values will be returned.

Warning

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

Parameters:

epochs : Epochs Single trial epochs. forward : dict Forward operator. noise_csd : instance of CrossSpectralDensity The noise cross-spectral density. data_csd : instance of CrossSpectralDensity The data cross-spectral density. reg : float The regularization for the cross-spectral density. label : Label | None Restricts the solution to a given label. pick_ori : None | ‘normal’ If ‘normal’, rather than pooling the orientations by taking the norm, only the radial component is kept. return_generator : bool Return a generator object instead of a list. This allows iterating over the stcs without having to keep them all in memory. real_filter : bool If True, take only the real part of the cross-spectral-density matrices to compute real filters as in [2]_. Default is False. verbose : bool, str, int, or None If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Returns:

stc: list | generator of SourceEstimate | VolSourceEstimate The source estimates for all epochs

See also

dics