fiff_constants.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef FIFF_CONSTANTS_H
#define FIFF_CONSTANTS_H
 
//=============================================================================================================
// DEFINE NAMESPACE FIFFLIB
//=============================================================================================================
 
namespace FIFFLIB
{
 
//=============================================================================================================
// FIFF constants
//=============================================================================================================
 
#define FIFFC_FAIL -1
#define FIFFC_OK 0
 
#define FIFFV_TRUE 1
#define FIFFV_FALSE 0
 
/* Compatibility definitions */
 
#define FIFF_FAIL -1
#define FIFF_OK 0
 
 
/*
 * Quaternion channels for head position monitoring
 */
#define FIFFV_QUAT_0 700  
#define FIFFV_QUAT_1 701  
#define FIFFV_QUAT_2 702  
#define FIFFV_QUAT_3 703  
#define FIFFV_QUAT_4 704  
#define FIFFV_QUAT_5 705  
#define FIFFV_QUAT_6 706  
#define FIFFV_HPI_G 707   
#define FIFFV_HPI_ERR 708 
#define FIFFV_HPI_MOV 709 
 
#define FIFFM_QUAT_CH(X) ((X >= FIFFV_QUAT_0) && (X <= FIFFV_HPI_MOV)) /* Check for a quaternion channel */
 
#define FIFFV_DIPOLE_WAVE_CH 1000  /* Dipole time curve */
#define FIFFV_GOODNESS_FIT_CH 1001 /* Goodness of fit */
 
#define FIFFM_CHPOS(x) &((x)->chpos)
 
/*
 * Units of measurement
 */
#define FIFF_UNIT_NONE -1
 
/*
 * SI base units
 */
#define FIFF_UNIT_M 1
#define FIFF_UNIT_KG 2
#define FIFF_UNIT_SEC 3
#define FIFF_UNIT_A 4
#define FIFF_UNIT_K 5
#define FIFF_UNIT_MOL 6
 
/*
 * SI Supplementary units
 */
#define FIFF_UNIT_RAD 7
#define FIFF_UNIT_SR 8
 
/*
 * SI base candela
 */
#define FIFF_UNIT_CD 9
 
/*
 * SI derived units
 */
#define FIFF_UNIT_HZ 101
#define FIFF_UNIT_N 102
#define FIFF_UNIT_PA 103
#define FIFF_UNIT_J 104
#define FIFF_UNIT_W 105
#define FIFF_UNIT_C 106
#define FIFF_UNIT_V 107
#define FIFF_UNIT_F 108
#define FIFF_UNIT_OHM 109
#define FIFF_UNIT_MHO 110
#define FIFF_UNIT_WB 111
#define FIFF_UNIT_T 112
#define FIFF_UNIT_H 113
#define FIFF_UNIT_CEL 114
#define FIFF_UNIT_LM 115
#define FIFF_UNIT_LX 116
 
/*
 * Others we need
 */
#define FIFF_UNIT_T_M 201   /* T/m */
#define FIFF_UNIT_AM 202    /* Am  */
#define FIFF_UNIT_AM_M2 203 /* Am/m^2  */
#define FIFF_UNIT_AM_M3 204 /* Am/m^3  */
 
/*
 * Multipliers
 */
#define FIFF_UNITM_E 18
#define FIFF_UNITM_PET 15
#define FIFF_UNITM_T 12
#define FIFF_UNITM_MEG 6
#define FIFF_UNITM_K 3
#define FIFF_UNITM_H 2
#define FIFF_UNITM_DA 1
#define FIFF_UNITM_NONE 0
#define FIFF_UNITM_D -1
#define FIFF_UNITM_C -2
#define FIFF_UNITM_M -3
#define FIFF_UNITM_MU -6
#define FIFF_UNITM_N -9
#define FIFF_UNITM_P -12
#define FIFF_UNITM_F -15
#define FIFF_UNITM_A -18
 
/*
 * Coil types
 */
#define FIFFV_COIL_NONE 0                          
#define FIFFV_COIL_EEG 1                           
#define FIFFV_COIL_NM_122 2                        
#define FIFFV_COIL_NM_24 3                         
#define FIFFV_COIL_NM_MCG_AXIAL 4                  
#define FIFFV_COIL_EEG_BIPOLAR 5                   
#define FIFFV_COIL_DIPOLE 200                      
#define FIFFV_COIL_MCG_42 1000                     
#define FIFFV_COIL_POINT_MAGNETOMETER 2000         
#define FIFFV_COIL_AXIAL_GRAD_5CM 2001             
#define FIFFV_COIL_VV_PLANAR_W 3011                
#define FIFFV_COIL_VV_PLANAR_T1 3012               
#define FIFFV_COIL_VV_PLANAR_T2 3013               
#define FIFFV_COIL_VV_PLANAR_T3 3014               
#define FIFFV_COIL_VV_MAG_W 3021                   
#define FIFFV_COIL_VV_MAG_T1 3022                  
#define FIFFV_COIL_VV_MAG_T2 3023                  
#define FIFFV_COIL_VV_MAG_T3 3024                  
#define FIFFV_COIL_MAGNES_MAG 4001                 
#define FIFFV_COIL_MAGNES_GRAD 4002                
#define FIFFV_COIL_CTF_GRAD 5001                   
#define FIFFV_COIL_CTF_REF_MAG 5002                
#define FIFFV_COIL_CTF_REF_GRAD 5003               
#define FIFFV_COIL_CTF_REF_GOFF 5004               
#define FIFFV_COIL_KIT_GRAD 6001                   
#define FIFFV_COIL_KIT_REF_GRAD 6002               
#define FIFFV_COIL_BABY_GRAD 7001                  
#define FIFFV_COIL_BABY_MAG 7002                   
#define FIFFV_COIL_BABY_REF_MAG 7003               
#define FIFFV_COIL_BABY_REF_MAG2 7004              
#define FIFFV_COIL_ARTEMIS123_GRAD 7501            
#define FIFFV_COIL_ARTEMIS123_REF_MAG 7502         
#define FIFFV_COIL_ARTEMIS123_REF_GRAD 7503        
#define FIFFV_COIL_QUSPIN_ZFOPM_MAG 8001           
#define FIFFV_COIL_KRISS_GRAD 9001                 
#define FIFFV_COIL_COMPUMEDICS_ADULT_GRAD 9101     
#define FIFFV_COIL_COMPUMEDICS_PEDIATRIC_GRAD 9102 
 
#define FIFFM_IS_VV_COIL(c) ((c) / 1000 == 3)
 
/*
 * These are the cardinal points for MCG data
 * Left and right are supposed to be located below the sternum point
 */
#define FIFFV_POINT_CHEST_LEFT 1
#define FIFFV_POINT_CHEST_STERNUM 2
#define FIFFV_POINT_CHEST_RIGHT 3
 
/*
 * Coordinate transformation descriptor
 */
#define FIFFV_COORD_UNKNOWN 0
#define FIFFV_COORD_DEVICE 1
#define FIFFV_COORD_ISOTRAK 2
#define FIFFV_COORD_HPI 3
#define FIFFV_COORD_HEAD 4
#define FIFFV_COORD_MRI 5
#define FIFFV_COORD_MRI_SLICE 6
#define FIFFV_COORD_MRI_DISPLAY 7
#define FIFFV_COORD_XRAY FIFF_COORD_MRI
#define FIFFV_COORD_XRAY_SLICE FIFF_COORD_MRI_SLICE
#define FIFFV_COORD_CT FIFF_COORD_MRI
#define FIFFV_COORD_CT_SLICE FIFF_COORD_MRI_SLICE
 
#define FIFFV_COORD_DICOM_DEVICE 8
#define FIFFV_COORD_IMAGING_DEVICE 9
 
#define FIFFV_COORD_TORSO 100
 
#define FIFFV_MOVE 1
#define FIFFV_NO_MOVE 0
 
/*
 * Artefact removal parameters
 */
#define FIFFV_ARTEF_MAX 100
#define FIFFV_ARTEF_NONE -1
#define FIFFV_ARTEF_KEEP 0
#define FIFFV_ARTEF_JUMP 1
#define FIFFV_ARTEF_NOJUMP 2
 
/*
 * The layered sphere model
 */
#define FIFFV_LAYER_BRAIN 1
#define FIFFV_LAYER_CSF 2
#define FIFFV_LAYER_SKULL 3
#define FIFFV_LAYER_HEAD 4
 
#define FIFFV_XFIT_MAP_SURF_SENSORS 0 
#define FIFFV_XFIT_MAP_SURF_HEAD 1    
#define FIFFV_XFIT_MAP_SURF_SPHERE 2  
 
/*
 * Pointers
 */
#define FIFFV_NEXT_SEQ 0
#define FIFFV_NEXT_NONE -1
 
/*
 * Channel types
 */
#define FIFFV_MAGN_CH 1
#define FIFFV_EL_CH 2
#define FIFFV_MEG_CH FIFFV_MAGN_CH
#define FIFFV_MCG_CH 201
#define FIFFV_REF_MEG_CH 301 
#define FIFFV_EEG_CH FIFFV_EL_CH
#define FIFFV_STIM_CH 3
 
#define FIFFV_EOG_CH 202
#define FIFFV_EMG_CH 302
#define FIFFV_ECG_CH 402
#define FIFFV_MISC_CH 502
#define FIFFV_RESP_CH 602         
#define FIFFV_BIO_CH 102          
#define FIFFV_SYST_CH 900         
#define FIFFV_IAS_CH 910          
#define FIFFV_EXCI_CH 920         
#define FIFFV_FNIRS_CH 1100       
#define FIFFV_TEMPERATURE_CH 1200 
#define FIFFV_GALVANIC_CH 1300    
#define FIFFV_EYETRACK_CH 1400    
 
/*
 * Intracranial EEG channel types (FIFF standard, as written by mne-python); their coil type is FIFFV_COIL_EEG
 */
#define FIFFV_ECOG_CH 902 
#define FIFFV_SEEG_CH 802 
#define FIFFV_DBS_CH 803  
 
/*
 * Coil types that distinguish EEG, fNIRS and eye-tracking channel types
 */
#define FIFFV_COIL_EEG_CSD 6                      
#define FIFFV_COIL_FNIRS_HBO 300                  
#define FIFFV_COIL_FNIRS_HBR 301                  
#define FIFFV_COIL_FNIRS_CW_AMPLITUDE 302         
#define FIFFV_COIL_FNIRS_OD 303                   
#define FIFFV_COIL_FNIRS_FD_AC_AMPLITUDE 304      
#define FIFFV_COIL_FNIRS_FD_PHASE 305             
#define FIFFV_COIL_FNIRS_TD_GATED_AMPLITUDE 306   
#define FIFFV_COIL_FNIRS_TD_MOMENTS_INTENSITY 307 
#define FIFFV_COIL_FNIRS_TD_MOMENTS_MEAN 308      
#define FIFFV_COIL_FNIRS_TD_MOMENTS_VARIANCE 309  
#define FIFFV_COIL_EYETRACK_POS 400               
#define FIFFV_COIL_EYETRACK_PUPIL 401             
 
/*
 * More of those defined in MNE
 */
#define FIFFV_MNE_SURF_UNKNOWN -1
#define FIFFV_MNE_SURF_LEFT_HEMI 101
#define FIFFV_MNE_SURF_RIGHT_HEMI 102
 
/*
 * These relate to the Isotrak data
 */
#define FIFFV_POINT_CARDINAL 1
#define FIFFV_POINT_HPI 2
#define FIFFV_POINT_EEG 3
#define FIFFV_POINT_ECG FIFFV_POINT_EEG
#define FIFFV_POINT_EXTRA 4
 
#define FIFFV_POINT_LPA 1
#define FIFFV_POINT_NASION 2
#define FIFFV_POINT_RPA 3
 
/*
 * These are the MNE fiff definitions
 */
#define FIFFB_MNE 350
#define FIFFB_MNE_SOURCE_SPACE 351
#define FIFFB_MNE_FORWARD_SOLUTION 352
#define FIFFB_MNE_PARENT_MRI_FILE 353
#define FIFFB_MNE_PARENT_MEAS_FILE 354
#define FIFFB_MNE_COV 355
#define FIFFB_MNE_INVERSE_SOLUTION 356
#define FIFFB_MNE_NAMED_MATRIX 357
#define FIFFB_MNE_ENV 358
#define FIFFB_MNE_BAD_CHANNELS 359
#define FIFFB_MNE_VERTEX_MAP 360
#define FIFFB_MNE_EVENTS 361
#define FIFFB_MNE_MORPH_MAP 362
 
/*
 * CTF compensation data
 */
#define FIFFB_MNE_CTF_COMP 370
#define FIFFB_MNE_CTF_COMP_DATA 371
#define FIFFB_MNE_DERIVATIONS 372
 
/*
 * Fiff tags associated with MNE computations (3500...)
 * 3500... Bookkeeping
 */
#define FIFF_MNE_ROW_NAMES 3502
#define FIFF_MNE_COL_NAMES 3503
#define FIFF_MNE_NROW 3504
#define FIFF_MNE_NCOL 3505
#define FIFF_MNE_COORD_FRAME 3506 
//FIFFB_MNE_SOURCE_SPACE   #define FIFFV_COORD_MRI
//FIFFB_MNE_FORWARD_SOLUTION   FIFFV_COORD_HEAD
//FIFFB_MNE_INVERSE_SOLUTION   FIFFV_COORD_HEAD
#define FIFF_MNE_CH_NAME_LIST 3507
#define FIFF_MNE_FILE_NAME 3508 
 
/*
 * 3510... 3590... Source space or surface
 */
#define FIFF_MNE_SOURCE_SPACE_POINTS 3510       
#define FIFF_MNE_SOURCE_SPACE_NORMALS 3511      
#define FIFF_MNE_SOURCE_SPACE_NPOINTS 3512      
#define FIFF_MNE_SOURCE_SPACE_SELECTION 3513    
#define FIFF_MNE_SOURCE_SPACE_NUSE 3514         
#define FIFF_MNE_SOURCE_SPACE_NEAREST 3515      
#define FIFF_MNE_SOURCE_SPACE_NEAREST_DIST 3516 
#define FIFF_MNE_SOURCE_SPACE_ID 3517           
#define FIFF_MNE_SOURCE_SPACE_TYPE 3518         
 
#define FIFF_MNE_SOURCE_SPACE_NTRI 3590          
#define FIFF_MNE_SOURCE_SPACE_TRIANGLES 3591     
#define FIFF_MNE_SOURCE_SPACE_NUSE_TRI 3592      
#define FIFF_MNE_SOURCE_SPACE_USE_TRIANGLES 3593 
 
#define FIFF_MNE_SOURCE_SPACE_VOXEL_DIMS 3596   
#define FIFF_MNE_SOURCE_SPACE_INTERPOLATOR 3597 
#define FIFF_MNE_SOURCE_SPACE_MRI_FILE 3598     
 
#define FIFF_MNE_SOURCE_SPACE_DIST 3599       
#define FIFF_MNE_SOURCE_SPACE_DIST_LIMIT 3600 
 
/*
 * 3520... Forward solution
 */
#define FIFF_MNE_FORWARD_SOLUTION 3520
#define FIFF_MNE_SOURCE_ORIENTATION 3521 
#define FIFF_MNE_INCLUDED_METHODS 3522
#define FIFF_MNE_FORWARD_SOLUTION_GRAD 3523
 
/*
 * 3530... Covariance matrix
 */
#define FIFF_MNE_COV_KIND 3530        
#define FIFF_MNE_COV_DIM 3531         
#define FIFF_MNE_COV 3532             
#define FIFF_MNE_COV_DIAG 3533        
#define FIFF_MNE_COV_EIGENVALUES 3534 
#define FIFF_MNE_COV_EIGENVECTORS 3535
#define FIFF_MNE_COV_NFREE 3536 
 
/*
 * 3540... Inverse operator
 * We store the inverse operator as the eigenleads  eigenfields and weights
 */
#define FIFF_MNE_INVERSE_LEADS 3540               
#define FIFF_MNE_INVERSE_LEADS_WEIGHTED 3546      
#define FIFF_MNE_INVERSE_FIELDS 3541              
#define FIFF_MNE_INVERSE_SING 3542                
#define FIFF_MNE_INVERSE_SOURCE_UNIT 3547         
#define FIFF_MNE_PRIORS_USED 3543                 
#define FIFF_MNE_INVERSE_FULL 3544                
                                                  // This matrix includes the whitening operator as well
                                                  // The regularization is applied
#define FIFF_MNE_INVERSE_SOURCE_ORIENTATIONS 3545 
                                                  // The source orientations must be expressed in the coordinate system
                                                  // given by FIFF_MNE_COORD_FRAME
 
/*
 * 3550... Saved environment info
 */
#define FIFF_MNE_ENV_WORKING_DIR 3550  
#define FIFF_MNE_ENV_COMMAND_LINE 3551 
 
/*
 * 3560... Miscellaneous
 */
#define FIFF_MNE_PROJ_ITEM_ACTIVE 3560   
#define FIFF_MNE_EVENT_LIST 3561         
#define FIFF_MNE_EVENT_TRIGGER_MASK 3565 
#define FIFF_MNE_EVENT_COMMENTS 3566     
#define FIFF_MNE_HEMI 3562               
 
/*
 * 3570... Morphing maps
 */
#define FIFF_MNE_MORPH_MAP 3570      
#define FIFF_MNE_MORPH_MAP_FROM 3571 
#define FIFF_MNE_MORPH_MAP_TO 3572   
 
/*
 * 3580... CTF compensation data
 */
#define FIFF_MNE_CTF_COMP_KIND 3580       
#define FIFF_MNE_CTF_COMP_DATA 3581       
#define FIFF_MNE_CTF_COMP_CALIBRATED 3582 
#define FIFF_MNE_DERIVATION_DATA 3585     
 
/*
 * 3700... Real-Time Communication
 */
#define FIFF_MNE_RT_COMMAND 3700   
#define FIFF_MNE_RT_CLIENT_ID 3701 
 
/*
 * 3710... Real-Time Blocks
 */
#define FIFFB_MNE_RT_MEAS_INFO 3710 
 
/*
 * Fiff values associated with MNE computations
 */
#define FIFFV_MNE_FIXED_ORI 1
#define FIFFV_MNE_FREE_ORI 2
 
#define FIFFV_MNE_MEG 1
#define FIFFV_MNE_EEG 2
#define FIFFV_MNE_MEG_EEG 3
 
#define FIFFV_MNE_UNKNOWN_COV 0
#define FIFFV_MNE_SENSOR_COV 1
#define FIFFV_MNE_NOISE_COV 1 
#define FIFFV_MNE_SOURCE_COV 2
#define FIFFV_MNE_FMRI_PRIOR_COV 3
#define FIFFV_MNE_SIGNAL_COV 4       
#define FIFFV_MNE_DEPTH_PRIOR_COV 5  
#define FIFFV_MNE_ORIENT_PRIOR_COV 6 
 
/*
 * Source space types (values of FIFF_MNE_SOURCE_SPACE_TYPE)
 */
#define FIFFV_MNE_SPACE_UNKNOWN -1
#define FIFFV_MNE_SPACE_SURFACE 1
#define FIFFV_MNE_SPACE_VOLUME 2
#define FIFFV_MNE_SPACE_DISCRETE 3
 
/*
 * Covariance matrix channel classification
 */
#define FIFFV_MNE_COV_CH_UNKNOWN -1 
#define FIFFV_MNE_COV_CH_MEG_MAG 0  
#define FIFFV_MNE_COV_CH_MEG_GRAD 1 
#define FIFFV_MNE_COV_CH_EEG 2      
 
/*
 * Projection item kinds
 */
#define FIFFV_MNE_PROJ_ITEM_EEG_AVREF 10
 
/*
 * Additional coordinate frames
 */
#define FIFFV_MNE_COORD_TUFTS_EEG 300   
#define FIFFV_MNE_COORD_CTF_DEVICE 1001 
#define FIFFV_MNE_COORD_CTF_HEAD 1004   
#define FIFFV_MNE_COORD_MRI_VOXEL 2001  
#define FIFFV_MNE_COORD_RAS 2002        
#define FIFFV_MNE_COORD_MNI_TAL 2003    
#define FIFFV_MNE_COORD_FS_TAL_GTZ 2004 
#define FIFFV_MNE_COORD_FS_TAL_LTZ 2005 
#define FIFFV_MNE_COORD_FS_TAL 2006     
} // NAMESPACE
 
#endif // FIFF_CONSTANTS_H