mne.SourceSpaces¶

class mne.SourceSpaces(source_spaces, info=None)[source]¶

Represent a list of source space.

Currently implemented as a list of dictionaries containing the source space information

Parameters:	source_spaces : list A list of dictionaries containing the source space information. info : dict Dictionary with information about the creation of the source space file. Has keys ‘working_dir’ and ‘command_line’.
Attributes:	info : dict Dictionary with information about the creation of the source space file. Has keys ‘working_dir’ and ‘command_line’.

Methods

__add__(other)	Combine source spaces.
__contains__($self, key, /)	Return key in self.
__getitem__	x.__getitem__(y) <==> x[y]
__iter__($self, /)	Implement iter(self).
__len__($self, /)	Return len(self).
__mul__($self, value, /)	Return self*value.
append(object)
clear()
copy()	Make a copy of the source spaces.
count(value)
export_volume(fname[, include_surfaces, …])	Export source spaces to nifti or mgz file.
extend(iterable)
index(value, [start, [stop]])	Raises ValueError if the value is not present.
insert	L.insert(index, object) – insert object before index
plot([head, brain, skull, subjects_dir, …])	Plot the source space.
pop([index])	Raises IndexError if list is empty or index is out of range.
remove(value)	Raises ValueError if the value is not present.
reverse	L.reverse() – reverse IN PLACE
save(fname[, overwrite])	Save the source spaces to a fif file.
sort([key, reverse])

__add__(other)[source]¶

Combine source spaces.

__contains__($self, key, /)¶

Return key in self.

__getitem__()¶

x.__getitem__(y) <==> x[y]

__iter__($self, /)¶

Implement iter(self).

__len__($self, /)¶

Return len(self).

__mul__($self, value, /)¶

Return self*value.

append(object) → None -- append object to end¶

clear() → None -- remove all items from L¶

copy()[source]¶

Make a copy of the source spaces.

Returns:	src : instance of SourceSpaces The copied source spaces.

count(value) → integer -- return number of occurrences of value¶

export_volume(fname, include_surfaces=True, include_discrete=True, dest='mri', trans=None, mri_resolution=False, use_lut=True, verbose=None)[source]¶

Export source spaces to nifti or mgz file.

Parameters:

fname : str Name of nifti or mgz file to write. include_surfaces : bool If True, include surface source spaces. include_discrete : bool If True, include discrete source spaces. dest : ‘mri’ | ‘surf’ If ‘mri’ the volume is defined in the coordinate system of the original T1 image. If ‘surf’ the coordinate system of the FreeSurfer surface is used (Surface RAS). trans : dict, str, or None Either a transformation filename (usually made using mne_analyze) or an info dict (usually opened using read_trans()). If string, an ending of .fif or .fif.gz will be assumed to be in FIF format, any other ending will be assumed to be a text file with a 4x4 transformation matrix (like the –trans MNE-C option. Must be provided if source spaces are in head coordinates and include_surfaces and mri_resolution are True. mri_resolution : bool If True, the image is saved in MRI resolution (e.g. 256 x 256 x 256). use_lut : bool If True, assigns a numeric value to each source space that corresponds to a color on the freesurfer lookup table. verbose : bool, str, int, or None If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Notes

This method requires nibabel.

extend(iterable) → None -- extend list by appending elements from the iterable¶

index(value[, start[, stop]]) → integer -- return first index of value.¶

Raises ValueError if the value is not present.

insert()¶

L.insert(index, object) – insert object before index

kind¶

The kind of source space (surface, volume, discrete, mixed).

plot(head=False, brain=None, skull=None, subjects_dir=None, trans=None, verbose=None)[source]¶

Plot the source space.

Parameters:

head : bool If True, show head surface. brain : bool | str If True, show the brain surfaces. Can also be a str for surface type (e.g., ‘pial’, same as True). Default is None, which means ‘white’ for surface source spaces and False otherwise. skull : bool | str | list of str | list of dict | None Whether to plot skull surface. If string, common choices would be ‘inner_skull’, or ‘outer_skull’. Can also be a list to plot multiple skull surfaces. If a list of dicts, each dict must contain the complete surface info (such as you get from mne.make_bem_model()). True is an alias of ‘outer_skull’. The subjects bem and bem/flash folders are searched for the ‘surf’ files. Defaults to None, which is False for surface source spaces, and True otherwise. subjects_dir : string, or None Path to SUBJECTS_DIR if it is not set in the environment. trans : str | ‘auto’ | dict | None The full path to the head<->MRI transform *-trans.fif file produced during coregistration. If trans is None, an identity matrix is assumed. This is only needed when the source space is in head coordinates. verbose : bool, str, int, or None If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Returns:

fig : instance of mlab Figure The figure.

pop([index]) → item -- remove and return item at index (default last).¶

Raises IndexError if list is empty or index is out of range.

remove(value) → None -- remove first occurrence of value.¶

Raises ValueError if the value is not present.

reverse()¶

L.reverse() – reverse IN PLACE

save(fname, overwrite=False)[source]¶

Save the source spaces to a fif file.

Parameters:	fname : str File to write. overwrite : bool If True, the destination file (if it exists) will be overwritten. If False (default), an error will be raised if the file exists.

sort(key=None, reverse=False) → None -- stable sort *IN PLACE*¶