fiff_ch_info.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef FIFF_CH_INFO_H
#define FIFF_CH_INFO_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fiff_global.h"
#include "fiff_types.h"
#include "fiff_ch_pos.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QSharedPointer>
#include <QString>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
#include <memory>
 
//=============================================================================================================
// DEFINE NAMESPACE FIFFLIB
//=============================================================================================================
 
namespace FIFFLIB
{
 
//=============================================================================================================
class FIFFSHARED_EXPORT FiffChInfo
{
public:
    using SPtr = QSharedPointer<FiffChInfo>;             
    using ConstSPtr = QSharedPointer<const FiffChInfo>;  
    using UPtr = std::unique_ptr<FiffChInfo>;            
    using ConstUPtr = std::unique_ptr<const FiffChInfo>; 
 
    //=========================================================================================================
    FiffChInfo();
 
    //=========================================================================================================
    FiffChInfo(const FiffChInfo& p_FiffChInfo);
 
    //=========================================================================================================
    FiffChInfo& operator=(const FiffChInfo& other) = default;
 
    //=========================================================================================================
    ~FiffChInfo();
 
    //=========================================================================================================
    inline static qint32 storageSize();
 
    //=========================================================================================================
    static bool checkEegLocations(const QList<FiffChInfo>& chs, int nch);
 
    //=========================================================================================================
    bool isValidEeg() const;
 
    //=========================================================================================================
    friend bool operator==(const FiffChInfo& a, const FiffChInfo& b);
 
public:
    fiff_int_t scanNo;   
    fiff_int_t logNo;    
    fiff_int_t kind;     
    fiff_float_t range;  
    fiff_float_t cal;    
    FiffChPos chpos;     
    fiff_int_t unit;     
    fiff_int_t unit_mul; 
    QString ch_name;     
 
    //Convenience members - MATLAB -
    Eigen::Matrix<float, 4, 4, Eigen::DontAlign> coil_trans; 
    Eigen::Matrix<float, 3, 2, Eigen::DontAlign> eeg_loc;    
    fiff_int_t coord_frame;                                  
};
 
//=============================================================================================================
// INLINE DEFINITIONS
//=============================================================================================================
 
inline qint32 FiffChInfo::storageSize()
{
    // On-disk layout: scanNo, logNo, kind, range, cal, chpos, unit, unit_mul, ch_name[16]
    // (C++ class uses QString but on-disk stores fixed 16-char name)
    return 3 * sizeof(fiff_int_t) + 2 * sizeof(fiff_float_t) + FiffChPos::storageSize() + 2 * sizeof(fiff_int_t) + 16;
}
 
//=============================================================================================================
 
inline bool operator==(const FiffChInfo& a, const FiffChInfo& b)
{
    return (a.scanNo == b.scanNo &&
            a.logNo == b.logNo &&
            a.kind == b.kind &&
            a.cal == b.cal &&
            a.chpos == b.chpos &&
            a.unit == b.unit &&
            a.unit_mul == b.unit_mul &&
            a.coil_trans.isApprox(b.coil_trans, 0.0001f) &&
            a.eeg_loc.isApprox(b.eeg_loc, 0.0001f) &&
            a.coord_frame == b.coord_frame);
}
} // NAMESPACE
 
#endif // FIFF_CH_INFO_H