Function regularize

mne/cov.py:1921–2130

Regularize noise covariance matrix. This method works by adding a constant to the diagonal for each channel type separately. Special care is taken to keep the rank of the data constant. .. note:: This function is kept for reasons of backward-compatibility. Please cons

(
    cov,
    info,
    mag=0.1,
    grad=0.1,
    eeg=0.1,
    exclude="bads",
    proj=True,
    seeg=0.1,
    ecog=0.1,
    hbo=0.1,
    hbr=0.1,
    fnirs_cw_amplitude=0.1,
    fnirs_fd_ac_amplitude=0.1,
    fnirs_fd_phase=0.1,
    fnirs_od=0.1,
    csd=0.1,
    dbs=0.1,
    rank=None,
    scalings=None,
    verbose=None,
)

@verbose
def regularize(
    cov,
    info,
    mag=0.1,
    grad=0.1,
    eeg=0.1,
    exclude="bads",
    proj=True,
    seeg=0.1,
    ecog=0.1,
    hbo=0.1,
    hbr=0.1,
    fnirs_cw_amplitude=0.1,
    fnirs_fd_ac_amplitude=0.1,
    fnirs_fd_phase=0.1,
    fnirs_od=0.1,
    csd=0.1,
    dbs=0.1,
    rank=None,
    scalings=None,
    verbose=None,
):
    """Regularize noise covariance matrix.

    This method works by adding a constant to the diagonal for each
    channel type separately. Special care is taken to keep the
    rank of the data constant.

    .. note:: This function is kept for reasons of backward-compatibility.
              Please consider explicitly using the ``method`` parameter in
              :func:`mne.compute_covariance` to directly combine estimation
              with regularization in a data-driven fashion. See the
              :ref:`FAQ <faq_how_should_i_regularize>` for more information.

    Parameters
    ----------
    cov : Covariance
        The noise covariance matrix.
    %(info_not_none)s (Used to get channel types and bad channels).
    mag : float (default 0.1)
        Regularization factor for MEG magnetometers.
    grad : float (default 0.1)
        Regularization factor for MEG gradiometers. Must be the same as
        ``mag`` if data have been processed with SSS.
    eeg : float (default 0.1)
        Regularization factor for EEG.
    exclude : list | 'bads' (default 'bads')
        List of channels to mark as bad. If 'bads', bads channels
        are extracted from both info['bads'] and cov['bads'].
    proj : bool (default True)
        Apply projections to keep rank of data.
    seeg : float (default 0.1)
        Regularization factor for sEEG signals.
    ecog : float (default 0.1)
        Regularization factor for ECoG signals.
    hbo : float (default 0.1)
        Regularization factor for HBO signals.
    hbr : float (default 0.1)