fwd_coil_set.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef FWD_COIL_SET_H
#define FWD_COIL_SET_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fwd_global.h"
#include "fwd_coil.h"
#include <fiff/fiff_types.h>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QSharedPointer>
 
#include <memory>
#include <vector>
 
//=============================================================================================================
// DEFINE NAMESPACE FWDLIB
//=============================================================================================================
 
namespace FWDLIB
{
class FwdBemSolution;
//=============================================================================================================
class FWDSHARED_EXPORT FwdCoilSet
{
public:
    typedef QSharedPointer<FwdCoilSet> SPtr;            
    typedef QSharedPointer<const FwdCoilSet> ConstSPtr; 
    typedef std::unique_ptr<FwdCoilSet> UPtr;           
 
    //=========================================================================================================
    FwdCoilSet();
 
    //=========================================================================================================
    ~FwdCoilSet();
 
    //=========================================================================================================
    FwdCoil::UPtr create_meg_coil(const FIFFLIB::FiffChInfo& ch, int acc, const FIFFLIB::FiffCoordTrans& t = FIFFLIB::FiffCoordTrans());
 
    //=========================================================================================================
    FwdCoilSet::UPtr create_meg_coils(const QList<FIFFLIB::FiffChInfo>& chs,
                                      int nch,
                                      int acc,
                                      const FIFFLIB::FiffCoordTrans& t = FIFFLIB::FiffCoordTrans());
 
    //=========================================================================================================
    static FwdCoilSet::UPtr create_eeg_els(const QList<FIFFLIB::FiffChInfo>& chs,
                                           int nch,
                                           const FIFFLIB::FiffCoordTrans& t = FIFFLIB::FiffCoordTrans());
 
    //=========================================================================================================
    static FwdCoilSet::UPtr read_coil_defs(const QString& name);
 
    //=========================================================================================================
    FwdCoilSet::UPtr dup_coil_set(const FIFFLIB::FiffCoordTrans& t = FIFFLIB::FiffCoordTrans()) const;
 
    //=========================================================================================================
    bool is_planar_coil_type(int type) const;
 
    //=========================================================================================================
    bool is_axial_coil_type(int type) const;
 
    //=========================================================================================================
    bool is_magnetometer_coil_type(int type) const;
 
    //=========================================================================================================
    bool is_eeg_electrode_type(int type) const;
 
private:
    //=========================================================================================================
    FwdCoil* fwd_add_coil_to_set(int type, int coil_class, int acc, int np, float size, float base, const QString& desc);
 
public:
    std::vector<FwdCoil::UPtr> coils;          
    int coord_frame;                           
    std::unique_ptr<FwdBemSolution> user_data; 

    inline int ncoil() const
    {
        return static_cast<int>(coils.size());
    }
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
} // NAMESPACE FWDLIB
 
#endif // FWD_COIL_SET_H