fwd_coil.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef FWD_COIL_H
#define FWD_COIL_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fwd_global.h"
 
#include <fiff/fiff_coord_trans.h>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <memory>
 
//=============================================================================================================
// DEFINE NAMESPACE FWDLIB
//=============================================================================================================
 
namespace FWDLIB
{
 
//=============================================================================================================
// COIL TYPE AND ACCURACY CONSTANTS
//=============================================================================================================
 
constexpr int FWD_COIL_UNKNOWN = 0;
 
constexpr int FWD_COILC_UNKNOWN = 0;
constexpr int FWD_COILC_EEG = 1000;
constexpr int FWD_COILC_MAG = 1;
constexpr int FWD_COILC_AXIAL_GRAD = 2;
constexpr int FWD_COILC_PLANAR_GRAD = 3;
constexpr int FWD_COILC_AXIAL_GRAD2 = 4;
 
constexpr int FWD_COIL_ACCURACY_POINT = 0;
constexpr int FWD_COIL_ACCURACY_NORMAL = 1;
constexpr int FWD_COIL_ACCURACY_ACCURATE = 2;
 
inline constexpr bool FWD_IS_MEG_COIL(int x)
{
    return (x != FWD_COILC_EEG && x != FWD_COILC_UNKNOWN);
}
 
//=============================================================================================================
class FWDSHARED_EXPORT FwdCoil
{
public:
    typedef std::unique_ptr<FwdCoil> UPtr; 
 
    //=========================================================================================================
    FwdCoil(int p_np);
 
    //=========================================================================================================
    FwdCoil(const FwdCoil& p_FwdCoil);
 
    //=========================================================================================================
    ~FwdCoil();
 
    //=========================================================================================================
    static FwdCoil::UPtr create_eeg_el(const FIFFLIB::FiffChInfo& ch,
                                       const FIFFLIB::FiffCoordTrans& t = FIFFLIB::FiffCoordTrans());
 
    //=========================================================================================================
    bool is_axial_coil() const;
 
    //=========================================================================================================
    bool is_magnetometer_coil() const;
 
    //=========================================================================================================
    bool is_planar_coil() const;
 
    //=========================================================================================================
    bool is_eeg_electrode() const;
 
public:
    QString chname;                                                  
    int coord_frame;                                                 
    QString desc;                                                    
    int coil_class;                                                  
    int type;                                                        
    int accuracy;                                                    
    float size;                                                      
    float base;                                                      
    Eigen::Vector3f r0;                                              
    Eigen::Vector3f ex;                                              
    Eigen::Vector3f ey;                                              
    Eigen::Vector3f ez;                                              
    int np;                                                          
    Eigen::Matrix<float, Eigen::Dynamic, 3, Eigen::RowMajor> rmag;   
    Eigen::Matrix<float, Eigen::Dynamic, 3, Eigen::RowMajor> cosmag; 
    Eigen::VectorXf w;                                               

    Eigen::Map<const Eigen::Vector3f> pos(int j) const
    {
        return Eigen::Map<const Eigen::Vector3f>(rmag.row(j).data());
    }

    Eigen::Map<const Eigen::Vector3f> dir(int j) const
    {
        return Eigen::Map<const Eigen::Vector3f>(cosmag.row(j).data());
    }
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
} // NAMESPACE FWDLIB
 
#endif // FWD_COIL_H