mne_inverse_operator.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef MNEINVERSEOPERATOR_H
#define MNEINVERSEOPERATOR_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "../inverse_global.h"
#include <fiff/fiff_types.h>
#include <mne/mne_surface_or_volume.h>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QSharedPointer>
 
#include <memory>
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
 
namespace FIFFLIB { class FiffCoordTrans; }
 
namespace MNELIB
{
    class MNECovMatrix;
    class MNENamedMatrix;
    class MNEProjOp;
}
 
//=============================================================================================================
// DEFINE NAMESPACE INVERSELIB
//=============================================================================================================
 
namespace INVERSELIB
{
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
 
//=============================================================================================================
class INVERSESHARED_EXPORT MNEInverseOperator
{
public:
    typedef QSharedPointer<MNEInverseOperator> SPtr;              
    typedef QSharedPointer<const MNEInverseOperator> ConstSPtr;   
 
    //=========================================================================================================
    MNEInverseOperator();
 
    //=========================================================================================================
    ~MNEInverseOperator();
 
public:
    FIFFLIB::fiffId meas_id;            /* The assosiated measurement ID */
    std::vector<std::unique_ptr<MNELIB::MNESourceSpace>> spaces; /* The source spaces */
    std::unique_ptr<FIFFLIB::FiffCoordTrans> meg_head_t;  /* MEG device <-> head coordinate transformation */
    std::unique_ptr<FIFFLIB::FiffCoordTrans> mri_head_t;  /* MRI device <-> head coordinate transformation */
    int            methods;         /* EEG, MEG or EEG+MEG (see mne_fiff.h) */
    int            nchan;           /* Number of measurement channels */
    int            nsource;         /* Number of source points */
    int            fixed_ori;       /* Fixed source orientations? */
    float          **rr_source;     /* The active source points */
    float          **nn_source;     /* The source orientations (These are equal to the cortex normals in the fixed orientation case) */
    int            coord_frame;             /* Which coordinates are the locations and orientations given in? */
    MNELIB::MNECovMatrix*  sensor_cov; /* Sensor covariance matrix */
    int            nave;                    /* Number of averaged responses (affects scaling of the noise covariance) */
    int            current_unit;            /* This can be FIFF_UNIT_AM, FIFF_UNIT_AM_M2, FIFF_UNIT_AM_M3 */
    MNELIB::MNECovMatrix*   source_cov;     /* Source covariance matrix */
    MNELIB::MNECovMatrix*   orient_prior;   /* Orientation prior applied */
    MNELIB::MNECovMatrix*   depth_prior;    /* Depth-weighting prior applied */
    MNELIB::MNECovMatrix*   fMRI_prior;     /* fMRI prior applied */
    float          *sing;                       /* Singular values of the inverse operator */
    MNELIB::MNENamedMatrix* eigen_leads;    /* The eigen leadfields */
    int            eigen_leads_weighted;        /* Have the above been already weighted with R^0.5? */
    MNELIB::MNENamedMatrix* eigen_fields;   /* Associated field patterns */
    float          trace_ratio;                 /* tr(GRG^T)/tr(C) */
    MNELIB::MNEProjOp*    proj;             /* The associated projection operator */
 
// ### OLD STRUCT ###
//typedef struct {                    /* An inverse operator */
//    FIFFLIB::fiffId         meas_id;                            /* The assosiated measurement ID */
//    INVERSELIB::MNESourceSpace* *spaces;   /* The source spaces */
//    int            nspace;                      /* Number of source spaces */
//    INVERSELIB::FiffCoordTransOld* meg_head_t;  /* MEG device <-> head coordinate transformation */
//    INVERSELIB::FiffCoordTransOld* mri_head_t;  /* MRI device <-> head coordinate transformation */
//    int            methods;         /* EEG, MEG or EEG+MEG (see mne_fiff.h) */
//    int            nchan;           /* Number of measurement channels */
//    int            nsource;         /* Number of source points */
//    int            fixed_ori;       /* Fixed source orientations? */
//    float          **rr_source;     /* The active source points */
//    float          **nn_source;     /* The source orientations (These are equal to the cortex normals in the fixed orientation case) */
//    int            coord_frame;             /* Which coordinates are the locations and orientations given in? */
//    INVERSELIB::MNECovMatrix*   sensor_cov; /* Sensor covariance matrix */
//    int            nave;                    /* Number of averaged responses (affects scaling of the noise covariance) */
//    int            current_unit;            /* This can be FIFF_UNIT_AM, FIFF_UNIT_AM_M2, FIFF_UNIT_AM_M3 */
//    INVERSELIB::MNECovMatrix*   source_cov;     /* Source covariance matrix */
//    INVERSELIB::MNECovMatrix*   orient_prior;   /* Orientation prior applied */
//    INVERSELIB::MNECovMatrix*   depth_prior;    /* Depth-weighting prior applied */
//    INVERSELIB::MNECovMatrix*   fMRI_prior;     /* fMRI prior applied */
//    float          *sing;                       /* Singular values of the inverse operator */
//    INVERSELIB::MNENamedMatrix* eigen_leads;    /* The eigen leadfields */
//    int            eigen_leads_weighted;        /* Have the above been already weighted with R^0.5? */
//    INVERSELIB::MNENamedMatrix* eigen_fields;   /* Associated field patterns */
//    float          trace_ratio;                 /* tr(GRG^T)/tr(C) */
//    INVERSELIB::MNEProjOp*    proj;             /* The associated projection operator */
//} *mneInverseOperator,mneInverseOperatorRec;
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
} // NAMESPACE INVERSELIB
 
#endif // MNEINVERSEOPERATOR_H