INVLIB::InvDipoleFit Class Reference

High-level driver for sequential dipole fitting. More...

#include <inv_dipole_fit.h>

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

Public Member Functions
	InvDipoleFit (InvDipoleFitSettings *p_settings)
virtual	~InvDipoleFit ()=default
InvEcdSet	calculateFit () const

Static Public Member Functions
static bool	fit_dipoles (const QString &dataname, MNELIB::MNEMeasData *data, InvDipoleFitData *fit, InvGuessData *guess, float tmin, float tmax, float tstep, float integ, int verbose, InvEcdSet &p_set)
static bool	fit_dipoles_raw (const QString &dataname, MNELIB::MNERawData *raw, MNELIB::mneChSelection sel, InvDipoleFitData *fit, InvGuessData *guess, float tmin, float tmax, float tstep, float integ, int verbose, InvEcdSet &p_set)
static bool	fit_dipoles_raw (const QString &dataname, MNELIB::MNERawData *raw, MNELIB::mneChSelection sel, InvDipoleFitData *fit, InvGuessData *guess, float tmin, float tmax, float tstep, float integ, int verbose)

Detailed Description

High-level driver for sequential dipole fitting.

InvDipoleFit orchestrates the complete dipole-fit pipeline: it sets up the forward model via InvDipoleFitData, computes initial guess grids via InvGuessData, reads averaged or raw data, and fits an equivalent current dipole (ECD) at each requested time point.

Refactored from fit_dipoles.c / dipole_fit_setup.c (MNE-C).

Definition at line 80 of file inv_dipole_fit.h.

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for InvDipoleFit.

Definition at line 84 of file inv_dipole_fit.h.

SPtr

typedef QSharedPointer<InvDipoleFit> INVLIB::InvDipoleFit::SPtr

Shared pointer type for InvDipoleFit.

Definition at line 83 of file inv_dipole_fit.h.

Constructor & Destructor Documentation

InvDipoleFit()

InvDipoleFit::InvDipoleFit ( InvDipoleFitSettings * p_settings )

explicit

Constructs Dipole Fit algorithm.

Parameters

[in]

p_settings

The dipole fit settings.

Definition at line 186 of file inv_dipole_fit.cpp.

~InvDipoleFit()

virtual INVLIB::InvDipoleFit::~InvDipoleFit ( )

virtualdefault

Destructs the Dipole Fit.

Member Function Documentation

calculateFit()

InvEcdSet InvDipoleFit::calculateFit

(

)

const

Execute the dipole fit using the stored settings.

Returns

The fitted dipole set.

Definition at line 192 of file inv_dipole_fit.cpp.

fit_dipoles()

bool InvDipoleFit::fit_dipoles ( const QString & dataname, MNELIB::MNEMeasData * data, InvDipoleFitData * fit, InvGuessData * guess, float tmin, float tmax, float tstep, float integ, int verbose, InvEcdSet & p_set )

static

Fit a single dipole to each time point of averaged data.

Refactored: fit_dipoles (fit_dipoles.c)

Parameters

[in]	dataname	Data file name.
[in]	data	The measured data.
[in]	fit	Precomputed fitting data.
[in]	guess	The initial guesses.
[in]	tmin	Fit start time (s).
[in]	tmax	Fit end time (s).
[in]	tstep	Time step to use (s).
[in]	integ	Integration time (s).
[in]	verbose	Verbose output.
[out]	p_set	The fitted dipole set.

Returns

true when successful.

Definition at line 323 of file inv_dipole_fit.cpp.

fit_dipoles_raw() [1/2]

bool InvDipoleFit::fit_dipoles_raw ( const QString & dataname, MNELIB::MNERawData * raw, MNELIB::mneChSelection sel, InvDipoleFitData * fit, InvGuessData * guess, float tmin, float tmax, float tstep, float integ, int verbose )

static

Fit dipoles to raw data (convenience overload without output set).

Refactored: fit_dipoles_raw (fit_dipoles.c)

Parameters

[in]	dataname	Data file name.
[in]	raw	The raw data description.
[in]	sel	Channel selection to use.
[in]	fit	Precomputed fitting data.
[in]	guess	The initial guesses.
[in]	tmin	Fit start time (s).
[in]	tmax	Fit end time (s).
[in]	tstep	Time step to use (s).
[in]	integ	Integration time (s).
[in]	verbose	Verbose output.

Returns

true when successful.

Definition at line 428 of file inv_dipole_fit.cpp.

fit_dipoles_raw() [2/2]

bool InvDipoleFit::fit_dipoles_raw ( const QString & dataname, MNELIB::MNERawData * raw, MNELIB::mneChSelection sel, InvDipoleFitData * fit, InvGuessData * guess, float tmin, float tmax, float tstep, float integ, int verbose, InvEcdSet & p_set )

static

Fit a single dipole to each time point of raw data.

Reads data in overlapping segments of SEG_LEN seconds and extracts values at each requested time point.

Refactored: fit_dipoles_raw (fit_dipoles.c)

Parameters

[in]	dataname	Data file name.
[in]	raw	The raw data description.
[in]	sel	Channel selection to use.
[in]	fit	Precomputed fitting data.
[in]	guess	The initial guesses.
[in]	tmin	Fit start time (s).
[in]	tmax	Fit end time (s).
[in]	tstep	Time step to use (s).
[in]	integ	Integration time (s).
[in]	verbose	Verbose output.
[out]	p_set	The fitted dipole set.

Returns

true when successful.

Definition at line 361 of file inv_dipole_fit.cpp.

---

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

• src/libraries/inv/dipole_fit/inv_dipole_fit.h
• src/libraries/inv/dipole_fit/inv_dipole_fit.cpp