meegsim.configuration.SourceConfiguration

class meegsim.configuration.SourceConfiguration(src, sfreq, duration, random_state=None)

This class describes a simulated configuration of sources of brain activity and noise.

Attributes:

srcSourceSpaces

Source spaces object that stores all candidate source locations.

sfreqfloat

Sampling frequency of the simulated data, in Hz.

durationfloat

Length of the simulated data, in seconds.

random_stateint or None, optional

Random state that was used to generate the configuration.

Methods

to_raw(fwd, info[, scaling_factor])	Project the activity of all simulated sources to sensor space.
to_stc()	Obtain an stc object that contains data from all sources in the configuration.

to_raw(fwd, info, scaling_factor=1e-06)

Project the activity of all simulated sources to sensor space.

Parameters:

fwdForward

The forward model.

infoInfo

The info structure that describes the channel layout.

scaling_factorfloat, optional

The source activity is scaled by this factor before projecting to sensor space. By default, the scaling factor is equal to \(10^{-6}\).

Returns:

rawRaw

The simulated sensor space data.

to_stc()

Obtain an stc object that contains data from all sources in the configuration.

Returns:

stcSourceEstimate

The resulting stc object that contains data from all sources.