bids_const.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef BIDS_CONST_H
#define BIDS_CONST_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include <fiff/fiff_constants.h>
 
#include <QMap>
#include <QString>
#include <QStringList>
 
//=============================================================================================================
// DEFINE NAMESPACE BIDSLIB
//=============================================================================================================
 
namespace BIDSLIB
{
 
//=============================================================================================================
// BIDS datatypes
//=============================================================================================================

const QString BIDS_DATATYPE_MEG   = QStringLiteral("meg");
const QString BIDS_DATATYPE_EEG   = QStringLiteral("eeg");
const QString BIDS_DATATYPE_IEEG  = QStringLiteral("ieeg");
const QString BIDS_DATATYPE_ANAT  = QStringLiteral("anat");
const QString BIDS_DATATYPE_FUNC  = QStringLiteral("func");
const QString BIDS_DATATYPE_BEH   = QStringLiteral("beh");

inline QStringList allowedElectrophysiologyDatatypes()
{
    return {BIDS_DATATYPE_MEG, BIDS_DATATYPE_EEG, BIDS_DATATYPE_IEEG};
}

inline QStringList allowedDatatypes()
{
    return {BIDS_DATATYPE_MEG, BIDS_DATATYPE_EEG, BIDS_DATATYPE_IEEG,
            BIDS_DATATYPE_ANAT, BIDS_DATATYPE_FUNC, BIDS_DATATYPE_BEH};
}
 
//=============================================================================================================
// BIDS file extensions for iEEG raw data
//=============================================================================================================

inline QStringList ieegAllowedExtensions()
{
    return {QStringLiteral(".vhdr"),    // BrainVision header
            QStringLiteral(".edf"),     // European Data Format
            QStringLiteral(".set"),     // EEGLAB
            QStringLiteral(".mef"),     // MEF3
            QStringLiteral(".nwb")};    // NWB
}

inline QStringList eegAllowedExtensions()
{
    return {QStringLiteral(".vhdr"),
            QStringLiteral(".edf"),
            QStringLiteral(".bdf"),
            QStringLiteral(".set"),
            QStringLiteral(".fif")};
}
 
//=============================================================================================================
// Channel type mapping: MNE FIFF kind → BIDS string
//=============================================================================================================

inline QMap<int, QString> fiffKindToBidsType()
{
    return {
        {FIFFV_MEG_CH,      QStringLiteral("MEGMAG")},
        {FIFFV_EEG_CH,      QStringLiteral("EEG")},
        {FIFFV_STIM_CH,     QStringLiteral("TRIG")},
        {FIFFV_EOG_CH,      QStringLiteral("EOG")},
        {FIFFV_ECG_CH,      QStringLiteral("ECG")},
        {FIFFV_EMG_CH,      QStringLiteral("EMG")},
        {FIFFV_MISC_CH,     QStringLiteral("MISC")},
        {FIFFV_RESP_CH,     QStringLiteral("RESP")},
        {FIFFV_REF_MEG_CH,  QStringLiteral("MEGREF")},
        {FIFFV_ECOG_CH,     QStringLiteral("ECOG")},
        {FIFFV_SEEG_CH,     QStringLiteral("SEEG")},
        {FIFFV_DBS_CH,      QStringLiteral("DBS")},
    };
}

inline QMap<QString, int> bidsTypeToFiffKind()
{
    return {
        {QStringLiteral("MEGMAG"),  FIFFV_MEG_CH},
        {QStringLiteral("MEGGRAD"), FIFFV_MEG_CH},
        {QStringLiteral("MEGREF"),  FIFFV_REF_MEG_CH},
        {QStringLiteral("EEG"),     FIFFV_EEG_CH},
        {QStringLiteral("ECOG"),    FIFFV_ECOG_CH},
        {QStringLiteral("SEEG"),    FIFFV_SEEG_CH},
        {QStringLiteral("DBS"),     FIFFV_DBS_CH},
        {QStringLiteral("EOG"),     FIFFV_EOG_CH},
        {QStringLiteral("ECG"),     FIFFV_ECG_CH},
        {QStringLiteral("EMG"),     FIFFV_EMG_CH},
        {QStringLiteral("TRIG"),    FIFFV_STIM_CH},
        {QStringLiteral("MISC"),    FIFFV_MISC_CH},
        {QStringLiteral("RESP"),    FIFFV_RESP_CH},
    };
}
 
//=============================================================================================================
// Coordinate system mappings: BIDS string ↔ FIFF coordinate frame
//=============================================================================================================

inline QMap<QString, int> bidsCoordToFiffFrame()
{
    return {
        {QStringLiteral("CTF"),           FIFFV_COORD_HEAD},
        {QStringLiteral("ElektaNeuromag"), FIFFV_COORD_HEAD},
        {QStringLiteral("CapTrak"),       FIFFV_COORD_HEAD},
        {QStringLiteral("ACPC"),          FIFFV_COORD_MRI},
        {QStringLiteral("fsaverage"),     FIFFV_MNE_COORD_MNI_TAL},
        {QStringLiteral("MNI305"),        FIFFV_MNE_COORD_MNI_TAL},
        {QStringLiteral("fsaverageSymm"), FIFFV_MNE_COORD_MNI_TAL},
        {QStringLiteral("Other"),         FIFFV_COORD_UNKNOWN},
    };
}

inline QMap<int, QString> fiffFrameToBidsCoord()
{
    return {
        {FIFFV_COORD_HEAD,          QStringLiteral("CapTrak")},
        {FIFFV_COORD_MRI,          QStringLiteral("ACPC")},
        {FIFFV_MNE_COORD_MNI_TAL, QStringLiteral("MNI305")},
        {FIFFV_COORD_UNKNOWN,      QStringLiteral("Other")},
    };
}
 
//=============================================================================================================
// Allowed coordinate systems for iEEG
//=============================================================================================================

inline QStringList ieegAllowedCoordSystems()
{
    return {QStringLiteral("ACPC"),
            QStringLiteral("Talairach"),
            QStringLiteral("Other"),
            QStringLiteral("fsaverage"),
            QStringLiteral("fsaverageSymm"),
            QStringLiteral("MNI305"),
            QStringLiteral("MNI152Lin"),
            QStringLiteral("MNI152NLin2009aSym"),
            QStringLiteral("MNI152NLin2009bSym"),
            QStringLiteral("MNI152NLin2009cSym"),
            QStringLiteral("MNI152NLin2009aAsym"),
            QStringLiteral("MNI152NLin2009bAsym"),
            QStringLiteral("MNI152NLin2009cAsym"),
            QStringLiteral("individual")};
}
 
//=============================================================================================================
// BIDS entity ordering (for filename construction)
//=============================================================================================================

inline QStringList bidsEntityOrder()
{
    return {QStringLiteral("sub"),
            QStringLiteral("ses"),
            QStringLiteral("task"),
            QStringLiteral("acq"),
            QStringLiteral("run"),
            QStringLiteral("proc"),
            QStringLiteral("space"),
            QStringLiteral("rec"),
            QStringLiteral("split"),
            QStringLiteral("desc"),
            QStringLiteral("tracking_system")};
}
 
} // namespace BIDSLIB
 
#endif // BIDS_CONST_H