fwd_comp_data.h

Go to the documentation of this file.

//=============================================================================================================
#ifndef FWDCOMPDATA_H
#define FWDCOMPDATA_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fwd_global.h"
#include "fwd_types.h"
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QSharedPointer>
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
 
namespace MNELIB
{
    class MneCTFCompDataSet;
}
 
//=============================================================================================================
// DEFINE NAMESPACE FWDLIB
//=============================================================================================================
 
namespace FWDLIB
{
 
//=============================================================================================================
// FWDLIB FORWARD DECLARATIONS
//=============================================================================================================
 
class FwdCoilSet;
 
//=============================================================================================================
class FWDSHARED_EXPORT FwdCompData
{
public:
    typedef QSharedPointer<FwdCompData> SPtr;              
    typedef QSharedPointer<const FwdCompData> ConstSPtr;   
    //=========================================================================================================
    FwdCompData();
 
    //=========================================================================================================
    ~FwdCompData();
 
    //============================= fwd_comp.c =============================
 
    static int fwd_comp_field(float *rd,float *Q, FwdCoilSet* coils, float *res, void *client);
 
    /*
     * Routines to implement the reference channel compensation in field computations
     */
 
    static void fwd_free_comp_data(void *d);
 
    static int fwd_make_ctf_comp_coils(MNELIB::MneCTFCompDataSet* set,          /* The available compensation data */
                                       FwdCoilSet*        coils,        /* The main coil set */
                                       FwdCoilSet*        comp_coils);
 
    static FwdCompData* fwd_make_comp_data(MNELIB::MneCTFCompDataSet* set,           /* The CTF compensation data read from the file */
                                   FwdCoilSet*        coils,         /* The principal set of coils */
                                   FwdCoilSet*        comp_coils,    /* The compensation coils */
                                   fwdFieldFunc      field,         /* The field computation functions */
                                   fwdVecFieldFunc   vec_field,
                                   fwdFieldGradFunc  field_grad,    /* The field and gradient computation function */
                                   void              *client,       /* Client data to be passed to the above */
                                   fwdUserFreeFunc   client_free);
 
    static int fwd_comp_field_vec(float *rd, FwdCoilSet* coils, float **res, void *client);
 
    static int fwd_comp_field_grad(float *rd,float *Q, FwdCoilSet* coils,
                float *res, float *xgrad, float *ygrad, float *zgrad,
                void *client);
 
public:
    MNELIB::MneCTFCompDataSet*  set;        /* The compensation data set */
    FwdCoilSet*         comp_coils; /* The compensation coil definitions */
    fwdFieldFunc        field;      /* Computes the field of given direction dipole */
    fwdVecFieldFunc     vec_field;  /* Computes the fields of all three dipole components  */
    fwdFieldGradFunc    field_grad; /* Computes the field and gradient of one dipole direction */
    void                *client;    /* Client data to pass to the above functions */
    fwdUserFreeFunc     client_free;
    float               *work;      /* The work areas */
    float               **vec_work;
 
// ### OLD STRUCT ###
//typedef struct {
//    FWDLIB::MneCTFCompDataSet* set; /* The compensation data set */
//    FWDLIB::FwdCoilSet* comp_coils; /* The compensation coil definitions */
//    fwdFieldFunc      field;            /* Computes the field of given direction dipole */
//    fwdVecFieldFunc   vec_field;        /* Computes the fields of all three dipole components  */
//    fwdFieldGradFunc  field_grad;       /* Computes the field and gradient of one dipole direction */
//    void              *client;          /* Client data to pass to the above functions */
//    fwdUserFreeFunc   client_free;
//    float             *work;            /* The work areas */
//    float             **vec_work;
//} *fwdCompData,fwdCompDataRec;          /* This structure is used in the compensated field calculations */
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
} // NAMESPACE FWDLIB
 
#endif // FWDCOMPDATA_H