filter_chpi.h File Reference

Declaration of filterChpi — cHPI signal removal by notch filtering. More...

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

Include dependency graph for filter_chpi.h:

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

Go to the source code of this file.

Classes
struct	UTILSLIB::FilterChpiParams
	Parameters for cHPI notch filtering. More...

Namespaces
namespace	FIFFLIB
	FIFF file I/O, in-memory data structures and high-level readers/writers.
namespace	UTILSLIB
	Shared utilities (I/O helpers, spectral analysis, layout management, warp algorithms).

Functions
DSPSHARED_EXPORT void	UTILSLIB::filterChpi (Eigen::MatrixXd &data, const FIFFLIB::FiffInfo &info, double sfreq, const QVector< double > &hpiFreqs, const FilterChpiParams &params=FilterChpiParams())
	Remove cHPI excitation signals from MEG data by notch filtering.
DSPSHARED_EXPORT void	UTILSLIB::filterChpi (Eigen::MatrixXd &data, const FIFFLIB::FiffInfo &info, double sfreq, const FilterChpiParams &params=FilterChpiParams())
	Overload that attempts to extract cHPI frequencies from FiffInfo.

Detailed Description

Declaration of filterChpi — cHPI signal removal by notch filtering.

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

Removes continuous head-position indicator (cHPI) excitation signals from MEG data by applying zero-phase Butterworth band-stop (notch) filters at each cHPI frequency. This mirrors MNE-Python's mne.chpi.filter_chpi().

Definition in file filter_chpi.h.