mne.simulation.simulate_sparse_stc¶

mne.simulation.
simulate_sparse_stc
(src, n_dipoles, times, data_fun=<function <lambda>>, labels=None, random_state=None, location='random', subject=None, subjects_dir=None, surf='sphere')[source]¶ Generate sparse (n_dipoles) sources time courses from data_fun.
This function randomly selects
n_dipoles
vertices in the whole cortex or one single vertex (randomly in or in the center of) each label iflabels is not None
. It usesdata_fun
to generate waveforms for each vertex. Parameters
 srcinstance of
SourceSpaces
The source space.
 n_dipoles
int
Number of dipoles to simulate.
 times
array
Time array.
 data_fun
callable()
Function to generate the waveforms. The default is a 100 nAm, 10 Hz sinusoid as
1e7 * np.sin(20 * pi * t)
. The function should take as input the array of time samples in seconds and return an array of the same length containing the time courses. labels
None
list
ofLabel
The labels. The default is None, otherwise its size must be n_dipoles.
 random_state
None
int
 instance ofRandomState
If
random_state
is anint
, it will be used as a seed forRandomState
. IfNone
, the seed will be obtained from the operating system (seeRandomState
for details). Default isNone
. location
str
The label location to choose. Can be ‘random’ (default) or ‘center’ to use
mne.Label.center_of_mass()
. Note that for ‘center’ mode the label values are used as weights.New in version 0.13.
 subject
str
None
The subject the label is defined for. Only used with
location='center'
.New in version 0.13.
 subjects_dir
str
None
The path to the FreeSurfer subjects reconstructions. It corresponds to FreeSurfer environment variable
SUBJECTS_DIR
.New in version 0.13.
 surf
str
The surface to use for Euclidean distance center of mass finding. The default here is “sphere”, which finds the center of mass on the spherical surface to help avoid potential issues with cortical folding.
New in version 0.13.
 srcinstance of
 Returns
 stc
SourceEstimate
The generated source time courses.
 stc
See also
Notes
New in version 0.10.0.