INVERSELIB::MinimumNorm Class Reference

Minimum norm estimation. More...

#include <minimumnorm.h>

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

Public Member Functions
	MinimumNorm (const MNELIB::MNEInverseOperator &p_inverseOperator, float lambda, const QString method)
	MinimumNorm (const MNELIB::MNEInverseOperator &p_inverseOperator, float lambda, bool dSPM, bool sLORETA)
virtual	~MinimumNorm ()
virtual MNELIB::MNESourceEstimate	calculateInverse (const FIFFLIB::FiffEvoked &p_fiffEvoked, bool pick_normal=false)
virtual MNELIB::MNESourceEstimate	calculateInverse (const Eigen::MatrixXd &data, float tmin, float tstep, bool pick_normal=false) const
virtual void	doInverseSetup (qint32 nave, bool pick_normal=false)
virtual const char *	getName () const
virtual const MNELIB::MNESourceSpaces &	getSourceSpace () const
MNELIB::MNEInverseOperator &	getPreparedInverseOperator ()
void	setMethod (QString method)
void	setMethod (bool dSPM, bool sLORETA)
void	setRegularization (float lambda)
Eigen::MatrixXd &	getKernel ()
Public Member Functions inherited from INVERSELIB::IInverseAlgorithm
virtual	~IInverseAlgorithm ()

Detailed Description

Minimum norm estimation.

Minimum norm estimation algorithm ToDo: Paper references.

Definition at line 69 of file minimumnorm.h.

Inheritance diagram for INVERSELIB::MinimumNorm:

Member Typedef Documentation

ConstSPtr

typedef QSharedPointer<const MinimumNorm> INVERSELIB::MinimumNorm::ConstSPtr

Const shared pointer type for MinimumNorm.

Definition at line 73 of file minimumnorm.h.

SPtr

typedef QSharedPointer<MinimumNorm> INVERSELIB::MinimumNorm::SPtr

Shared pointer type for MinimumNorm.

Definition at line 72 of file minimumnorm.h.

Constructor & Destructor Documentation

MinimumNorm() [1/2]

INVERSELIB::MinimumNorm::MinimumNorm ( const MNELIB::MNEInverseOperator & p_inverseOperator, float lambda, const QString method )

explicit

Constructs minimum norm inverse algorithm

Parameters

[in]	p_inverseOperator	The inverse operator.
[in]	lambda	The regularization factor.
[in]	method	Use mininum norm, dSPM or sLORETA. ("MNE" | "dSPM" | "sLORETA").

Returns

the prepared inverse operator.

MinimumNorm() [2/2]

INVERSELIB::MinimumNorm::MinimumNorm ( const MNELIB::MNEInverseOperator & p_inverseOperator, float lambda, bool dSPM, bool sLORETA )

explicit

Constructs minimum norm inverse algorithm

Parameters

[in]	p_inverseOperator	The inverse operator.
[in]	lambda	The regularization factor.
[in]	dSPM	Compute the noise-normalization factors for dSPM?.
[in]	sLORETA	Compute the noise-normalization factors for sLORETA?.

Returns

the prepared inverse operator.

~MinimumNorm()

virtual INVERSELIB::MinimumNorm::~MinimumNorm ( )

inlinevirtual

Definition at line 100 of file minimumnorm.h.

Member Function Documentation

calculateInverse() [1/2]

virtual MNELIB::MNESourceEstimate INVERSELIB::MinimumNorm::calculateInverse ( const Eigen::MatrixXd & data, float tmin, float tstep, bool pick_normal = false ) const

virtual

Applies the inverse algorithm to input data and returns a source estimate.

Parameters

[in]	p_fiffEvoked	Evoked data.
[in]	tmin	Minimal time point.
[in]	tmin	Time between two samples.
[in]	pick_normal	If True, rather than pooling the orientations by taking the norm, only the. radial component is kept. This is only applied when working with loose orientations.

Returns

the calculated source estimation.

Implements INVERSELIB::IInverseAlgorithm.

calculateInverse() [2/2]

MNESourceEstimate MinimumNorm::calculateInverse ( const FIFFLIB::FiffEvoked & p_fiffEvoked, bool pick_normal = false )

virtual

Computes a L2-norm inverse solution Actual code using these principles might be different because the inverse operator is often reused across data sets.

Parameters

[in]	p_fiffEvoked	Evoked data.
[in]	pick_normal	If True, rather than pooling the orientations by taking the norm, only the. radial component is kept. This is only applied when working with loose orientations.

Returns

the calculated source estimation.

Implements INVERSELIB::IInverseAlgorithm.

Definition at line 88 of file minimumnorm.cpp.

doInverseSetup()

void MinimumNorm::doInverseSetup ( qint32 nave, bool pick_normal = false )

virtual

Perform the inverse setup: Prepares this inverse operator and assembles the kernel.

Parameters

[in]	nave	Number of averages to use.
[in]	pick_normal	If True, rather than pooling the orientations by taking the norm, only the. radial component is kept. This is only applied when working with loose orientations.

Definition at line 238 of file minimumnorm.cpp.

getKernel()

Eigen::MatrixXd & INVERSELIB::MinimumNorm::getKernel ( )

inline

Get the assembled kernel

Returns

the assembled kernel.

Definition at line 203 of file minimumnorm.h.

getName()

const char * MinimumNorm::getName ( ) const

virtual

Get the name of the inverse operator.

Returns

the name of the inverse operator.

Implements INVERSELIB::IInverseAlgorithm.

Definition at line 255 of file minimumnorm.cpp.

getPreparedInverseOperator()

MNELIB::MNEInverseOperator & INVERSELIB::MinimumNorm::getPreparedInverseOperator ( )

inline

Get the prepared inverse operator.

Returns

the prepared inverse operator.

Definition at line 210 of file minimumnorm.h.

getSourceSpace()

const MNESourceSpaces & MinimumNorm::getSourceSpace ( ) const

virtual

Get the source space corresponding to this inverse operator.

Returns

the source space corresponding to this inverse operator.

Implements INVERSELIB::IInverseAlgorithm.

Definition at line 262 of file minimumnorm.cpp.

setMethod() [1/2]

void MinimumNorm::setMethod	(	bool	dSPM,
		bool	sLORETA )

Set minimum norm algorithm method ("MNE" | "dSPM" | "sLORETA")

Parameters

[in]	dSPM	Compute the noise-normalization factors for dSPM?.
[in]	sLORETA	Compute the noise-normalization factors for sLORETA?.

Definition at line 289 of file minimumnorm.cpp.

setMethod() [2/2]

void MinimumNorm::setMethod

(

QString

method

)

Set minimum norm algorithm method ("MNE" | "dSPM" | "sLORETA")

Parameters

[in]

method

Use mininum norm, dSPM or sLORETA.

Definition at line 269 of file minimumnorm.cpp.

setRegularization()

void MinimumNorm::setRegularization

(

float

lambda

)

Set regularization factor

Parameters

[in]

lambda

The regularization factor.

Definition at line 313 of file minimumnorm.cpp.

---

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

• src/libraries/inverse/minimumNorm/minimumnorm.h
• src/libraries/inverse/minimumNorm/minimumnorm.cpp