MNE-CPP  beta 1.0
Public Types | Public Member Functions | List of all members
INVERSELIB::MinimumNorm Class Reference

Minimum norm estimation. More...

#include <minimumnorm.h>

Inheritance diagram for INVERSELIB::MinimumNorm:
INVERSELIB::IInverseAlgorithm

Public Types

typedef QSharedPointer< MinimumNormSPtr
 
typedef QSharedPointer< const MinimumNormConstSPtr
 

Public Member Functions

 MinimumNorm (const MNEInverseOperator &p_inverseOperator, float lambda, const QString method)
 
 MinimumNorm (const MNEInverseOperator &p_inverseOperator, float lambda, bool dSPM, bool sLORETA)
 
virtual MNESourceEstimate calculateInverse (const FiffEvoked &p_fiffEvoked, bool pick_normal=false)
 
virtual MNESourceEstimate calculateInverse (const MatrixXd &data, float tmin, float tstep) const
 
virtual void doInverseSetup (qint32 nave, bool pick_normal=false)
 
virtual const char * getName () const
 
virtual const MNESourceSpacegetSourceSpace () const
 
MNEInverseOperatorgetPreparedInverseOperator ()
 
void setMethod (QString method)
 
void setMethod (bool dSPM, bool sLORETA)
 
void setRegularization (float lambda)
 
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 82 of file minimumnorm.h.

Member Typedef Documentation

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

Const shared pointer type for MinimumNorm.

Definition at line 86 of file minimumnorm.h.

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

Shared pointer type for MinimumNorm.

Definition at line 85 of file minimumnorm.h.

Constructor & Destructor Documentation

MinimumNorm::MinimumNorm ( const MNEInverseOperator p_inverseOperator,
float  lambda,
const QString  method 
)
explicit

Constructs minimum norm inverse algorithm

Parameters
[in]p_inverseOperatorThe inverse operator
[in]lambdaThe regularization factor
[in]methodUse mininum norm, dSPM or sLORETA. ("MNE" | "dSPM" | "sLORETA")
Returns
the prepared inverse operator

Definition at line 70 of file minimumnorm.cpp.

MinimumNorm::MinimumNorm ( const MNEInverseOperator p_inverseOperator,
float  lambda,
bool  dSPM,
bool  sLORETA 
)
explicit

Constructs minimum norm inverse algorithm

Parameters
[in]p_inverseOperatorThe inverse operator
[in]lambdaThe regularization factor
[in]dSPMCompute the noise-normalization factors for dSPM?
[in]sLORETACompute the noise-normalization factors for sLORETA?
Returns
the prepared inverse operator

Definition at line 80 of file minimumnorm.cpp.

Member Function Documentation

MNESourceEstimate MinimumNorm::calculateInverse ( const 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_fiffEvokedEvoked data.
[in]pick_normalIf 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 91 of file minimumnorm.cpp.

MNESourceEstimate MinimumNorm::calculateInverse ( const MatrixXd &  data,
float  tmin,
float  tstep 
) const
virtual

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

Parameters
[in]p_fiffEvokedEvoked data.
[in]tminMinimal time point
[in]tminTime between two samples
Returns
the calculated source estimation

Implements INVERSELIB::IInverseAlgorithm.

Definition at line 188 of file minimumnorm.cpp.

const char * MinimumNorm::getName ( ) const
virtual

Returns the algorithm name

Returns
the algorithm name

Implements INVERSELIB::IInverseAlgorithm.

Definition at line 257 of file minimumnorm.cpp.

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

Get the prepared inverse operator.

Returns
the prepared inverse operator

Definition at line 201 of file minimumnorm.h.

const MNESourceSpace & MinimumNorm::getSourceSpace ( ) const
virtual

Returns the current mne source space on which the inverse algorithm is performing on. Either from inverse operator (minimum norm estimate), or from forward solution (beamformers)

Returns
the mne source space information

Implements INVERSELIB::IInverseAlgorithm.

Definition at line 265 of file minimumnorm.cpp.

void MinimumNorm::setMethod ( QString  method)

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

Parameters
[in]methodUse mininum norm, dSPM or sLORETA.

Definition at line 272 of file minimumnorm.cpp.

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

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

Parameters
[in]dSPMCompute the noise-normalization factors for dSPM?
[in]sLORETACompute the noise-normalization factors for sLORETA?

Definition at line 293 of file minimumnorm.cpp.

void MinimumNorm::setRegularization ( float  lambda)

Set regularization factor

Parameters
[in]lambdaThe regularization factor

Definition at line 318 of file minimumnorm.cpp.


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