MNE-CPP  beta 1.0
Public Member Functions | List of all members
INVERSELIB::IInverseAlgorithm Class Referenceabstract

Inverse algorithm interface. More...

#include <IInverseAlgorithm.h>

Inheritance diagram for INVERSELIB::IInverseAlgorithm:
INVERSELIB::MinimumNorm INVERSELIB::RapMusic INVERSELIB::PwlRapMusic

Public Member Functions

virtual ~IInverseAlgorithm ()
 
virtual MNESourceEstimate calculateInverse (const FiffEvoked &p_fiffEvoked, bool pick_normal=false)=0
 
virtual MNESourceEstimate calculateInverse (const MatrixXd &data, float tmin, float tstep) const =0
 
virtual const char * getName () const =0
 
virtual const MNESourceSpacegetSourceSpace () const =0
 

Detailed Description

Inverse algorithm interface.

Inverse algorithm interface for inverse routines of MNE-CPP

Definition at line 93 of file IInverseAlgorithm.h.

Constructor & Destructor Documentation

virtual INVERSELIB::IInverseAlgorithm::~IInverseAlgorithm ( )
inlinevirtual

Destroys the IInverseAlgorithm.

Definition at line 100 of file IInverseAlgorithm.h.

Member Function Documentation

virtual MNESourceEstimate INVERSELIB::IInverseAlgorithm::calculateInverse ( const FiffEvoked p_fiffEvoked,
bool  pick_normal = false 
)
pure virtual

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

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

Implemented in INVERSELIB::RapMusic, INVERSELIB::PwlRapMusic, and INVERSELIB::MinimumNorm.

virtual MNESourceEstimate INVERSELIB::IInverseAlgorithm::calculateInverse ( const MatrixXd &  data,
float  tmin,
float  tstep 
) const
pure 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

Implemented in INVERSELIB::RapMusic, INVERSELIB::PwlRapMusic, and INVERSELIB::MinimumNorm.

virtual const char* INVERSELIB::IInverseAlgorithm::getName ( ) const
pure virtual

Returns the algorithm name

Returns
the algorithm name

Implemented in INVERSELIB::RapMusic, INVERSELIB::PwlRapMusic, and INVERSELIB::MinimumNorm.

virtual const MNESourceSpace& INVERSELIB::IInverseAlgorithm::getSourceSpace ( ) const
pure 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

Implemented in INVERSELIB::RapMusic, and INVERSELIB::MinimumNorm.


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