inv_sensor_set.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef INV_SENSOR_SET_H
#define INV_SENSOR_SET_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "../inv_global.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QObject>
#include <QSharedPointer>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// FORWARD DECLARATIONS
//=============================================================================================================
 
namespace FWDLIB
{
class FwdCoil;
class FwdCoilSet;
}
 
namespace FIFFLIB
{
class FiffCoordTrans;
class FiffDigPointSet;
class FiffChInfo;
}
 
//=============================================================================================================
// DEFINE NAMESPACE HPILIB
//=============================================================================================================
 
namespace INVLIB
{
enum class Accuracy : int
{
    high = 2,
    medium = 1,
    low = 0
};

class INVSHARED_EXPORT InvSensorSet
{
public:
    typedef QSharedPointer<InvSensorSet> SPtr;            
    typedef QSharedPointer<const InvSensorSet> ConstSPtr; 
 
    //=========================================================================================================
    explicit InvSensorSet() = default;
 
    //=========================================================================================================
    explicit InvSensorSet(const QSharedPointer<FWDLIB::FwdCoilSet> pFwdCoilSet);
 
    inline int np() const;
    inline int ncoils() const;
    inline Eigen::VectorXd ez(int iSensor) const;
    inline Eigen::MatrixXd ez() const;
 
    inline Eigen::VectorXd r0(int iSensor) const;
    inline Eigen::MatrixXd r0() const;
 
    inline Eigen::MatrixXd rmag(int iSensor) const;
    inline Eigen::MatrixXd rmag() const;
 
    inline Eigen::MatrixXd cosmag(int iSensor) const;
    inline Eigen::MatrixXd cosmag() const;
 
    inline Eigen::MatrixXd tra(int iSensor) const;
    inline Eigen::MatrixXd tra() const;
 
    inline Eigen::RowVectorXd w(int iSensor) const;
    inline Eigen::RowVectorXd w() const;
 
    inline bool operator==(const InvSensorSet& b) const;
    inline bool operator!=(const InvSensorSet& b) const;
 
private:
    //=========================================================================================================
    void initFromFwdCoilSet(const QSharedPointer<FWDLIB::FwdCoilSet> pFwdCoilSet);
 
    //=========================================================================================================
    void initMatrices(int iNchan, int iNp);
 
    Eigen::MatrixXd m_ez{Eigen::MatrixXd(0, 0)};
    Eigen::MatrixXd m_r0{Eigen::MatrixXd(0, 0)};
    Eigen::MatrixXd m_rmag{Eigen::MatrixXd(0, 0)};
    Eigen::MatrixXd m_cosmag{Eigen::MatrixXd(0, 0)};
    Eigen::MatrixXd m_tra{Eigen::MatrixXd(0, 0)};
    Eigen::RowVectorXd m_w{Eigen::RowVectorXd(0)};
    int m_ncoils{0};
    int m_np{0};
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
 
inline int InvSensorSet::np() const
{
    return m_np;
}
 
inline int InvSensorSet::ncoils() const
{
    return m_ncoils;
}
 
inline Eigen::VectorXd InvSensorSet::ez(int iSensor) const
{
    return m_ez.row(iSensor);
}
 
inline Eigen::MatrixXd InvSensorSet::ez() const
{
    return m_ez;
}
 
inline Eigen::VectorXd InvSensorSet::r0(int iSensor) const
{
    return m_r0.row(iSensor);
}
 
inline Eigen::MatrixXd InvSensorSet::r0() const
{
    return m_r0;
}
 
inline Eigen::RowVectorXd InvSensorSet::w(int iSensor) const
{
    return m_w.segment(iSensor * m_np, m_np);
}
 
inline Eigen::RowVectorXd InvSensorSet::w() const
{
    return m_w;
}
 
inline Eigen::MatrixXd InvSensorSet::rmag(int iSensor) const
{
    return m_rmag.block(iSensor * m_np, 0, m_np, 3);
}
 
inline Eigen::MatrixXd InvSensorSet::rmag() const
{
    return m_rmag;
}
 
inline Eigen::MatrixXd InvSensorSet::cosmag(int iSensor) const
{
    return m_cosmag.block(iSensor * m_np, 0, m_np, 3);
}
 
inline Eigen::MatrixXd InvSensorSet::cosmag() const
{
    return m_cosmag;
}
 
inline Eigen::MatrixXd InvSensorSet::tra() const
{
    return m_tra;
}
//=============================================================================================================
 
inline bool InvSensorSet::operator==(const InvSensorSet& b) const
{
    return (this->ez() == b.ez() &&
            this->r0() == b.r0() &&
            this->rmag() == b.rmag() &&
            this->cosmag() == b.cosmag() &&
            this->tra() == b.tra() &&
            this->w() == b.w() &&
            this->np() == b.np() &&
            this->ncoils() == b.ncoils());
}
 
//=============================================================================================================
 
inline bool InvSensorSet::operator!=(const InvSensorSet& b) const
{
    bool equal = this == &b;
    return !(equal);
}
 
//=============================================================================================================
class INVSHARED_EXPORT InvSensorSetCreator
{
public:
    typedef QSharedPointer<InvSensorSetCreator> SPtr;            
    typedef QSharedPointer<const InvSensorSetCreator> ConstSPtr; 
 
    //=========================================================================================================
    explicit InvSensorSetCreator();
 
    //=========================================================================================================
    InvSensorSet updateSensorSet(const QList<FIFFLIB::FiffChInfo>& channelList,
                                 const Accuracy& accuracy);
 
private:
    QSharedPointer<FWDLIB::FwdCoilSet> m_pCoilDefinitions{nullptr}; // the coil definitions as template
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
 
} // namespace INVLIB
 
#endif // INV_SENSOR_SET_H