inv_token.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef INV_TOKEN_H
#define INV_TOKEN_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include <cstdint>
#include <vector>
 
//=============================================================================================================
// DEFINE NAMESPACE INVLIB
//=============================================================================================================
 
namespace INVLIB
{
 
//=============================================================================================================
enum class InvTokenId : int32_t
{
    // --- Special tokens ---
    Pad              = 0,
    Bos              = 1,       
    Eos              = 2,       
    Sep              = 3,       
 
    // --- Section markers (paired begin / end) ---
    MetaBegin        = 10,
    MetaEnd          = 11,
 
    GridBegin        = 20,
    GridEnd          = 21,
    GridRow          = 22,      
 
    CouplingBegin    = 30,
    CouplingEnd      = 31,
    GroupBegin        = 32,     
    GroupEnd          = 33,
 
    FocalBegin       = 40,
    FocalEnd         = 41,
    DipoleBegin      = 42,     
    DipoleEnd        = 43,
 
    ConnBegin        = 50,
    ConnEnd          = 51,
    ConnEntryBegin   = 52,     
    ConnEntryEnd     = 53,
 
    PosBegin         = 60,
    PosEnd           = 61,
 
    // --- Method labels (one-hot from InvEstimateMethod) ---
    MethodUnknown    = 100,
    MethodMNE        = 101,
    MethodDSPM       = 102,
    MethodSLORETA    = 103,
    MethodELORETA    = 104,
    MethodLCMV       = 105,
    MethodDICS       = 106,
    MethodSAM        = 107,
    MethodMixedNorm  = 108,
    MethodGammaMAP   = 109,
    MethodDipoleFit  = 110,
    MethodRapMusic   = 111,
    MethodPwlRapMusic= 112,
 
    // --- Source-space labels (one-hot from InvSourceSpaceType) ---
    SpaceUnknown     = 150,
    SpaceSurface     = 151,
    SpaceVolume      = 152,
    SpaceMixed       = 153,
    SpaceDiscrete    = 154,
 
    // --- Orientation labels (one-hot from InvOrientationType) ---
    OrientUnknown    = 170,
    OrientFixed      = 171,
    OrientFree       = 172,
    OrientLoose      = 173,
 
    // --- Value-carrier tokens (paired with float in InvToken::value) ---
    Amplitude        = 200,     
    Vertex           = 201,     
    TimeVal          = 202,     
    FreqVal          = 203,     
    PosX             = 204,     
    PosY             = 205,     
    PosZ             = 206,     
    MomX             = 207,     
    MomY             = 208,     
    MomZ             = 209,     
    Goodness         = 210,     
    ChiSquared       = 211,     
    Correlation      = 212,     
    ConnValue        = 213,     
    GridIndex        = 214,     
 
    // --- Boolean tokens ---
    ValidTrue        = 250,
    ValidFalse       = 251,
    DirectedTrue     = 252,
    DirectedFalse    = 253,
 
    // --- Dimension tokens (carry size as int-in-float) ---
    NSources         = 280,     
    NTimes           = 281,     
    NGroups          = 282,     
    NDipoles         = 283,     
    NMeasures        = 284,     
    NIndices         = 285,     
    NFreeDof         = 286,     
    TStep            = 287,     
 
    // --- Connectivity-measure name tokens ---
    MeasCoh          = 300,
    MeasImCoh        = 301,
    MeasPlv          = 302,
    MeasPli          = 303,
    MeasWpli         = 304,
    MeasGranger      = 305,
    MeasPdc          = 306,
    MeasDtf          = 307,
    MeasCorrelation  = 308,
    MeasCrossCorr    = 309,
    MeasOther        = 310,     
 
    // --- Quantization bin base (for fully discrete tokenisation) ---
    QuantBinBase     = 1000     
};
 
//=============================================================================================================
struct InvToken
{
    InvTokenId id;      
    float      value;   
 
    InvToken() : id(InvTokenId::Pad), value(0.0f) {}
    explicit InvToken(InvTokenId _id) : id(_id), value(0.0f) {}
    InvToken(InvTokenId _id, float _val) : id(_id), value(_val) {}
};
 
//=============================================================================================================
struct InvTokenizeOptions
{
    bool includeGridData     = true;   
    bool includeCouplings    = true;   
    bool includeFocalDipoles = true;   
    bool includeConnectivity = true;   
    bool includePositions    = true;   
    int  maxSources          = -1;     
    int  maxTimePoints       = -1;     
};
 
//=============================================================================================================
inline std::vector<int32_t> tokenIds(const std::vector<InvToken>& tokens)
{
    std::vector<int32_t> ids(tokens.size());
    for (size_t i = 0; i < tokens.size(); ++i)
        ids[i] = static_cast<int32_t>(tokens[i].id);
    return ids;
}
 
//=============================================================================================================
inline std::vector<float> tokenValues(const std::vector<InvToken>& tokens)
{
    std::vector<float> vals(tokens.size());
    for (size_t i = 0; i < tokens.size(); ++i)
        vals[i] = tokens[i].value;
    return vals;
}
 
} // NAMESPACE INVLIB
 
#endif // INV_TOKEN_H