class eelbrain.SourceSpace(vertices, subject=None, src=None, subjects_dir=None, parc='aparc', connectivity='custom', name='source', filename='{subject}-{src}-src.fif')

MNE surface-based source space

vertices : list of 2 int arrays

The vertex identities of the dipoles in the source space (left and right hemisphere separately).

subject : str

The mri-subject name.

src : str

The kind of source space used (e.g., ‘ico-4’; only ico is currently supported.

subjects_dir : str

The path to the subjects_dir (needed to locate the source space file).

parc : None | str

Add a parcellation to the source space to identify vertex location. Only applies to ico source spaces, default is ‘aparc’.

connectivity : ‘grid’ | ‘none’ | array of int, (n_edges, 2)

Connectivity between elements. Set to "none" for no connections or "grid" to use adjacency in the sequence of elements as connection. Set to numpy.ndarray to specify custom connectivity. The array should be of shape (n_edges, 2), and each row should specify one connection [i, j] with i < j, with rows sorted in ascending order. If the array’s dtype is uint32, property checks are disabled to improve efficiency.

name : str

Dimension name (default "source").

filename : str

Filename template for the MNE source space file.

See also

volume source space


besides numpy indexing, the following indexes are possible:

  • mne Label objects
  • ‘lh’ or ‘rh’ to select an entire hemisphere
coordinates : array (n_sources, 3)

Spatial coordinate for each source.

normals : array (n_sources, 3)

Orientation (direction) of each source.

parc : Factor

Parcellation (one label for each source).


circular_index(self, seeds[, extent, name]) Return an index into all vertices closer than extent of a seed
connectivity(self[, disconnect_parc]) Create source space connectivity
dimindex(self, arg) Convert a dimension index to an array index
from_file(subjects_dir, subject, src[, parc]) SourceSpace dimension from MNE source space file
from_mne_source_spaces(source_spaces, src, …) SourceSpace dimension from MNE SourceSpaces object
get_source_space(self[, subjects_dir]) Read the corresponding MNE source space
index_for_label(self, label) Return the index for a label
index_into_dim(self, dim) Index into a subset dimension
intersect(self, other[, check_dims]) Create a Source dimension that is the intersection with dim
surface_coordinates(self[, surf]) Load surface coordinates for any FreeSurfer surface