On this page

mne.head_to_mri#

mne.head_to_mri(pos, subject, mri_head_t, subjects_dir=None, *, kind=None, unscale=False, verbose=None)[source]#

Convert pos from head coordinate system to MRI ones.

Parameters:
posarray, shape (n_pos, 3)

The coordinates (in m) in head coordinate system.

subjectstr

The FreeSurfer subject name.

mri_head_tinstance of Transform

MRI<->Head coordinate transformation.

subjects_dirpath-like | None

The path to the directory containing the FreeSurfer subjects reconstructions. If None, defaults to the SUBJECTS_DIR environment variable.

kindstr

The MRI coordinate frame kind, can be 'ras' (default in 1.2) to use MRI RAS (scanner RAS) or 'mri' (default in 1.3) for FreeSurfer surface RAS.

New in version 1.2.

unscalebool

For surrogate MRIs (e.g., scaled using mne coreg), if True (default False), use the MRI scaling parameters to obtain points in the original/surrogate subject’s MRI space.

New in version 1.2.

verbosebool | str | int | None

Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns:
coordinatesarray, shape (n_pos, 3)

The MRI RAS coordinates (in mm) of pos.

Notes

This function requires nibabel.