Function make_forward_solution

mne/forward/_make_forward.py:617–764

Calculate a forward solution for a subject. Parameters ---------- %(info_str)s %(trans)s .. versionchanged:: 0.19 Support for ``'fsaverage'`` argument. src : path-like | instance of SourceSpaces Either a path to a source space file or a loaded or gen

(
    info,
    trans,
    src,
    bem,
    meg=True,
    eeg=True,
    *,
    mindist=0.0,
    ignore_ref=False,
    n_jobs=None,
    on_inside="raise",
    verbose=None,
)

@verbose
def make_forward_solution(
    info,
    trans,
    src,
    bem,
    meg=True,
    eeg=True,
    *,
    mindist=0.0,
    ignore_ref=False,
    n_jobs=None,
    on_inside="raise",
    verbose=None,
):
    """Calculate a forward solution for a subject.

    Parameters
    ----------
    %(info_str)s
    %(trans)s

        .. versionchanged:: 0.19
            Support for ``'fsaverage'`` argument.
    src : path-like | instance of SourceSpaces
        Either a path to a source space file or a loaded or generated
        :class:`~mne.SourceSpaces`.
    bem : path-like | ConductorModel
        Filename of the BEM (e.g., ``"sample-5120-5120-5120-bem-sol.fif"``) to
        use, or a loaded :class:`~mne.bem.ConductorModel`. See
        :func:`~mne.make_bem_model` and :func:`~mne.make_bem_solution` to create a
        :class:`mne.bem.ConductorModel`.
    meg : bool
        If True (default), include MEG computations.
    eeg : bool
        If True (default), include EEG computations.
    mindist : float
        Minimum distance of sources from inner skull surface (in mm).
    ignore_ref : bool
        If True, do not include reference channels in compensation. This
        option should be True for KIT files, since forward computation
        with reference channels is not currently supported.
    %(n_jobs)s
    on_inside : 'raise' | 'warn' | 'ignore'
        What to do if MEG sensors are inside the outer skin surface. If 'raise'
        (default), an error is raised. If 'warn' or 'ignore', the forward
        solution is computed anyway and a warning is or isn't emitted,
        respectively.

        .. versionadded:: 1.10
    %(verbose)s

    Returns
    -------
    fwd : instance of Forward
        The forward solution.

    See Also
    --------