inv_beamformer_settings.h File Reference

Strongly-typed enumerations shared by the LCMV and DICS beamformer pipelines. More...

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

Go to the source code of this file.

Namespaces
namespace	INVLIB
	Inverse source estimation (MNE, dSPM, sLORETA, dipole fitting).

Enumerations
enum class	INVLIB::BeamformerWeightNorm { INVLIB::None = 0 , INVLIB::UnitNoiseGain , INVLIB::NAI , INVLIB::UnitNoiseGainInv }
enum class	INVLIB::BeamformerPickOri { INVLIB::None = 0 , INVLIB::Normal , INVLIB::MaxPower , INVLIB::Vector }
enum class	INVLIB::BeamformerInversion { INVLIB::Matrix = 0 , INVLIB::Single }

Detailed Description

Strongly-typed enumerations shared by the LCMV and DICS beamformer pipelines.

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

Defines INVLIB::BeamformerWeightNorm (none / unit-noise-gain / NAI / rotation-invariant unit-noise-gain), BeamformerPickOri (keep-all / surface-normal / max-power / 3-vector) and BeamformerInversion (full-matrix vs. scalar denominator inversion). These knobs are the user-facing API surface that InvLCMV / InvDICS expose to control how the spatial-filter weights are derived from the leadfield and data covariance / CSD. The normalisation choices follow Sekihara & Nagarajan, Adaptive Spatial Filters for Electromagnetic Brain Imaging, Springer (2008).

Definition in file inv_beamformer_settings.h.