fiff_events.cpp

Go to the documentation of this file.

//=============================================================================================================
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "fiff_events.h"
#include "fiff_evoked_set.h"
#include "fiff_raw_data.h"
#include "fiff_stream.h"
#include "fiff_dir_node.h"
#include "fiff_tag.h"
#include "fiff_constants.h"
#include "fiff_file.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QFile>
#include <QDebug>
#include <QTextStream>
 
//=============================================================================================================
// USED NAMESPACES
//=============================================================================================================
 
using namespace FIFFLIB;
using namespace Eigen;
 
//=============================================================================================================
// DEFINE MEMBER METHODS
//=============================================================================================================
 
FiffEvents::FiffEvents()
{
}
 
//=============================================================================================================
 
FiffEvents::FiffEvents(QIODevice &p_IODevice)
{
    // Try FIFF first, then ASCII
    if (!read_from_fif(p_IODevice, *this)) {
        read_from_ascii(p_IODevice, *this);
    }
}
 
//=============================================================================================================
 
bool FiffEvents::read(const QString &t_sEventName,
                      const QString &t_fileRawName,
                      FiffEvents &p_Events)
{
    QString eventName = t_sEventName;
    QFile t_EventFile;
    qint32 p;
 
    if (eventName.isEmpty()) {
        eventName = t_fileRawName;
        p = eventName.indexOf(".fif");
        if (p > 0) {
            eventName.replace(p, 4, "-eve.fif");
        } else {
            qWarning("Raw file name does not end properly\n");
            return false;
        }
 
        t_EventFile.setFileName(eventName);
        if(!read_from_fif(t_EventFile, p_Events)) {
            qWarning("Error while read events.\n");
            return false;
        }
        qInfo("Events read from %s\n",eventName.toUtf8().constData());
    } else {
        // Binary file
        if (eventName.contains(".fif")) {
            t_EventFile.setFileName(eventName);
            if(!read_from_fif(t_EventFile, p_Events)) {
                qWarning("Error while read events.\n");
                return false;
            }
            qInfo("Binary event file %s read\n",eventName.toUtf8().constData());
        } else if(eventName.contains(".eve")){
 
        } else {
            // Text file
            qWarning("Text file %s is not supported jet.\n",eventName.toUtf8().constData());
        }
    }
 
    return true;
}
 
//=============================================================================================================
 
bool FiffEvents::read_from_fif(QIODevice &p_IODevice,
                               FiffEvents &p_Events)
{
    //
    // Open file
    //
    FiffStream::SPtr t_pStream(new FiffStream(&p_IODevice));
 
    if(!t_pStream->open()) {
        return false;
    }
 
    //
    //   Find the desired block
    //
    QList<FiffDirNode::SPtr> eventsBlocks = t_pStream->dirtree()->dir_tree_find(FIFFB_MNE_EVENTS);
 
    if (eventsBlocks.size() == 0)
    {
        qWarning("Could not find event data\n");
        return false;
    }
 
    qint32 k, nelem;
    fiff_int_t kind, pos;
    FiffTag::UPtr t_pTag;
    quint32* serial_eventlist_uint = nullptr;
    qint32* serial_eventlist_int = nullptr;
 
    for(k = 0; k < eventsBlocks[0]->nent(); ++k)
    {
        kind = eventsBlocks[0]->dir[k]->kind;
        pos  = eventsBlocks[0]->dir[k]->pos;
        if (kind == FIFF_MNE_EVENT_LIST)
        {
            t_pStream->read_tag(t_pTag,pos);
            if(t_pTag->type == FIFFT_UINT)
            {
                serial_eventlist_uint = t_pTag->toUnsignedInt();
                nelem = t_pTag->size()/4;
            }
 
            if(t_pTag->type == FIFFT_INT)
            {
                serial_eventlist_int = t_pTag->toInt();
                nelem = t_pTag->size()/4;
            }
 
            break;
        }
    }
 
    if(serial_eventlist_uint == nullptr && serial_eventlist_int == nullptr)
    {
        qWarning("Could not find any events\n");
        return false;
    }
 
    p_Events.events.resize(nelem/3,3);
    if(serial_eventlist_uint != nullptr)
    {
        for(k = 0; k < nelem/3; ++k)
        {
            p_Events.events(k,0) = serial_eventlist_uint[k*3];
            p_Events.events(k,1) = serial_eventlist_uint[k*3+1];
            p_Events.events(k,2) = serial_eventlist_uint[k*3+2];
        }
    }
 
    if(serial_eventlist_int != nullptr)
    {
        for(k = 0; k < nelem/3; ++k)
        {
            p_Events.events(k,0) = serial_eventlist_int[k*3];
            p_Events.events(k,1) = serial_eventlist_int[k*3+1];
            p_Events.events(k,2) = serial_eventlist_int[k*3+2];
        }
    }
 
    return true;
}
 
//=============================================================================================================
 
bool FiffEvents::read_from_ascii(QIODevice &p_IODevice,
                                 FiffEvents &p_Events)
{
    if (!p_IODevice.open(QIODevice::ReadOnly | QIODevice::Text)){
        return false;
    }
    QTextStream textStream(&p_IODevice);
 
    QList<int> sampleList;
    QList<int> beforeList;
    QList<int> afterList;
 
    while(!textStream.atEnd()){
        QString line = textStream.readLine().trimmed();
        if (line.isEmpty())
            continue;
        QTextStream lineStream(&line);
        int iSample = 0, iBefore = 0, iAfter = 0;
        lineStream >> iSample;
        if (!lineStream.atEnd())
            lineStream >> iBefore;
        if (!lineStream.atEnd())
            lineStream >> iAfter;
        sampleList.append(iSample);
        beforeList.append(iBefore);
        afterList.append(iAfter);
        qDebug() << "Added event:" << iSample << iBefore << iAfter;
    }
 
    p_Events.events.resize(sampleList.size(), 3);
 
    for(int i = 0; i < sampleList.size(); i++){
        p_Events.events(i,0) = sampleList[i];
        p_Events.events(i,1) = beforeList[i];
        p_Events.events(i,2) = afterList[i];
    }
    return true;
}
 
//=============================================================================================================
 
bool FiffEvents::write_to_fif(QIODevice &p_IODevice) const
{
    if (events.rows() == 0 || events.cols() < 3)
        return false;
 
    FiffStream::SPtr pStream = FiffStream::start_file(p_IODevice);
    if (!pStream)
        return false;
 
    pStream->start_block(FIFFB_MNE_EVENTS);
    pStream->write_int(FIFF_MNE_EVENT_LIST, events.data(), events.rows() * 3);
    pStream->end_block(FIFFB_MNE_EVENTS);
    pStream->end_file();
 
    return true;
}
 
//=============================================================================================================
 
bool FiffEvents::write_to_ascii(QIODevice &p_IODevice,
                                float sfreq) const
{
    if (!p_IODevice.open(QIODevice::WriteOnly | QIODevice::Text))
        return false;
 
    for (int k = 0; k < events.rows(); ++k) {
        int sample = events(k, 0);
        int before = (events.cols() > 1) ? events(k, 1) : 0;
        int after  = (events.cols() > 2) ? events(k, 2) : 0;
        float time = (sfreq > 0.0f) ? static_cast<float>(sample) / sfreq : 0.0f;
        QTextStream out(&p_IODevice);
        out << QString("%1 %2 %3 %4\n")
               .arg(sample, 6)
               .arg(time, -10, 'f', 3)
               .arg(before, 3)
               .arg(after, 3);
    }
 
    p_IODevice.close();
    return true;
}
 
//=============================================================================================================
 
bool FiffEvents::detect_from_raw(const FiffRawData &raw,
                                 FiffEvents &p_Events,
                                 const QString &triggerCh,
                                 unsigned int triggerMask,
                                 bool leadingEdge)
{
    QString stimCh = triggerCh.isEmpty() ? QString("STI 014") : triggerCh;
 
    // Find trigger channel index
    int triggerChIdx = -1;
    for (int k = 0; k < raw.info.ch_names.size(); ++k) {
        if (raw.info.ch_names[k] == stimCh) {
            triggerChIdx = k;
            break;
        }
    }
    if (triggerChIdx < 0) {
        qWarning() << "[FiffEvents::detect_from_raw] Trigger channel" << stimCh << "not found.";
        return false;
    }
 
    // Read trigger channel data
    MatrixXd data;
    MatrixXd times;
    if (!raw.read_raw_segment(data, times, raw.first_samp, raw.last_samp,
                              RowVectorXi::LinSpaced(1, triggerChIdx, triggerChIdx))) {
        qWarning() << "[FiffEvents::detect_from_raw] Could not read trigger channel data.";
        return false;
    }
 
    RowVectorXd trigData = data.row(0);
    int nSamples = static_cast<int>(trigData.cols());
 
    // Detect flanks
    QList<int> eventSamples;
    QList<int> eventBefore;
    QList<int> eventAfter;
 
    int prevVal = static_cast<int>(trigData(0)) & triggerMask;
    for (int s = 1; s < nSamples; ++s) {
        int curVal = static_cast<int>(trigData(s)) & triggerMask;
        if (curVal != prevVal) {
            if (!leadingEdge || (leadingEdge && prevVal == 0 && curVal != 0)) {
                eventSamples.append(static_cast<int>(raw.first_samp) + s);
                eventBefore.append(prevVal);
                eventAfter.append(curVal);
            }
        }
        prevVal = curVal;
    }
 
    int nEvents = eventSamples.size();
    p_Events.events.resize(nEvents, 3);
    for (int k = 0; k < nEvents; ++k) {
        p_Events.events(k, 0) = eventSamples[k];
        p_Events.events(k, 1) = eventBefore[k];
        p_Events.events(k, 2) = eventAfter[k];
    }
 
    return nEvents > 0;
}
 
//=============================================================================================================
 
bool FiffEvents::matchEvent(const AverageCategory &cat,
                            const MatrixXi &events,
                            int eventIdx)
{
    if (eventIdx < 0 || eventIdx >= events.rows())
        return false;
 
    int evFrom = events(eventIdx, 1);
    int evTo   = events(eventIdx, 2);
 
    // Check if any of the category's event codes match
    bool match = false;
    for (int k = 0; k < cat.events.size(); ++k) {
        if ((evFrom & ~cat.ignore) == 0 &&
            (evTo & ~cat.ignore) == cat.events[k]) {
            match = true;
            break;
        }
    }
    if (!match)
        return false;
 
    // Check previous event constraint
    if (cat.prevEvent != 0) {
        bool found = false;
        for (int j = eventIdx - 1; j >= 0; --j) {
            if ((events(j, 1) & ~cat.prevIgnore) == 0) {
                found = true;
                match = match && ((events(j, 2) & ~cat.prevIgnore) == cat.prevEvent);
                break;
            }
        }
        if (!found)
            match = false;
    }
 
    // Check next event constraint
    if (cat.nextEvent != 0) {
        bool found = false;
        for (int j = eventIdx + 1; j < events.rows(); ++j) {
            if ((events(j, 1) & ~cat.nextIgnore) == 0) {
                found = true;
                match = match && ((events(j, 2) & ~cat.nextIgnore) == cat.nextEvent);
                break;
            }
        }
        if (!found)
            match = false;
    }
 
    return match;
}