Function plot_alignment

mne/viz/_3d.py:531–1015

Plot head, sensor, and source space alignment in 3D. Parameters ---------- %(info)s If None (default), no sensor information will be shown. %(trans)s "auto" will load trans from the FreeSurfer directory specified by ``subject`` and ``subjects_dir`` parameters. .. ve

(
    info=None,
    trans=None,
    subject=None,
    subjects_dir=None,
    surfaces="auto",
    coord_frame="auto",
    meg=None,
    eeg="original",
    fwd=None,
    dig=False,
    ecog=True,
    src=None,
    mri_fiducials=False,
    bem=None,
    seeg=True,
    fnirs=True,
    show_axes=False,
    dbs=True,
    fig=None,
    interaction="terrain",
    sensor_colors=None,
    *,
    sensor_scales=None,
    show_channel_names=False,
    verbose=None,
)

@verbose
def plot_alignment(
    info=None,
    trans=None,
    subject=None,
    subjects_dir=None,
    surfaces="auto",
    coord_frame="auto",
    meg=None,
    eeg="original",
    fwd=None,
    dig=False,
    ecog=True,
    src=None,
    mri_fiducials=False,
    bem=None,
    seeg=True,
    fnirs=True,
    show_axes=False,
    dbs=True,
    fig=None,
    interaction="terrain",
    sensor_colors=None,
    *,
    sensor_scales=None,
    show_channel_names=False,
    verbose=None,
):
    """Plot head, sensor, and source space alignment in 3D.

    Parameters
    ----------
    %(info)s If None (default), no sensor information will be shown.
    %(trans)s "auto" will load trans from the FreeSurfer directory
        specified by ``subject`` and ``subjects_dir`` parameters.

        .. versionchanged:: 0.19
            Support for 'fsaverage' argument.
    %(subject)s Can be omitted if ``src`` is provided.
    %(subjects_dir)s
    surfaces : str | list | dict
        Surfaces to plot. Supported values:

        * scalp: one of 'head', 'outer_skin' (alias for 'head'),
          'head-dense', or 'seghead' (alias for 'head-dense')
        * skull: 'outer_skull', 'inner_skull', 'brain' (alias for
          'inner_skull')
        * brain: one of 'pial', 'white', 'inflated', or 'brain'
          (alias for 'pial').

        Can be dict to specify alpha values for each surface. Use None
        to specify default value. Specified values must be between 0 and 1.
        for example::

            surfaces=dict(brain=0.4, outer_skull=0.6, head=None)

        Defaults to 'auto', which will look for a head surface and plot
        it if found.