mne.beamformer.lcmv_raw¶

mne.beamformer.lcmv_raw(raw, forward, noise_cov, data_cov, reg=0.05, label=None, start=None, stop=None, picks=None, pick_ori=None, rank=None, verbose=None)[source]¶

Linearly Constrained Minimum Variance (LCMV) beamformer.

Compute Linearly Constrained Minimum Variance (LCMV) beamformer on raw data.

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

Parameters:

Parameters:	raw : mne.io.Raw Raw data to invert. forward : dict Forward operator. noise_cov : Covariance The noise covariance. data_cov : Covariance The data covariance. reg : float The regularization for the whitened data covariance. label : Label Restricts the LCMV solution to a given label. start : int Index of first time sample (index not time is seconds). stop : int Index of first time sample not to include (index not time is seconds). picks : array-like of int Channel indices to use for beamforming (if None all channels are used except bad channels). pick_ori : None \| ‘normal’ \| ‘max-power’ If ‘normal’, rather than pooling the orientations by taking the norm, only the radial component is kept. If ‘max-power’, the source orientation that maximizes output source power is chosen. rank : None \| int \| dict Specified rank of the noise covariance matrix. If None, the rank is detected automatically. If int, the rank is specified for the MEG channels. A dictionary with entries ‘eeg’ and/or ‘meg’ can be used to specify the rank for each modality. verbose : bool, str, int, or None If not None, override default verbose level (see `mne.verbose()` and Logging documentation for more).
Returns:	stc : SourceEstimate \| VolSourceEstimate Source time courses

raw : mne.io.Raw

Raw data to invert.

forward : dict

Forward operator.

noise_cov : Covariance

The noise covariance.

data_cov : Covariance

The data covariance.

reg : float

The regularization for the whitened data covariance.

label : Label

Restricts the LCMV solution to a given label.

start : int

Index of first time sample (index not time is seconds).

stop : int

Index of first time sample not to include (index not time is seconds).

picks : array-like of int

Channel indices to use for beamforming (if None all channels are used except bad channels).

pick_ori : None | ‘normal’ | ‘max-power’

If ‘normal’, rather than pooling the orientations by taking the norm, only the radial component is kept. If ‘max-power’, the source orientation that maximizes output source power is chosen.

rank : None | int | dict

Specified rank of the noise covariance matrix. If None, the rank is detected automatically. If int, the rank is specified for the MEG channels. A dictionary with entries ‘eeg’ and/or ‘meg’ can be used to specify the rank for each modality.

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Returns:

stc : SourceEstimate | VolSourceEstimate

Source time courses