mne.setup_source_space

mne.setup_source_space(subject, spacing='oct6', surface='white', subjects_dir=None, add_dist=True, n_jobs=1, verbose=None)[source]

Set up bilateral hemisphere surface-based source space with subsampling.

Parameters
subjectstr

The FreeSurfer subject name.

spacingstr

The spacing to use. Can be 'ico#' for a recursively subdivided icosahedron, 'oct#' for a recursively subdivided octahedron, 'all' for all points, or an integer to use approximate distance-based spacing (in mm).

Changed in version 0.18: Support for integers for distance-based spacing.

surfacestr

The surface to use.

subjects_dirstr | None

The path to the FreeSurfer subjects reconstructions. It corresponds to FreeSurfer environment variable SUBJECTS_DIR.

add_distbool | str

Add distance and patch information to the source space. This takes some time so precomputing it is recommended. Can also be ‘patch’ to only compute patch information (requires SciPy 1.3+).

Changed in version 0.20: Support for add_dist=’patch’.

n_jobsint

The number of jobs to run in parallel (default 1). Requires the joblib package. Ignored if add_dist=='patch'.

verbosebool, str, int, or None

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.

Returns
srcSourceSpaces

The source space for each hemisphere.

Examples using mne.setup_source_space