mne.dig_mri_distances¶
- mne.dig_mri_distances(info, trans, subject, subjects_dir=None, dig_kinds='auto', exclude_frontal=False, verbose=None)[source]¶
Compute distances between head shape points and the scalp surface.
This function is useful to check that coregistration is correct. Unless outliers are present in the head shape points, one can assume an average distance around 2-3 mm.
- Parameters
- infoinstance of
Info
The measurement info that contains the head shape points in
info['dig']
.- trans
str
| instance ofTransform
The head<->MRI transform. If str is passed it is the path to file on disk.
- subject
str
The name of the subject.
- subjects_dir
str
|None
Directory containing subjects data. If None use the Freesurfer SUBJECTS_DIR environment variable.
- dig_kinds
list
ofstr
|str
Kind of digitization points to use in the fitting. These can be any combination of (‘cardinal’, ‘hpi’, ‘eeg’, ‘extra’). Can also be ‘auto’ (default), which will use only the ‘extra’ points if enough (more than 4) are available, and if not, uses ‘extra’ and ‘eeg’ points.
- exclude_frontalbool
If True, exclude points that have both negative Z values (below the nasion) and positivy Y values (in front of the LPA/RPA). Default is False.
- verbosebool,
str
,int
, orNone
If not None, override default verbose level (see
mne.verbose()
and Logging documentation for more). If used, it should be passed as a keyword-argument only.
- infoinstance of
- Returns
- dists
array
, shape (n_points,) The distances.
- dists
See also
Notes
New in version 0.19.