This documentation is for development version 0.18.dev0.

mne.scale_mri

mne.scale_mri(subject_from, subject_to, scale, overwrite=False, subjects_dir=None, skip_fiducials=False, labels=True, annot=False, verbose=None)[source]

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 | str

Override the SUBJECTS_DIR environment variable.

skip_fiducials : bool

Do not scale the MRI fiducials. If False (default), an IOError 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).

verbose : bool, str, int, or None

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

See also

scale_labels
add labels to a scaled MRI
scale_source_space
add a source space to a scaled MRI