mne.simulation.simulate_stc¶

mne.simulation.simulate_stc(src, labels, stc_data, tmin, tstep, value_fun=None)[source]¶

Simulate sources time courses from waveforms and labels.

This function generates a source estimate with extended sources by filling the labels with the waveforms given in stc_data.

Parameters:

Parameters:	src : instance of SourceSpaces The source space labels : list of Labels The labels stc_data : array (shape: len(labels) x n_times) The waveforms tmin : float The beginning of the timeseries tstep : float The time step (1 / sampling frequency) value_fun : function \| None Function to apply to the label values to obtain the waveform scaling for each vertex in the label. If None (default), uniform scaling is used.
Returns:	stc : SourceEstimate The generated source time courses.

src : instance of SourceSpaces: The source space
labels : list of Labels: The labels
stc_data : array (shape: len(labels) x n_times): The waveforms
tmin : float: The beginning of the timeseries
tstep : float: The time step (1 / sampling frequency)
value_fun : function | None: Function to apply to the label values to obtain the waveform scaling for each vertex in the label. If None (default), uniform scaling is used.

Returns:

Examples using `mne.simulation.simulate_stc`¶