fwd_eeg_sphere_model.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef FWD_EEG_SPHERE_MODEL_H
#define FWD_EEG_SPHERE_MODEL_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fwd_global.h"
#include "fwd_eeg_sphere_layer.h"
#include "fwd_coil_set.h"
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QDebug>
 
#include <memory>
#include <vector>
 
//=============================================================================================================
// DEFINE NAMESPACE FWDLIB
//=============================================================================================================
 
namespace FWDLIB
{
 
/*
 * This is the beginning of the specific code
 */
struct fitUserRec {
    Eigen::VectorXd y;
    Eigen::VectorXd resi;
    Eigen::MatrixXd M;
    Eigen::MatrixXd uu;
    Eigen::MatrixXd vv;
    Eigen::VectorXd sing;
    Eigen::VectorXd fn;
    Eigen::VectorXd w;
    int    nfit;
    int    nterms;
};
using fitUser = fitUserRec*;
 
//=============================================================================================================
class FWDSHARED_EXPORT FwdEegSphereModel
{
public:
    typedef std::unique_ptr<FwdEegSphereModel> UPtr;      
 
    //=========================================================================================================
    explicit FwdEegSphereModel();
 
    //=========================================================================================================
    explicit FwdEegSphereModel(const FwdEegSphereModel& p_FwdEegSphereModel);
 
    //=========================================================================================================
    static FwdEegSphereModel::UPtr fwd_create_eeg_sphere_model(const QString& name,
                                                         int nlayer,
                                                         const Eigen::VectorXf& rads,
                                                         const Eigen::VectorXf& sigmas);
 
    //=========================================================================================================
    virtual ~FwdEegSphereModel();
 
    //=========================================================================================================
    static FwdEegSphereModel::UPtr setup_eeg_sphere_model(const QString& eeg_model_file, QString eeg_model_name, float eeg_sphere_rad);
 
    //=========================================================================================================
    static fitUser new_fit_user(int nfit, int nterms);
 
    //=========================================================================================================
    double fwd_eeg_get_multi_sphere_model_coeff(int n);
 
    //=========================================================================================================
    static void next_legen (int n,
                double x,
                double &p0,
                double &p01,
                double &p1,
                double &p11);
 
    //=========================================================================================================
    static void calc_pot_components(double beta,
                    double cgamma,
                    double &Vrp,
                    double &Vtp,
                    const Eigen::VectorXd& fn,
                    int    nterms);
 
    //=========================================================================================================
    static int fwd_eeg_multi_spherepot(const Eigen::Vector3f& rd,
                       const Eigen::Vector3f& Q,
                       const Eigen::Matrix<float, Eigen::Dynamic, 3, Eigen::RowMajor>& el,
                       int     neeg,
                       Eigen::VectorXf& Vval,
                       void    *client);
 
    //=========================================================================================================
    static int fwd_eeg_multi_spherepot_coil1(const Eigen::Vector3f& rd,
                      const Eigen::Vector3f& Q,
                      FwdCoilSet& els,
                      Eigen::Ref<Eigen::VectorXf> Vval,
                      void       *client);
 
    //=========================================================================================================
    static bool fwd_eeg_spherepot_vec (const Eigen::Vector3f& rd, const Eigen::Matrix<float, Eigen::Dynamic, 3, Eigen::RowMajor>& el, int neeg, Eigen::MatrixXf& Vval_vec, void *client);
 
    //=========================================================================================================
    static int fwd_eeg_spherepot_coil_vec(const Eigen::Vector3f& rd, FwdCoilSet& els, Eigen::Ref<Eigen::MatrixXf> Vval_vec, void *client);
 
    //=========================================================================================================
    static int fwd_eeg_spherepot_grad_coil( const Eigen::Vector3f& rd,
                                            const Eigen::Vector3f& Q,
                                            FwdCoilSet&  coils,
                                            Eigen::Ref<Eigen::VectorXf> Vval,
                                            Eigen::Ref<Eigen::VectorXf> xgrad,
                                            Eigen::Ref<Eigen::VectorXf> ygrad,
                                            Eigen::Ref<Eigen::VectorXf> zgrad,
                                            void         *client);
 
    //=========================================================================================================
    static int fwd_eeg_spherepot( const Eigen::Vector3f& rd, const Eigen::Vector3f& Q, const Eigen::Matrix<float, Eigen::Dynamic, 3, Eigen::RowMajor>& el, int neeg, Eigen::VectorXf& Vval, void *client);
 
    //=========================================================================================================
    static int fwd_eeg_spherepot_coil(const Eigen::Vector3f& rd, const Eigen::Vector3f& Q, FwdCoilSet& els, Eigen::Ref<Eigen::VectorXf> Vval, void *client);
 
    //=========================================================================================================
    bool fwd_setup_eeg_sphere_model(float rad, bool fit_berg_scherg, int nfit);
 
    //=========================================================================================================
    static void compose_linear_fitting_data(const Eigen::VectorXd& mu,fitUser u);
 
    //=========================================================================================================
    static double compute_linear_parameters(const Eigen::VectorXd& mu, Eigen::VectorXd& lambda, fitUser u);
 
    //=========================================================================================================
    static double one_step (const Eigen::VectorXd& mu, const void *user_data);
 
    //=========================================================================================================
    bool fwd_eeg_fit_berg_scherg(int   nterms,
                                int   nfit,
                                float &rv);

    int   nlayer() const
    {
        return layers.size();
    }
 
public:
    QString                     name;   
    std::vector<FwdEegSphereLayer> layers; 
    Eigen::Vector3f             r0;     
 
    Eigen::VectorXd fn;                 
    int             nterms;             
 
    Eigen::VectorXf mu;             
    Eigen::VectorXf lambda;
    int             nfit;           
    int             scale_pos;      
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
} // NAMESPACE FWDLIB
 
#endif // FWD_EEG_SPHERE_MODEL_H