mne.simulation.simulate_stc¶

mne.simulation.simulate_stc(src, labels, stc_data, tmin, tstep, value_fun=None, allow_overlap=False)[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
srcinstance of SourceSpaces

The source space.

labels

The labels.

stc_dataarray, shape (n_labels, n_times)

The waveforms.

tminfloat

The beginning of the timeseries.

tstepfloat

The time step (1 / sampling frequency).

value_fun

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.

allow_overlapbool

Allow overlapping labels or not. Default value is False.

New in version 0.18.

Returns
stcSourceEstimate

The generated source time courses.