Precomputed guess point grid with forward fields for initial dipole position candidates. More...

#include <inv_guess_data.h>

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

Public Member Functions
	InvGuessData ()
	InvGuessData (const InvGuessData &)=delete
InvGuessData &	operator= (const InvGuessData &)=delete
	InvGuessData (const QString &guessname, const QString &guess_surfname, float mindist, float exclude, float grid, InvDipoleFitData *f, float guessrad=0.080f)
	~InvGuessData ()
bool	compute_guess_fields (InvDipoleFitData *f)

Public Attributes
Eigen::Matrix< float, Eigen::Dynamic, 3, Eigen::RowMajor >	rr
std::vector< InvDipoleForward::UPtr >	guess_fwd
int	nguess = 0

Detailed Description

Precomputed guess point grid with forward fields for initial dipole position candidates.

Implements InvGuessData (Replaces *guessData,guessDataRec struct of MNE-C fit_types.h).

Definition at line 67 of file inv_guess_data.h.

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for InvGuessData.

Definition at line 71 of file inv_guess_data.h.

◆ SPtr

typedef QSharedPointer<InvGuessData> INVLIB::InvGuessData::SPtr

Shared pointer type for InvGuessData.

Definition at line 70 of file inv_guess_data.h.

Constructor & Destructor Documentation

◆ InvGuessData() [1/3]

InvGuessData::InvGuessData ( )

Constructs the Guess Data Refactored: new_guess_data (dipole_fit_setup.c)

Definition at line 53 of file inv_guess_data.cpp.

◆ InvGuessData() [2/3]

INVLIB::InvGuessData::InvGuessData ( const InvGuessData & )

delete

Deleted — non-copyable due to unique_ptr members.

◆ InvGuessData() [3/3]

InvGuessData::InvGuessData	(	const QString &	guessname,
		const QString &	guess_surfname,
		float	mindist,
		float	exclude,
		float	grid,
		InvDipoleFitData *	f,
		float	guessrad = 0.080f )

Constructs the Guess Data from given Data Refactored: make_guess_data (dipole_fit_setup.c)

Parameters

[in]	guessname	File with a predefined guess point set (empty = build a grid).
[in]	guess_surfname	Surface file bounding the guess grid (empty = inner skull of the BEM, or a sphere).
[in]	mindist	Minimum distance of guess points from the bounding surface (m).
[in]	exclude	Exclude guess points closer than this to the sphere origin (m).
[in]	grid	Spacing of the guess grid (m).
[in,out]	f	Dipole fit data providing the forward model.
[in]	guessrad	Radius of the spherical guess volume when no surface bounds it (m).

Definition at line 60 of file inv_guess_data.cpp.

◆ ~InvGuessData()

InvGuessData::~InvGuessData ( )

default

Destroys the Guess Data description Refactored: free_guess_data (dipole_fit_setup.c)

Member Function Documentation

◆ compute_guess_fields()

bool InvGuessData::compute_guess_fields ( InvDipoleFitData * f )

Once the guess locations have been set up we can compute the fields Refactored: compute_guess_fields (dipole_fit_setup.c)

Parameters

[in] f Dipole Fit Data to the Compute Guess Fields.

Returns: true when successful.

Definition at line 141 of file inv_guess_data.cpp.

◆ operator=()

InvGuessData & INVLIB::InvGuessData::operator= ( const InvGuessData & )

delete

Member Data Documentation

◆ guess_fwd

std::vector<InvDipoleForward::UPtr> INVLIB::InvGuessData::guess_fwd

Forward solutions for the guesses.

Definition at line 120 of file inv_guess_data.h.

◆ nguess

int INVLIB::InvGuessData::nguess = 0

How many sources.

Definition at line 121 of file inv_guess_data.h.

◆ rr

Eigen::Matrix<float, Eigen::Dynamic, 3, Eigen::RowMajor> INVLIB::InvGuessData::rr

Guess dipole locations (nguess x 3, row-major).

Definition at line 119 of file inv_guess_data.h.

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

src/libraries/inv/dipole_fit/inv_guess_data.h
src/libraries/inv/dipole_fit/inv_guess_data.cpp

Public Types

Public Member Functions

Public Attributes