fiff_evoked.h

Go to the documentation of this file.

//=============================================================================================================
#ifndef FIFF_EVOKED_H
#define FIFF_EVOKED_H

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

#include "fiff_global.h"
#include "fiff_info.h"
#include "fiff_types.h"
#include "fiff_file.h"

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

#include <Eigen/Core>

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

#include <QString>
#include <QVariant>
#include <QPair>
#include <QSharedPointer>

//=============================================================================================================
// DEFINE NAMESPACE MNELIB
//=============================================================================================================

namespace FIFFLIB
{

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

    //=========================================================================================================
    FiffEvoked(QIODevice& p_IODevice,
               QVariant setno = 0,
               QPair<float,float> t_baseline = defaultFloatPair,
               bool proj = true,
               fiff_int_t p_aspect_kind = FIFFV_ASPECT_AVERAGE);

    //=========================================================================================================
    FiffEvoked(const FiffEvoked& p_FiffEvoked);

    //=========================================================================================================
    ~FiffEvoked();

    //=========================================================================================================
    inline QStringList ch_names();

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

    //=========================================================================================================
    inline QString aspectKindToString() const;

    //=========================================================================================================
    inline bool isEmpty();

    //=========================================================================================================
    FiffEvoked pick_channels(const QStringList& include = defaultQStringList,
                             const QStringList& exclude = defaultQStringList) const;

    //=========================================================================================================
    static bool read(QIODevice& p_IODevice,
                     FiffEvoked& p_FiffEvoked,
                     QVariant setno = 0, QPair<float,float> t_baseline = defaultFloatPair,
                     bool proj = true,
                     fiff_int_t p_aspect_kind = FIFFV_ASPECT_AVERAGE);

    //=========================================================================================================
    void setInfo(const FiffInfo &p_info,
                 bool proj = true);

    //=========================================================================================================
    FiffEvoked & operator+=(const Eigen::MatrixXd &newData);

    //=========================================================================================================
    void applyBaselineCorrection(QPair<float,float>& p_baseline);

public:
    FiffInfo                    info;               
    fiff_int_t                  nave;               
    fiff_int_t                  aspect_kind;        
    fiff_int_t                  first;              
    fiff_int_t                  last;               
    QString                     comment;            
    Eigen::RowVectorXf          times;              
    Eigen::MatrixXd             data;               
    Eigen::MatrixXd             proj;               
    QPair<float,float>          baseline;           
};

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

inline QStringList FiffEvoked::ch_names()
{
    return info.ch_names;
}

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

inline QString FiffEvoked::aspectKindToString() const
{
    if(aspect_kind == FIFFV_ASPECT_AVERAGE)
        return QString("Average");
    else if(aspect_kind == FIFFV_ASPECT_STD_ERR)
        return QString("Standard_error");
    else
        return QString("Unknown");
}

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

inline bool FiffEvoked::isEmpty()
{
    return nave == -1;
}

} // NAMESPACE

#ifndef metatype_fiffevoked
#define metatype_fiffevoked
Q_DECLARE_METATYPE(FIFFLIB::FiffEvoked);
#endif

#ifndef metatype_fiffevokedsptr
#define metatype_fiffevokedsptr
Q_DECLARE_METATYPE(FIFFLIB::FiffEvoked::SPtr);
#endif

#endif // FIFF_EVOKED_H