fiff_info.h

Go to the documentation of this file.

//=============================================================================================================
#ifndef FIFF_INFO_H
#define FIFF_INFO_H

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

#include "fiff_global.h"

#include "fiff_info_base.h"

#include "fiff_types.h"
#include "fiff_id.h"
#include "fiff_ch_info.h"
#include "fiff_dig_point.h"
#include "fiff_ctf_comp.h"
#include "fiff_coord_trans.h"
#include "fiff_proj.h"

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

#include <QList>
#include <QStringList>
#include <QSharedPointer>

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

namespace FIFFLIB
{

//=============================================================================================================
// FIFFLIB FORWARD DECLARATIONS
//=============================================================================================================

class FiffStream;

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

    //=========================================================================================================
    FiffInfo(const FiffInfo& p_FiffInfo);

    //=========================================================================================================
    ~FiffInfo();

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

    //=========================================================================================================
    bool make_compensator(fiff_int_t from, fiff_int_t to, FiffCtfComp& ctf_comp, bool exclude_comp_chs = false) const;

    //=========================================================================================================
    qint32 get_current_comp();

    //=========================================================================================================
    inline qint32 make_projector(Eigen::MatrixXd& proj) const;

    //=========================================================================================================
    inline qint32 make_projector(Eigen::MatrixXd& proj, const QStringList& p_chNames) const;

    //=========================================================================================================
    FiffInfo pick_info(const Eigen::RowVectorXi &sel = defaultVectorXi) const;

    //=========================================================================================================
    inline void set_current_comp(fiff_int_t value);

    //=========================================================================================================
    static QList<FiffChInfo> set_current_comp(QList<FiffChInfo>& listFiffChInfo, fiff_int_t value);

// ToDo
//    //=========================================================================================================
//    /**
//    * Writes the fiff information to an I/O Device, e.g. fiff file
//    *
//    * @param[in] p_IODevice   IO device to write the fiff info to.
//    */
//    void write(QIODevice &p_IODevice);

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

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

private:
    //=========================================================================================================
    bool make_compensator(fiff_int_t kind, Eigen::MatrixXd& this_comp) const;

public: //Public because it's a mne struct
    FiffId file_id;                 
    fiff_int_t  meas_date[2];       
    float sfreq;                    
    float linefreq;                 
    float highpass;                 
    float lowpass;                  
    int proj_id;                    
    QString proj_name;              
    QString xplotter_layout;        
    QString experimenter;           
    QString description;            
    QString utc_offset;             
    fiff_int_t gantry_angle;        
    FiffCoordTrans dev_ctf_t;       
    QList<FiffDigPoint> dig;        
    FiffCoordTrans dig_trans;       
    QList<FiffProj> projs;          
    QList<FiffCtfComp> comps;       
    QString acq_pars;               
    QString acq_stim;               
};

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

inline qint32 FiffInfo::make_projector(Eigen::MatrixXd& proj) const
{
    return FiffProj::make_projector(this->projs,this->ch_names, proj, this->bads);
}

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

inline qint32 FiffInfo::make_projector(Eigen::MatrixXd& proj, const QStringList& p_chNames) const
{
    return FiffProj::make_projector(this->projs, p_chNames, proj, this->bads);
}

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

inline void FiffInfo::set_current_comp(fiff_int_t value)
{
    this->chs = set_current_comp(this->chs, value);
}
} // NAMESPACE

#endif // FIFF_INFO_H