fiff_coord_trans.h

Go to the documentation of this file.

//=============================================================================================================
#ifndef FIFF_COORD_TRANS_H
#define FIFF_COORD_TRANS_H

//=============================================================================================================
// INCLUDES
//=============================================================================================================

#include "fiff_global.h"
#include "fiff_types.h"
#include "c/fiff_coord_trans_old.h"

//=============================================================================================================
// QT INCLUDES
//=============================================================================================================

#include <QIODevice>
#include <QSharedPointer>

//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================

#include <Eigen/Core>

//=============================================================================================================
// DEFINE NAMESPACE FIFFLIB
//=============================================================================================================

namespace FIFFLIB
{

//=============================================================================================================
class FIFFSHARED_EXPORT FiffCoordTrans
{
public:
    typedef QSharedPointer<FiffCoordTrans> SPtr;            
    typedef QSharedPointer<const FiffCoordTrans> ConstSPtr; 
    //=========================================================================================================
    FiffCoordTrans();

    //=========================================================================================================
    FiffCoordTrans(QIODevice &p_IODevice);

    //=========================================================================================================
    FiffCoordTrans(const FiffCoordTrans &p_FiffCoordTrans);

    //=========================================================================================================
    ~FiffCoordTrans();

    //=========================================================================================================
    void clear();

    //=========================================================================================================
    bool invert_transform();

    //=========================================================================================================
    inline bool isEmpty() const
    {
        return this->from < 0;
    }

    //=========================================================================================================
    static bool read(QIODevice& p_IODevice, FiffCoordTrans& p_Trans);

    //=========================================================================================================
    Eigen::MatrixX3f apply_trans(const Eigen::MatrixX3f& rr, bool do_move = true) const;

    //=========================================================================================================
    Eigen::MatrixX3f apply_inverse_trans(const Eigen::MatrixX3f& rr, bool do_move = true) const;

    //=========================================================================================================
    static QString frame_name (int frame);

    //=========================================================================================================
    static FiffCoordTrans make(int from, int to, const Eigen::Matrix3f& rot, const Eigen::VectorXf& move);

    //=========================================================================================================
    static FiffCoordTrans make(int from, int to, const Eigen::Matrix4f& matTrans, bool bStandard = false);

    //=========================================================================================================
    static bool addInverse(FiffCoordTrans& t);

    //=========================================================================================================
    void print() const;

    //=========================================================================================================
    void write(QIODevice &p_IODevice);

    //=========================================================================================================
    void writeToStream(FiffStream* p_pStream);

    //=========================================================================================================
    inline static qint32 storageSize();

    //========================================================================================================
    friend bool operator== (const FiffCoordTrans &a, const FiffCoordTrans &b);

    //========================================================================================================
    float angleTo(Eigen::MatrixX4f mTransDest);

    //========================================================================================================
    float translationTo(Eigen::MatrixX4f mTransDest);

    //========================================================================================================
    FiffCoordTransOld toOld();

public:
    fiff_int_t  from;   
    fiff_int_t  to;     
    Eigen::Matrix<float, 4,4, Eigen::DontAlign>   trans;      
    Eigen::Matrix<float, 4,4, Eigen::DontAlign>   invtrans;   
// ### OLD STRUCT ###
// Coordinate transformation descriptor
// typedef struct _fiffCoordTransRec {
//  fiff_int_t   from;                    /< Source coordinate system. /
//  fiff_int_t   to;                      /< Destination coordinate system. /
//  fiff_float_t rot[3][3];               /< The forward transform (rotation part) /
//  fiff_float_t move[3];                 /< The forward transform (translation part) /
//  fiff_float_t invrot[3][3];            /< The inverse transform (rotation part) /
//  fiff_float_t invmove[3];              /< The inverse transform (translation part) /
// } *fiffCoordTrans, fiffCoordTransRec;  /< Coordinate transformation descriptor /

// typedef fiffCoordTransRec fiff_coord_trans_t;
};

//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================

inline qint32 FiffCoordTrans::storageSize()
{
    return 104;
}

//=============================================================================================================

inline bool operator== (const FiffCoordTrans &a, const FiffCoordTrans &b)
{
    return (a.from == b.from &&
            a.to == b.to &&
            a.trans.isApprox(b.trans, 0.0001f) &&
            a.invtrans.isApprox(b.invtrans, 0.0001f));
}
} // NAMESPACE

#ifndef metatype_fiffcoordtrans
#define metatype_fiffcoordtrans
Q_DECLARE_METATYPE(FIFFLIB::FiffCoordTrans); 
#endif

#ifndef metatype_fiffcoordtrans
#define metatype_fiffcoordtrans
Q_DECLARE_METATYPE(FIFFLIB::FiffCoordTrans::SPtr); 
#endif

#endif // FIFF_COORD_TRANS_H