fwd_coil_set.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef FWDCOILSET_H
#define FWDCOILSET_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fwd_global.h"
#include "fwd_coil.h"
#include <fiff/fiff_types.h>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QSharedPointer>
 
typedef void (*fwdUserFreeFunc)(void *);  /* General purpose */
 
//=============================================================================================================
// DEFINE NAMESPACE FWDLIB
//=============================================================================================================
 
namespace FWDLIB
{
 
//=============================================================================================================
class FWDSHARED_EXPORT FwdCoilSet
{
public:
    typedef QSharedPointer<FwdCoilSet> SPtr;              
    typedef QSharedPointer<const FwdCoilSet> ConstSPtr;   
 
    //=========================================================================================================
    FwdCoilSet();
 
//    //=========================================================================================================
//    /**
//    * Copy constructor.
//    *
//    * @param[in] p_FwdCoilSet      FwdCoilSet which should be copied
//    */
//    FwdCoilSet(const FwdCoilSet& p_FwdCoilSet);
 
    //=========================================================================================================
    ~FwdCoilSet();
 
    void fwd_free_coil_set_user_data()
    {
        if (user_data_free && user_data)
            user_data_free(user_data);
        user_data = NULL;
    }
 
    //=========================================================================================================
    FwdCoil* create_meg_coil(const FIFFLIB::FiffChInfo& ch, int acc, const FIFFLIB::FiffCoordTrans& t = FIFFLIB::FiffCoordTrans());
 
    //=========================================================================================================
    FwdCoilSet* create_meg_coils(const QList<FIFFLIB::FiffChInfo>& chs,
                                 int nch,
                                 int acc,
                                 const FIFFLIB::FiffCoordTrans& t = FIFFLIB::FiffCoordTrans());
 
    //=========================================================================================================
    static FwdCoilSet* create_eeg_els(const QList<FIFFLIB::FiffChInfo>& chs,
                                      int nch,
                                      const FIFFLIB::FiffCoordTrans& t = FIFFLIB::FiffCoordTrans());
 
    //=========================================================================================================
    static FwdCoilSet* read_coil_defs(const QString& name);
 
    //=========================================================================================================
    FwdCoilSet* 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;
 
public:
    FwdCoil **coils;                /*< The coil or electrode positions >*/
    int     ncoil;                  /*< Number of coils >*/
    int     coord_frame;            /*< Common coordinate frame >*/
    void    *user_data;             /*< We can put whatever in here >*/
    fwdUserFreeFunc user_data_free;
 
// ### OLD STRUCT ###
//    typedef struct {
//      fwdCoil *coils;     /* The coil or electrode positions */
//      int     ncoil;
//      int     coord_frame;        /* Common coordinate frame */
//      void    *user_data;     /* We can put whatever in here */
//      fwdUserFreeFunc user_data_free;
//    } *fwdCoilSet,fwdCoilSetRec;  /* A collection of the above */
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
} // NAMESPACE FWDLIB
 
#endif // FWDCOILSET_H