fiff_annotations.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef FIFF_ANNOTATIONS_H
#define FIFF_ANNOTATIONS_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fiff_global.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QSharedPointer>
#include <QString>
#include <QStringList>
#include <QVariantMap>
#include <QVector>
 
//=============================================================================================================
// DEFINE NAMESPACE FIFFLIB
//=============================================================================================================
 
namespace FIFFLIB
{
 
//=============================================================================================================
struct FIFFSHARED_EXPORT FiffAnnotation
{
    double      onset;          
    double      duration;       
    QString     description;    
    QStringList channelNames;   
    QString     comment;        
    QVariantMap extras;         
};
 
//=============================================================================================================
class FIFFSHARED_EXPORT FiffAnnotations
{
public:
    typedef QSharedPointer<FiffAnnotations> SPtr;            
    typedef QSharedPointer<const FiffAnnotations> ConstSPtr; 
 
    //=========================================================================================================
    FiffAnnotations();
 
    //=========================================================================================================
    int size() const;
 
    //=========================================================================================================
    bool isEmpty() const;
 
    //=========================================================================================================
    const FiffAnnotation& operator[](int index) const;
 
    //=========================================================================================================
    FiffAnnotation& operator[](int index);
 
    //=========================================================================================================
    void append(const FiffAnnotation& annotation);
 
    //=========================================================================================================
    void append(double onset, double duration, const QString& description,
                const QStringList& channelNames = QStringList(),
                const QString& comment = QString());
 
    //=========================================================================================================
    void remove(int index);
 
    //=========================================================================================================
    void clear();
 
    //=========================================================================================================
    const QVector<FiffAnnotation>& toVector() const;
 
    //=========================================================================================================
    int onsetToSample(int index, double sfreq, int firstSample = 0) const;
 
    //=========================================================================================================
    int endToSample(int index, double sfreq, int firstSample = 0) const;
 
    //=========================================================================================================
    FiffAnnotations select(const QString& descriptionFilter) const;
 
    //=========================================================================================================
    FiffAnnotations selectByChannel(const QString& channelName) const;
 
    //=========================================================================================================
    FiffAnnotations crop(double tmin, double tmax) const;
 
    //=========================================================================================================
    static FiffAnnotations readJson(const QString& path);
 
    //=========================================================================================================
    static bool writeJson(const QString& path, const FiffAnnotations& annot);
 
    //=========================================================================================================
    static FiffAnnotations readCsv(const QString& path);
 
    //=========================================================================================================
    static bool writeCsv(const QString& path, const FiffAnnotations& annot);
 
    //=========================================================================================================
    static FiffAnnotations read(const QString& path);
 
    //=========================================================================================================
    static bool write(const QString& path, const FiffAnnotations& annot);
 
private:
    QVector<FiffAnnotation> m_annotations;  
};
 
} // namespace FIFFLIB
 
#endif // FIFF_ANNOTATIONS_H