stim_artifact.h File Reference

Declaration of fixStimArtifact — stimulus artifact repair by interpolation or zeroing. More...

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

Include dependency graph for stim_artifact.h:

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

Go to the source code of this file.

Namespaces
namespace	UTILSLIB
	Shared utilities (I/O helpers, spectral analysis, layout management, warp algorithms).

Enumerations
enum class	UTILSLIB::StimArtifactMode { UTILSLIB::Linear , UTILSLIB::Window }
	Mode for stimulus artifact repair. More...

Functions
DSPSHARED_EXPORT void	UTILSLIB::fixStimArtifact (Eigen::MatrixXd &data, const Eigen::MatrixXi &events, double sfreq, int eventId=-1, double tmin=0.0, double tmax=0.01, StimArtifactMode mode=StimArtifactMode::Linear)
	Repair stimulus artifacts by interpolating or zeroing data around events.

Detailed Description

Declaration of fixStimArtifact — stimulus artifact repair by interpolation or zeroing.

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

Repairs stimulus artifacts in continuous data by replacing samples in a window around each stimulus event with either linearly interpolated values (from the window boundaries) or zeros. This mirrors the functionality of MNE-Python's mne.preprocessing.fix_stim_artifact().

Definition in file stim_artifact.h.