mne.add_source_space_distances¶

mne.
add_source_space_distances
(src, dist_limit=inf, n_jobs=1, verbose=None)[source]¶ Compute intersource distances along the cortical surface.
This function will also try to add patch info for the source space. It will only occur if the
dist_limit
is sufficiently high that all points on the surface are withindist_limit
of a point in the source space. Parameters
 srcinstance of
SourceSpaces
The source spaces to compute distances for.
 dist_limit
float
The upper limit of distances to include (in meters). Note: if limit < np.inf, scipy > 0.13 (bleeding edge as of 10/2013) must be installed. If 0, then only patch (nearest vertex) information is added.
 n_jobs
int
The number of jobs to run in parallel (default 1). Requires the joblib package. Ignored if
dist_limit==0.
. 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 keywordargument only.
 srcinstance of
 Returns
 srcinstance of
SourceSpaces
The original source spaces, with distance information added. The distances are stored in src[n][‘dist’]. Note: this function operates inplace.
 srcinstance of
Notes
This function can be memory and CPUintensive. On a highend machine (2012) running 6 jobs in parallel, an ico5 (10242 per hemi) source space takes about 10 minutes to compute all distances (
dist_limit = np.inf
). Withdist_limit = 0.007
, computing distances takes about 1 minute.We recommend computing distances once per source space and then saving the source space to disk, as the computed distances will automatically be stored along with the source space data for future use.