This documentation is for development version 0.18.dev0.

mne.bem.fit_sphere_to_headshape

mne.bem.fit_sphere_to_headshape(info, dig_kinds='auto', units='m', verbose=None)[source]

Fit a sphere to the headshape points to determine head center.

Parameters:
info : instance of Info

Measurement info.

dig_kinds : list of str | 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 10) are available, and if not, uses ‘extra’ and ‘eeg’ points.

units : str

Can be “m” (default) or “mm”.

New in version 0.12.

verbose : bool, str, int, or None

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

Returns:
radius : float

Sphere radius.

origin_head: ndarray, shape (3,)

Head center in head coordinates.

origin_device: ndarray, shape (3,)

Head center in device coordinates.

Notes

This function excludes any points that are low and frontal (z < 0 and y > 0) to improve the fit.