inv_dipole_fit_data.h File Reference

Dipole-fit workspace bundling sensor geometry, forward-model function pointers, noise covariance and SSP projection. More...

#include "../inv_global.h"
#include <fiff/fiff_types.h>
#include <fwd/fwd_types.h>
#include <fwd/fwd_eeg_sphere_model.h>
#include <fwd/fwd_bem_model.h>
#include "inv_dipole_forward.h"
#include <Eigen/Core>
#include <QSharedPointer>
#include <memory>

Include dependency graph for inv_dipole_fit_data.h:

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

Go to the source code of this file.

Classes
struct	INVLIB::dipoleFitFuncsRec
	Forward field computation function pointers and client data for MEG and EEG dipole fitting. More...
struct	INVLIB::FitDipUserRec
	Workspace for the dipole fitting objective function, holding forward model, measured field, and fit limits. More...
class	INVLIB::InvDipoleFitData
	Dipole fit workspace holding sensor geometry, forward model, noise covariance, and projection data. More...

Namespaces
namespace	FIFFLIB
	FIFF file I/O, in-memory data structures and high-level readers/writers.
namespace	MNELIB
	Core MNE data structures (source spaces, source estimates, hemispheres).
namespace	INVLIB
	Inverse source estimation (MNE, dSPM, sLORETA, dipole fitting).

Typedefs
using	INVLIB::dipoleFitFuncs = dipoleFitFuncsRec*
	Pointer alias for dipoleFitFuncsRec, used throughout the dipole fitting module.

Variables
constexpr int	COLUMN_NORM_NONE = 0
constexpr int	COLUMN_NORM_COMP = 1
constexpr int	COLUMN_NORM_LOC = 2

Detailed Description

Dipole-fit workspace bundling sensor geometry, forward-model function pointers, noise covariance and SSP projection.

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::InvDipoleFitData replaces the dipoleFitDataRec record of MNE-C and aggregates everything that the dipole-fit objective function needs to evaluate a candidate dipole: coordinate transforms, channel selection, MEG coil and EEG electrode definitions, the forward-model function pointers (sphere model and/or BEM), the regularised noise covariance and the SSP projector. The static setup_dipole_fit_data factory reads every input from disk and returns a fully-initialised workspace ready to be passed into the fitting loop. Also declares the dipoleFitFuncsRec / FitDipUserRec helpers used by the per-iteration cost function.

Definition in file inv_dipole_fit_data.h.

Variable Documentation

COLUMN_NORM_COMP

int COLUMN_NORM_COMP = 1

constexpr

Componentwise normalization.

Definition at line 57 of file inv_dipole_fit_data.h.

COLUMN_NORM_LOC

int COLUMN_NORM_LOC = 2

constexpr

Dipole locationwise normalization.

Definition at line 58 of file inv_dipole_fit_data.h.

COLUMN_NORM_NONE

int COLUMN_NORM_NONE = 0

constexpr

No column normalization requested.

Definition at line 56 of file inv_dipole_fit_data.h.