bids_brain_vision_reader.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef BIDS_BRAIN_VISION_READER_H
#define BIDS_BRAIN_VISION_READER_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "bids_abstract_format_reader.h"
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QDateTime>
#include <QVector>
#include <QFile>
#include <QMap>
 
//=============================================================================================================
// DEFINE NAMESPACE BIDSLIB
//=============================================================================================================
 
namespace BIDSLIB
{
 
//=============================================================================================================
struct BIDSSHARED_EXPORT BrainVisionMarker
{
    QString type;        
    QString description; 
    long position{0};    
    long duration{0};    
    int channel{0};      
    QDateTime date;      
};
 
//=============================================================================================================
struct BIDSSHARED_EXPORT BrainVisionChannelInfo
{
    int channelNumber{0};
    QString name;
    QString reference;
    float resolution{1.0f}; 
    QString unit;           
 
    FIFFLIB::FiffChInfo toFiffChInfo() const;
};
 
//=============================================================================================================
enum class BVBinaryFormat
{
    INT_16,
    INT_32,
    IEEE_FLOAT_32
};
 
//=============================================================================================================
enum class BVOrientation
{
    MULTIPLEXED,
    VECTORIZED
};
 
//=============================================================================================================
class BIDSSHARED_EXPORT BrainVisionReader : public AbstractFormatReader
{
public:
    //=========================================================================================================
    BrainVisionReader();
 
    ~BrainVisionReader() override;
 
    // AbstractFormatReader interface
    bool open(const QString& sFilePath) override;
    FIFFLIB::FiffInfo getInfo() const override;
    Eigen::MatrixXf readRawSegment(int iStartSampleIdx, int iEndSampleIdx) const override;
    long getSampleCount() const override;
    float getFrequency() const override;
    int getChannelCount() const override;
    FIFFLIB::FiffRawData toFiffRawData() const override;
    QString formatName() const override;
    bool supportsExtension(const QString& sExtension) const override;
 
    //=========================================================================================================
    QVector<BrainVisionMarker> getMarkers() const;
 
    //=========================================================================================================
    QVector<BrainVisionChannelInfo> getChannelInfos() const;
 
    // Unit to scaling factor into SI (V for voltages, S for siemens); unknown units scale by 1, like mne
    static float unitScale(const QString& sUnit);
 
    // Whether the unit is a voltage (V, mV, µV, uV, nV); other channels are typed misc, like mne
    static bool isVoltageUnit(const QString& sUnit);
 
private:
    bool parseHeader(const QString& sVhdrPath);
    bool parseMarkers(const QString& sVmrkPath);
    void computeSampleCount();
 
    QString m_sVhdrPath;
    QString m_sDataPath;
    QString m_sMarkerPath;
 
    // Header fields
    float m_fSFreq{0.0f};
    int m_iNumChannels{0};
    BVBinaryFormat m_binaryFormat{BVBinaryFormat::INT_16};
    BVOrientation m_orientation{BVOrientation::MULTIPLEXED};
    long m_lSampleCount{0};
 
    QVector<BrainVisionChannelInfo> m_vChannels;
    QVector<BrainVisionMarker> m_vMarkers;
 
    mutable QFile m_dataFile;
    bool m_bIsOpen{false};
};
 
} // namespace BIDSLIB
 
#endif // BIDS_BRAIN_VISION_READER_H