bids_raw_data.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef BIDS_RAW_DATA_H
#define BIDS_RAW_DATA_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "bids_global.h"
#include "bids_event.h"
#include "bids_electrode.h"
#include "bids_coordinate_system.h"
#include "bids_path.h"
#include "readers/bids_abstract_format_reader.h"
 
#include <fiff/fiff_raw_data.h>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QSharedPointer>
#include <QString>
#include <QList>
#include <QMap>
 
//=============================================================================================================
// DEFINE NAMESPACE BIDSLIB
//=============================================================================================================
 
namespace BIDSLIB
{
 
//=============================================================================================================
class BIDSSHARED_EXPORT BidsRawData
{
public:
    using SPtr = QSharedPointer<BidsRawData>;
    using ConstSPtr = QSharedPointer<const BidsRawData>;
 
    //=========================================================================================================
    struct WriteOptions
    {
        bool    overwrite{false};   
        bool    copyData{true};     
        QString datasetName;        
    };
 
    //=========================================================================================================
    BidsRawData() = default;
 
    //=========================================================================================================
    ~BidsRawData() = default;
 
    // Move-only: the reader holds exclusive ownership of the open file.
    BidsRawData(BidsRawData&& other) noexcept;
    BidsRawData& operator=(BidsRawData&& other) noexcept;
    BidsRawData(const BidsRawData&) = delete;
    BidsRawData& operator=(const BidsRawData&) = delete;
 
    //=========================================================================================================
    // I/O — read
    //=========================================================================================================

    static BidsRawData read(const BIDSPath& bidsPath);
 
    //=========================================================================================================
    // I/O — write
    //=========================================================================================================

    BIDSPath write(const BIDSPath& bidsPath,
                   const QString& sourcePath,
                   const WriteOptions& options) const;

    inline BIDSPath write(const BIDSPath& bidsPath,
                          const QString& sourcePath = QString()) const
    {
        return write(bidsPath, sourcePath, WriteOptions());
    }
 
    //=========================================================================================================
    // Query
    //=========================================================================================================

    bool isValid() const { return m_bIsValid; }

    void setValid(bool bValid) { m_bIsValid = bValid; }

    void clear();
 
    //=========================================================================================================
    // Static helpers
    //=========================================================================================================

    static AbstractFormatReader::UPtr createReader(const QString& sExtension);
 
    //=========================================================================================================
    // Core data members (public, following mne-cpp convention)
    //=========================================================================================================
 
    FIFFLIB::FiffRawData                raw;            
    QList<BidsEvent>                    events;         
    QMap<QString, int>                  eventIdMap;     
    QList<BidsElectrode>                electrodes;     
    BidsCoordinateSystem                coordinateSystem; 
    AbstractFormatReader::UPtr          reader;         
 
    //=========================================================================================================
    // iEEG sidecar metadata (integrated from *_{datatype}.json)
    // Fields derivable from FiffInfo (sfreq, channel counts) are omitted —
    // they are computed on write and applied on read.
    //=========================================================================================================
 
    QString ieegReference;              
    QString taskDescription;            
    QString manufacturer;               
    QString manufacturerModelName;      
    QString softwareVersions;           
    QString recordingType;              
 
private:
    bool m_bIsValid{false};     
};
 
} // namespace BIDSLIB
 
#endif // BIDS_RAW_DATA_H