simulate.h File Reference

Simulation utilities for source estimates and evoked data. More...

#include "dsp_global.h"
#include <Eigen/Core>
#include <QList>

Include dependency graph for simulate.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	UTILSLIB::SimulateStcParams
	Parameters for source time course simulation. More...

Namespaces
namespace	INVLIB
	Inverse source estimation (MNE, dSPM, sLORETA, dipole fitting).
namespace	FIFFLIB
	FIFF file I/O, in-memory data structures and high-level readers/writers.
namespace	MNELIB
	Core MNE data structures (source spaces, source estimates, hemispheres).
namespace	UTILSLIB
	Shared utilities (I/O helpers, spectral analysis, layout management, warp algorithms).

Functions
DSPSHARED_EXPORT INVLIB::InvSourceEstimate	UTILSLIB::simulateStc (const Eigen::VectorXi &activeVertices, const Eigen::VectorXi &allVertices, const SimulateStcParams &params=SimulateStcParams())
	Create a synthetic source time course.
DSPSHARED_EXPORT INVLIB::InvSourceEstimate	UTILSLIB::simulateStcFromWaveforms (const Eigen::MatrixXd &waveforms, const Eigen::VectorXi &activeVertices, const Eigen::VectorXi &allVertices, float tmin=0.0f, float tstep=0.001f)
	Create a synthetic source time course from custom waveforms.
DSPSHARED_EXPORT FIFFLIB::FiffEvoked	UTILSLIB::simulateEvoked (const MNELIB::MNEForwardSolution &fwd, const INVLIB::InvSourceEstimate &stc, const FIFFLIB::FiffInfo &info, const FIFFLIB::FiffCov &noiseCov, int nave=1, int seed=42)
	Simulate evoked data from a source estimate and forward model.
DSPSHARED_EXPORT FIFFLIB::FiffEvoked	UTILSLIB::simulateEvokedNoiseless (const MNELIB::MNEForwardSolution &fwd, const INVLIB::InvSourceEstimate &stc, const FIFFLIB::FiffInfo &info)
	Simulate evoked data without noise.

Detailed Description

Simulation utilities for source estimates and evoked data.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2026 MNE-CPP Authors

Author

Christoph Dinh chris.nosp@m.toph.nosp@m..dinh.nosp@m.@mne.nosp@m.-cpp..nosp@m.org

Since

2.2.1

Date

May 2026

Provides functions equivalent to MNE-Python's mne.simulation module:

• simulateStc(): create synthetic source time courses
• simulateEvoked(): generate synthetic evoked data from forward model

Definition in file simulate.h.