firfilter.h File Reference

Discoverable design / apply façade over the UTILSLIB::FilterKernel FIR engine. More...

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

Include dependency graph for firfilter.h:

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

Go to the source code of this file.

Classes
class	UTILSLIB::FirFilter
	Discoverable façade over the FilterKernel FIR-filter engine. More...

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

Detailed Description

Discoverable design / apply façade over the UTILSLIB::FilterKernel FIR engine.

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.1.0

Date

March 2026

FirFilter mirrors the UTILSLIB::IirFilter API surface (design, apply, applyZeroPhase, applyZeroPhaseMatrix) so callers see one consistent way of building and running FIR or IIR filters in mne-cpp. Internally every call delegates to UTILSLIB::FilterKernel, which executes the actual frequency-domain overlap-add convolution against the precomputed FFT of the impulse response.

All cutoff / bandwidth parameters are specified in Hz; normalisation against the sampling frequency happens inside the design step. Because the underlying kernels are linear-phase Type-I FIRs, the zero-phase helpers simply remove the deterministic (NumTaps-1)/2 group delay after a single forward pass — no forward / backward filtering is required.

Definition in file firfilter.h.