fiff_evoked_set.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef FIFF_EVOKED_SET_H
#define FIFF_EVOKED_SET_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fiff_info.h"
#include "fiff_evoked.h"
#include "fiff_global.h"
 
#include <Eigen/Core>
#include <QVector>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QIODevice>
#include <QList>
#include <QSharedPointer>
#include <QStringList>
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
#include <memory>
 
//=============================================================================================================
// DEFINE NAMESPACE MNELIB
//=============================================================================================================
 
namespace FIFFLIB
{
 
class FiffRawData;
 
//=============================================================================================================
struct FIFFSHARED_EXPORT RejectionParams
{
    float stimIgnore = 0.0f;         
    float megGradReject = 2000e-13f; 
    float megMagReject = 3e-12f;     
    float eegReject = 100e-6f;       
    float eogReject = 150e-6f;       
    float ecgReject = 0.0f;          
    float megGradFlat = 0.0f;        
    float megMagFlat = 0.0f;         
    float eegFlat = 0.0f;            
    float eogFlat = 0.0f;            
    float ecgFlat = 0.0f;            
};
 
//=============================================================================================================
struct FIFFSHARED_EXPORT AverageCategory
{
    QString comment;              
    QVector<unsigned int> events; 
    unsigned int nextEvent = 0;   
    unsigned int prevEvent = 0;   
    unsigned int ignore = 0;      
    unsigned int prevIgnore = 0;  
    unsigned int nextIgnore = 0;  
    float delay = 0.0f;           
    float tmin = -0.2f;           
    float tmax = 0.5f;            
    float bmin = 0.0f;            
    float bmax = 0.0f;            
    bool doBaseline = false;      
    bool doStdErr = false;        
    bool doAbs = false;           
    float color[3] = {0, 0, 0};   
};
 
//=============================================================================================================
struct FIFFSHARED_EXPORT AverageDescription
{
    QString comment;                   
    QList<AverageCategory> categories; 
    RejectionParams rej;               
    bool fixSkew = false;              
    QString filename;                  
    QString eventFile;                 
    QString logFile;                   
};
 
//=============================================================================================================
class FIFFSHARED_EXPORT FiffEvokedSet
{
public:
    using SPtr = QSharedPointer<FiffEvokedSet>;             
    using ConstSPtr = QSharedPointer<const FiffEvokedSet>;  
    using UPtr = std::unique_ptr<FiffEvokedSet>;            
    using ConstUPtr = std::unique_ptr<const FiffEvokedSet>; 
 
    //=========================================================================================================
    FiffEvokedSet();
 
    //=========================================================================================================
    FiffEvokedSet(QIODevice& p_IODevice);
 
    //=========================================================================================================
    FiffEvokedSet(const FiffEvokedSet& p_FiffEvokedSet);
 
    //=========================================================================================================
    FiffEvokedSet& operator=(const FiffEvokedSet& other) = default;
 
    //=========================================================================================================
    ~FiffEvokedSet();
 
    //=========================================================================================================
    void clear();
 
    //=========================================================================================================
    FiffEvokedSet pick_channels(const QStringList& include = defaultQStringList,
                                const QStringList& exclude = defaultQStringList) const;
 
    //=========================================================================================================
    bool compensate_to(FiffEvokedSet& p_FiffEvokedSet,
                       fiff_int_t to) const;
 
    //=========================================================================================================
    bool find_evoked(const FiffEvokedSet& p_FiffEvokedSet) const;
 
    //=========================================================================================================
    static bool read(QIODevice& p_IODevice,
                     FiffEvokedSet& p_FiffEvokedSet,
                     QPair<float, float> baseline = defaultFloatPair,
                     bool proj = true);
 
    //=========================================================================================================
    bool save(const QString& fileName) const;
 
    //=========================================================================================================
    static FiffEvokedSet computeGrandAverage(const QList<FiffEvokedSet>& evokedSets);
 
    //=========================================================================================================
    static FiffEvokedSet computeAverages(const FiffRawData& raw,
                                         const AverageDescription& desc,
                                         const Eigen::MatrixXi& events,
                                         QString& log);
 
    //=========================================================================================================
    static bool checkArtifacts(const Eigen::MatrixXd& epoch,
                               const FiffInfo& info,
                               const QStringList& bads,
                               const RejectionParams& rej,
                               QString& reason);

    static void subtractBaseline(Eigen::MatrixXd& epoch, int bminSamp, int bmaxSamp);
 
public:
    FiffInfo info;            
    QList<FiffEvoked> evoked; 
};
} // NAMESPACE
 
#ifndef metatype_fiffevokedset
#define metatype_fiffevokedset
Q_DECLARE_METATYPE(FIFFLIB::FiffEvokedSet); 
#endif
 
#ifndef metatype_fiffevokedsetsptr
#define metatype_fiffevokedsetsptr
Q_DECLARE_METATYPE(FIFFLIB::FiffEvokedSet::SPtr); 
#endif
 
#endif // FIFF_EVOKED_SET_H