Function scale_mri

mne/coreg.py:1021–1233

Create a scaled copy of an MRI subject. Parameters ---------- subject_from : str Name of the subject providing the MRI. subject_to : str New subject name for which to save the scaled MRI. scale : float | array_like, shape = (3,) The scaling factor (one or

(
    subject_from,
    subject_to,
    scale,
    overwrite=False,
    subjects_dir=None,
    skip_fiducials=False,
    labels=True,
    annot=False,
    *,
    on_defects="raise",
    mri_fiducials=None,
    verbose=None,
)

@verbose
def scale_mri(
    subject_from,
    subject_to,
    scale,
    overwrite=False,
    subjects_dir=None,
    skip_fiducials=False,
    labels=True,
    annot=False,
    *,
    on_defects="raise",
    mri_fiducials=None,
    verbose=None,
):
    """Create a scaled copy of an MRI subject.

    Parameters
    ----------
    subject_from : str
        Name of the subject providing the MRI.
    subject_to : str
        New subject name for which to save the scaled MRI.
    scale : float | array_like, shape = (3,)
        The scaling factor (one or 3 parameters).
    overwrite : bool
        If an MRI already exists for subject_to, overwrite it.
    subjects_dir : None | path-like
        Override the ``SUBJECTS_DIR`` environment variable.
    skip_fiducials : bool
        Do not scale the MRI fiducials. If False (default), an OSError will be
        raised if no fiducials file can be found.
    labels : bool
        Also scale all labels (default True).
    annot : bool
        Copy ``*.annot`` files to the new location (default False).
    %(on_defects)s

        .. versionadded:: 1.0
    mri_fiducials : None | list of dict
        If provided, these fiducials will be used as the originals to scale instead
        of reading from ``{subject_from}/bem/{subject_from}-fiducials.fif``.
        This is useful typically when using ``mne coreg`` or similar and you have
        modified the MRI fiducials interactively, but have not saved them to disk.

        .. versionadded:: 1.12
    %(verbose)s

    See Also
    --------
    scale_bem : Add a scaled BEM to a scaled MRI.
    scale_labels : Add labels to a scaled MRI.
    scale_source_space : Add a source space to a scaled MRI.

    Notes
    -----
    This function will automatically call :func:`scale_bem`,
    :func:`scale_labels`, and :func:`scale_source_space` based on expected
    filename patterns in the subject directory.