INVLIB::InvBeamformer Class Reference

Computed beamformer spatial filter container. More...

#include <inv_beamformer.h>

Public Types
typedef QSharedPointer< InvBeamformer >	SPtr
typedef QSharedPointer< const InvBeamformer >	ConstSPtr

Public Member Functions
	InvBeamformer ()
bool	isValid () const
int	nSources () const
int	nChannels () const
int	nOrient () const
int	nFreqs () const

Public Attributes
QString	kind
std::vector< Eigen::MatrixXd >	weights
Eigen::MatrixXd	whitener
Eigen::MatrixXd	proj
Eigen::VectorXi	vertices
Eigen::MatrixX3f	sourceNn
bool	isFreOri
int	nSourcesTotal
QString	srcType
QString	subject
QStringList	chNames
BeamformerWeightNorm	weightNorm
BeamformerPickOri	pickOri
BeamformerInversion	inversion
double	reg
int	rank
Eigen::MatrixX3d	maxPowerOri
Eigen::VectorXd	frequencies

Detailed Description

Computed beamformer spatial filter container.

Stores pre-computed beamformer spatial filter weights and associated metadata.

For LCMV: weights is a single matrix (n_sources * n_orient, n_channels). For DICS: weights is a vector of matrices, one per frequency bin.

This class is the C++ equivalent of MNE-Python's Beamformer dict.

Definition at line 84 of file inv_beamformer.h.

Member Typedef Documentation

ConstSPtr

typedef QSharedPointer<const InvBeamformer> INVLIB::InvBeamformer::ConstSPtr

Definition at line 88 of file inv_beamformer.h.

SPtr

typedef QSharedPointer<InvBeamformer> INVLIB::InvBeamformer::SPtr

Definition at line 87 of file inv_beamformer.h.

Constructor & Destructor Documentation

InvBeamformer()

InvBeamformer::InvBeamformer

(

)

Default constructor — produces an empty (invalid) beamformer.

Definition at line 51 of file inv_beamformer.cpp.

Member Function Documentation

isValid()

bool INVLIB::InvBeamformer::isValid ( ) const

inline

Returns true if this beamformer contains valid filter weights.

Definition at line 164 of file inv_beamformer.h.

nChannels()

int INVLIB::InvBeamformer::nChannels ( ) const

inline

Returns the number of channels.

Definition at line 178 of file inv_beamformer.h.

nFreqs()

int INVLIB::InvBeamformer::nFreqs ( ) const

inline

Returns the number of frequency bins (1 for LCMV, >= 1 for DICS).

Definition at line 192 of file inv_beamformer.h.

nOrient()

int INVLIB::InvBeamformer::nOrient ( ) const

inline

Returns the number of orientations per source (1 or 3).

Definition at line 185 of file inv_beamformer.h.

nSources()

int INVLIB::InvBeamformer::nSources ( ) const

inline

Returns the number of source points.

Definition at line 171 of file inv_beamformer.h.

Member Data Documentation

chNames

QStringList INVLIB::InvBeamformer::chNames

Channel names used for filter computation.

Definition at line 146 of file inv_beamformer.h.

frequencies

Eigen::VectorXd INVLIB::InvBeamformer::frequencies

Center frequencies for DICS (Hz). Empty for LCMV.

Definition at line 157 of file inv_beamformer.h.

inversion

BeamformerInversion INVLIB::InvBeamformer::inversion

Inversion method used.

Definition at line 149 of file inv_beamformer.h.

isFreOri

bool INVLIB::InvBeamformer::isFreOri

True if free orientation (n_orient = 3).

Definition at line 140 of file inv_beamformer.h.

kind

QString INVLIB::InvBeamformer::kind

"LCMV" or "DICS".

Definition at line 127 of file inv_beamformer.h.

maxPowerOri

Eigen::MatrixX3d INVLIB::InvBeamformer::maxPowerOri

Optimal orientation per source (n_sources, 3). Empty if not max-power.

Definition at line 154 of file inv_beamformer.h.

nSourcesTotal

int INVLIB::InvBeamformer::nSourcesTotal

Total number of source points.

Definition at line 141 of file inv_beamformer.h.

pickOri

BeamformerPickOri INVLIB::InvBeamformer::pickOri

Orientation picking mode.

Definition at line 148 of file inv_beamformer.h.

proj

Eigen::MatrixXd INVLIB::InvBeamformer::proj

SSP projection matrix (n_channels, n_channels).

Definition at line 135 of file inv_beamformer.h.

rank

int INVLIB::InvBeamformer::rank

Data covariance rank used.

Definition at line 151 of file inv_beamformer.h.

reg

double INVLIB::InvBeamformer::reg

Regularization parameter used.

Definition at line 150 of file inv_beamformer.h.

sourceNn

Eigen::MatrixX3f INVLIB::InvBeamformer::sourceNn

Source normals (n_sources, 3).

Definition at line 139 of file inv_beamformer.h.

srcType

QString INVLIB::InvBeamformer::srcType

"surface", "volume", "mixed", "discrete".

Definition at line 142 of file inv_beamformer.h.

subject

QString INVLIB::InvBeamformer::subject

Subject identifier.

Definition at line 143 of file inv_beamformer.h.

vertices

Eigen::VectorXi INVLIB::InvBeamformer::vertices

Source vertex indices.

Definition at line 138 of file inv_beamformer.h.

weightNorm

BeamformerWeightNorm INVLIB::InvBeamformer::weightNorm

Applied weight normalization.

Definition at line 147 of file inv_beamformer.h.

weights

std::vector<Eigen::MatrixXd> INVLIB::InvBeamformer::weights

Filter weights, size 1 for LCMV, n_freqs for DICS. Each matrix: (n_sources * n_orient, n_channels).

Definition at line 130 of file inv_beamformer.h.

whitener

Eigen::MatrixXd INVLIB::InvBeamformer::whitener

Whitening matrix (n_channels, n_channels).

Definition at line 134 of file inv_beamformer.h.

---

The documentation for this class was generated from the following files:

• src/libraries/inv/beamformer/inv_beamformer.h
• src/libraries/inv/beamformer/inv_beamformer.cpp