inv_dipole.h File Reference

Templated dipole and dipole-pair value types used by the RAP-MUSIC scanning algorithm. More...

#include <Eigen/Core>
#include <iostream>
#include "inv_dipole.cpp"

Include dependency graph for inv_dipole.h:

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

Go to the source code of this file.

Classes
struct	INVLIB::InvDipolePair< T >
	Pair of correlated dipole indices and orientations found by the RAP MUSIC scanning step. More...
class	INVLIB::InvDipole< T >
	Stores position, orientation, and correlation of a single current dipole estimated by RAP MUSIC. More...

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

Typedefs
typedef INVLIB::InvDipole< int >	InvDipole_INT
typedef INVLIB::InvDipole< float >	InvDipole_FLOAT
typedef INVLIB::InvDipole< double >	InvDipole_DOUBLE

Detailed Description

Templated dipole and dipole-pair value types used by the RAP-MUSIC scanning algorithm.

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

Date

March 2026

INVLIB::InvDipole<T> is a templated representation of a single current dipole (position + orientation, optionally length and frequency) and INVLIB::InvDipolePair<T> a pair of correlated dipoles returned by one iteration of the RAP-MUSIC search. The templates are kept separate from the rest of INVLIB so that scanning code can run in float, double or even integer-index mode without forcing a global precision choice. The header includes its own .cpp at the bottom because the templates have to be visible at the first point of instantiation.

Definition in file inv_dipole.h.

Typedef Documentation

InvDipole_DOUBLE

typedef INVLIB::InvDipole<double> InvDipole_DOUBLE

Definition at line 141 of file inv_dipole.h.

InvDipole_FLOAT

typedef INVLIB::InvDipole<float> InvDipole_FLOAT

Definition at line 140 of file inv_dipole.h.

InvDipole_INT

typedef INVLIB::InvDipole<int> InvDipole_INT

Definition at line 139 of file inv_dipole.h.