mne.bem.distance_to_bem#

mne.bem.distance_to_bem(pos, bem, trans=None, verbose=None)[source]#

Calculate the distance of positions to inner skull surface.

Parameters:
posarray, shape (…, 3)

Position(s) in m, in head coordinates.

beminstance of ConductorModel

Conductor model.

transpath-like | dict | instance of Transform | "fsaverage" | None

If str, the path to the head<->MRI transform *-trans.fif file produced during coregistration. Can also be 'fsaverage' to use the built-in fsaverage transformation. If trans is None, an identity matrix is assumed. If None (default), assumes bem is in head coordinates.

Changed in version 0.19: Support for ‘fsaverage’ argument.

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:
distancesfloat | array, shape (…)

The computed distance(s). A float is returned if pos is an array of shape (3,) corresponding to a single position.

Notes

New in v1.1.