MNE-CPP  beta 1.0
fiff_constants.h
Go to the documentation of this file.
1 //=============================================================================================================
36 #ifndef FIFF_CONSTANTS_H
37 #define FIFF_CONSTANTS_H
38 
39 //*************************************************************************************************************
40 //=============================================================================================================
41 // DEFINE NAMESPACE FIFFLIB
42 //=============================================================================================================
43 
44 namespace FIFFLIB
45 {
46 
47 //*************************************************************************************************************
48 //=============================================================================================================
49 // FIFF constants
50 //=============================================================================================================
51 
52 #define FIFFC_FAIL -1
53 #define FIFFC_OK 0
54 
55 #define FIFFV_TRUE 1
56 #define FIFFV_FALSE 0
57 
58 /* Compatibility definitions */
59 
60 #define FIFF_FAIL -1
61 #define FIFF_OK 0
62 
63 #define FIFFV_NEXT_SEQ 0
64 #define FIFFV_NEXT_NONE -1
65 
66 #define FIFFC_TAG_INFO_SIZE (sizeof(fiffTag) - sizeof(fiff_data_t *))
67 #define FIFFC_DATA_OFFSET FIFFC_TAG_INFO_SIZE
68 #define FIFFM_TAG_INFO(x) &((x)->kind)
69 
70 
71 
72 #define FIFFV_MAGN_CH 1
73 #define FIFFV_EL_CH 2
74 #define FIFFV_MCG_CH 201
75 #define FIFFV_STIM_CH 3
76 
77 #define FIFFV_EOG_CH 202
78 #define FIFFV_EMG_CH 302
79 #define FIFFV_ECG_CH 402
80 #define FIFFV_MISC_CH 502
81 #define FIFFV_RESP_CH 602 /* Respiration monitoring */
82 /*
83 * Quaternion channels for head position monitoring
84 */
85 #define FIFFV_QUAT_0 700 /* Quaternion parameter q0; obsolete for unit quaternion */
86 #define FIFFV_QUAT_1 701 /* Quaternion parameter q1; rotation */
87 #define FIFFV_QUAT_2 702 /* Quaternion parameter q2; rotation */
88 #define FIFFV_QUAT_3 703 /* Quaternion parameter q3; rotation */
89 #define FIFFV_QUAT_4 704 /* Quaternion parameter q4; translation */
90 #define FIFFV_QUAT_5 705 /* Quaternion parameter q5; translation */
91 #define FIFFV_QUAT_6 706 /* Quaternion parameter q6; translation */
92 #define FIFFV_HPI_G 707 /* Goodness-of-fit in continuous hpi */
93 #define FIFFV_HPI_ERR 708 /* Estimation error in continuous hpi */
94 #define FIFFV_HPI_MOV 709 /* Estimated head movement speed in continuous hpi */
95 
96 #define FIFFM_QUAT_CH(X) ((X >= FIFFV_QUAT_0) && (X <= FIFFV_HPI_MOV)) /* Check for a quaternion channel */
97 
98 #define FIFFV_DIPOLE_WAVE_CH 1000 /* Dipole time curve */
99 #define FIFFV_GOODNESS_FIT_CH 1001 /* Goodness of fit */
100 
101 
102 #define FIFFM_CHPOS(x) &((x)->chpos)
103 
104 /*
105 * Units of measurement
106 */
107 
108 #define FIFF_UNIT_NONE -1
109 /*
110 * 1. SI base units
111 */
112 #define FIFF_UNIT_M 1
113 #define FIFF_UNIT_KG 2
114 #define FIFF_UNIT_SEC 3
115 #define FIFF_UNIT_A 4
116 #define FIFF_UNIT_K 5
117 #define FIFF_UNIT_MOL 6
118 /*
119 * 2. SI Supplementary units
120 */
121 #define FIFF_UNIT_RAD 7
122 #define FIFF_UNIT_SR 8
123 /*
124 * 1. SI base candela
125 */
126 #define FIFF_UNIT_CD 9
127 /*
128 * 3. SI derived units
129 */
130 #define FIFF_UNIT_HZ 101
131 #define FIFF_UNIT_N 102
132 #define FIFF_UNIT_PA 103
133 #define FIFF_UNIT_J 104
134 #define FIFF_UNIT_W 105
135 #define FIFF_UNIT_C 106
136 #define FIFF_UNIT_V 107
137 #define FIFF_UNIT_F 108
138 #define FIFF_UNIT_OHM 109
139 #define FIFF_UNIT_MHO 110
140 #define FIFF_UNIT_WB 111
141 #define FIFF_UNIT_T 112
142 #define FIFF_UNIT_H 113
143 #define FIFF_UNIT_CEL 114
144 #define FIFF_UNIT_LM 115
145 #define FIFF_UNIT_LX 116
146 /*
147 * 4. Others we need
148 */
149 #define FIFF_UNIT_T_M 201 /* T/m */
150 #define FIFF_UNIT_AM 202 /* Am */
151 /*
152 * 5. Multipliers
153 */
154 #define FIFF_UNITM_E 18
155 #define FIFF_UNITM_PET 15
156 #define FIFF_UNITM_T 12
157 #define FIFF_UNITM_MEG 6
158 #define FIFF_UNITM_K 3
159 #define FIFF_UNITM_H 2
160 #define FIFF_UNITM_DA 1
161 #define FIFF_UNITM_NONE 0
162 #define FIFF_UNITM_D -1
163 #define FIFF_UNITM_C -2
164 #define FIFF_UNITM_M -3
165 #define FIFF_UNITM_MU -6
166 #define FIFF_UNITM_N -9
167 #define FIFF_UNITM_P -12
168 #define FIFF_UNITM_F -15
169 #define FIFF_UNITM_A -18
170 
171 
172 /*
173 * Coil types
174 */
175 
176 /* \def FIFFV_COIL_NONE */
177 
178 #define FIFFV_COIL_NONE 0
179 #define FIFFV_COIL_EEG 1
180 #define FIFFV_COIL_NM_122 2
181 #define FIFFV_COIL_NM_24 3
182 #define FIFFV_COIL_NM_MCG_AXIAL 4
183 #define FIFFV_COIL_EEG_BIPOLAR 5
185 #define FIFFV_COIL_DIPOLE 200
188 #define FIFFV_COIL_MCG_42 1000
190 #define FIFFV_COIL_POINT_MAGNETOMETER 2000
191 #define FIFFV_COIL_AXIAL_GRAD_5CM 2001
193 #define FIFFV_COIL_VV_PLANAR_W 3011
194 #define FIFFV_COIL_VV_PLANAR_T1 3012
195 #define FIFFV_COIL_VV_PLANAR_T2 3013
196 #define FIFFV_COIL_VV_PLANAR_T3 3014
197 #define FIFFV_COIL_VV_MAG_W 3021
198 #define FIFFV_COIL_VV_MAG_T1 3022
199 #define FIFFV_COIL_VV_MAG_T2 3023
200 #define FIFFV_COIL_VV_MAG_T3 3024
202 #define FIFFV_COIL_MAGNES_MAG 4001
203 #define FIFFV_COIL_MAGNES_GRAD 4002
204 #define FIFFV_COIL_CTF_GRAD 5001
207 /*
208  * BabySQUID sensors
209  */
210 #define FIFFV_COIL_BABY_GRAD 7001
211 #define FIFFV_COIL_BABY_MAG 7002
212 #define FIFFV_COIL_BABY_REF_MAG 7003
213 #define FIFFV_COIL_BABY_REF_MAG2 7004
215 // * BabyMEG sensors --- added by Limin ---
217 // */
218 //#define FIFFV_COIL_BABY_INLAYER_MAG 7002 /**< babyMEG inlayer magnetometer */
219 //#define FIFFV_COIL_BABY_OUTLAYER_MAG 7003 /**< babyMEG outlayer magnetometer */
220 //#define FIFFV_COIL_BABY_REF_MAG 7004
221 
222 
223 #define FIFFM_IS_VV_COIL(c) ((c)/1000 == 3)
224 
225 #define FIFFV_POINT_CARDINAL 1
226 #define FIFFV_POINT_HPI 2
227 #define FIFFV_POINT_EEG 3
228 #define FIFFV_POINT_EXTRA 4
229 
230 #define FIFFV_POINT_LPA 1
231 #define FIFFV_POINT_NASION 2
232 #define FIFFV_POINT_RPA 3
233 /*
234 * These are the cardinal points for MCG data
235 * Left and right are supposed to be located below the sternum point
236 */
237 #define FIFFV_POINT_CHEST_LEFT 1
238 #define FIFFV_POINT_CHEST_STERNUM 2
239 #define FIFFV_POINT_CHEST_RIGHT 3
240 
243 #define FIFFV_COORD_UNKNOWN 0
244 #define FIFFV_COORD_DEVICE 1
245 #define FIFFV_COORD_ISOTRAK 2
246 #define FIFFV_COORD_HPI 3
247 #define FIFFV_COORD_HEAD 4
248 #define FIFFV_COORD_MRI 5
249 #define FIFFV_COORD_MRI_SLICE 6
250 #define FIFFV_COORD_MRI_DISPLAY 7
251 #define FIFFV_COORD_XRAY FIFF_COORD_MRI
252 #define FIFFV_COORD_XRAY_SLICE FIFF_COORD_MRI_SLICE
253 #define FIFFV_COORD_CT FIFF_COORD_MRI
254 #define FIFFV_COORD_CT_SLICE FIFF_COORD_MRI_SLICE
255 
256 #define FIFFV_COORD_DICOM_DEVICE 8
257 #define FIFFV_COORD_IMAGING_DEVICE 9
258 
259 #define FIFFV_COORD_TORSO 100
260 
261 #define FIFFV_MOVE 1
262 #define FIFFV_NO_MOVE 0
263 /*
264 * Artefact removal parameters
265 */
266 #define FIFFV_ARTEF_MAX 100
267 #define FIFFV_ARTEF_NONE -1
268 #define FIFFV_ARTEF_KEEP 0
269 #define FIFFV_ARTEF_JUMP 1
270 #define FIFFV_ARTEF_NOJUMP 2
271 
272 /*
273 * The layered sphere model
274 */
275 
276 #define FIFFV_LAYER_BRAIN 1
277 #define FIFFV_LAYER_CSF 2
278 #define FIFFV_LAYER_SKULL 3
279 #define FIFFV_LAYER_HEAD 4
280 
281 #define FIFFV_XFIT_MAP_SURF_SENSORS 0
282 #define FIFFV_XFIT_MAP_SURF_HEAD 1
283 #define FIFFV_XFIT_MAP_SURF_SPHERE 2
285 //
286 // Blocks - Standard tags used in all blocks
287 //
288 #define FIFFB_MEAS 100
289 #define FIFFB_MEAS_INFO 101
290 #define FIFFB_RAW_DATA 102
291 #define FIFFB_PROCESSED_DATA 103
292 #define FIFFB_CONTINUOUS_DATA 112
293 #define FIFFB_EVOKED 104
294 #define FIFFB_ASPECT 105
295 #define FIFFB_SUBJECT 106
296 #define FIFFB_ISOTRAK 107
297 #define FIFFB_HPI_MEAS 108
298 #define FIFFB_HPI_RESULT 109
299 #define FIFFB_DACQ_PARS 117
300 #define FIFFB_REF 118
301 #define FIFFB_SMSH_RAW_DATA 119
302 #define FIFFB_SMSH_ASPECT 120
303 #define FIFFB_BEM 310
304 #define FIFFB_BEM_SURF 311
305 #define FIFFB_PROJ 313
306 #define FIFFB_PROJ_ITEM 314
307 #define FIFFB_MRI 200
308 #define FIFFB_MRI_SET 201
309 #define FIFFB_MRI_SLICE 202
310 #define FIFFB_PROCESSING_HISTORY 900
311 #define FIFFB_SSS_INFO 502
312 #define FIFFB_SSS_CAL_ADJUST 503
313 #define FIFFB_SSS_ST_INFO 504
314 #define FIFFB_SSS_BASES 505
315 //
316 // Of general interest
317 //
318 #define FIFF_FILE_ID 100
319 #define FIFF_DIR_POINTER 101
320 #define FIFF_BLOCK_ID 103
321 #define FIFF_BLOCK_START 104
322 #define FIFF_BLOCK_END 105
323 #define FIFF_FREE_LIST 106
324 #define FIFF_FREE_BLOCK 107
325 #define FIFF_NOP 108
326 #define FIFF_PARENT_FILE_ID 109
327 #define FIFF_PARENT_BLOCK_ID 110
328 #define FIFF_BLOCK_NAME 111
329 #define FIFF_BLOCK_VERSION 112
330 #define FIFF_CREATOR 113 /* Program that created the file (string) */
331 #define FIFF_MODIFIER 114 /* Program that modified the file (string) */
332 
333 #define FIFF_REF_ROLE 115
334 #define FIFF_REF_FILE_ID 116
335 #define FIFF_REF_FILE_NUM 117
336 #define FIFF_REF_FILE_NAME 118
337 /* reserverd 119 */
338 #define FIFF_REF_BLOCK_ID 120
339 //
340 // Megacq saves the parameters in these tags
341 //
342 #define FIFF_DACQ_PARS 150
343 #define FIFF_DACQ_STIM 151
344 
345 #define FIFF_SFREQ 201
346 #define FIFF_NCHAN 200
347 #define FIFF_DATA_PACK 202
348 #define FIFF_CH_INFO 203
349 #define FIFF_MEAS_DATE 204
350 #define FIFF_SUBJECT 205
351 #define FIFF_COMMENT 206
352 #define FIFF_NAVE 207
353 #define FIFF_DIG_POINT 213
354 #define FIFF_HPI_NCOIL 216
355 #define FIFF_LOWPASS 219
356 #define FIFF_COORD_TRANS 222
357 #define FIFF_HIGHPASS 223
358 #define FIFF_NAME 233
359 #define FIFF_LINE_FREQ 235
360 #define FIFF_DESCRIPTION FIFF_COMMENT
361  //
362  // Pointers
363  //
364 #define FIFFV_NEXT_SEQ 0
365 #define FIFFV_NEXT_NONE -1
366  //
367  // Channel types
368  //
369 #define FIFFV_MEG_CH 1
370 #define FIFFV_REF_MEG_CH 301
371 #define FIFFV_EEG_CH 2
372 #define FIFFV_MCG_CH 201
373 #define FIFFV_STIM_CH 3
374 #define FIFFV_EOG_CH 202
375 #define FIFFV_EMG_CH 302
376 #define FIFFV_ECG_CH 402
377 #define FIFFV_MISC_CH 502
378 #define FIFFV_RESP_CH 602
379  //
380  // Quaternion channels for head position monitoring
381  //
382 #define FIFFV_QUAT_0 700
383 #define FIFFV_QUAT_1 701
384 #define FIFFV_QUAT_2 702
385 #define FIFFV_QUAT_3 703
386 #define FIFFV_QUAT_4 704
387 #define FIFFV_QUAT_5 705
388 #define FIFFV_QUAT_6 706
389 #define FIFFV_HPI_G 707
390 #define FIFFV_HPI_ERR 708
391 #define FIFFV_HPI_MOV 709
392  //
393  // Coordinate frames
394  //
395 #define FIFFV_COORD_UNKNOWN 0
396 #define FIFFV_COORD_DEVICE 1
397 #define FIFFV_COORD_ISOTRAK 2
398 #define FIFFV_COORD_HPI 3
399 #define FIFFV_COORD_HEAD 4
400 #define FIFFV_COORD_MRI 5
401 #define FIFFV_COORD_MRI_SLICE 6
402 #define FIFFV_COORD_MRI_DISPLAY 7
403 #define FIFFV_COORD_DICOM_DEVICE 8
404 #define FIFFV_COORD_IMAGING_DEVICE 9
405  //
406  // Needed for raw and evoked-response data
407  //
408 #define FIFF_FIRST_SAMPLE 208
409 #define FIFF_LAST_SAMPLE 209
410 #define FIFF_ASPECT_KIND 210
411 #define FIFF_DATA_BUFFER 300
412 #define FIFF_DATA_SKIP 301
413 #define FIFF_EPOCH 302
414 #define FIFF_DATA_SKIP_SAMP 303
416  //
417  // Different aspects of data
418  //
419 #define FIFFV_ASPECT_AVERAGE 100
420 #define FIFFV_ASPECT_STD_ERR 101
421 #define FIFFV_ASPECT_SINGLE 102
422 #define FIFFV_ASPECT_SUBAVERAGE 103
423 #define FIFFV_ASPECT_ALTAVERAGE 104
424 #define FIFFV_ASPECT_SAMPLE 105
425 #define FIFFV_ASPECT_POWER_DENSITY 106
426 #define FIFFV_ASPECT_DIPOLE_WAVE 200
428  //
429  // Conductor models
430  //
431 #define FIFF_BEM_SURF_ID 3101
432 #define FIFF_BEM_SURF_NAME 3102
433 #define FIFF_BEM_SURF_NNODE 3103
434 #define FIFF_BEM_SURF_NTRI 3104
435 #define FIFF_BEM_SURF_NODES 3105
436 #define FIFF_BEM_SURF_TRIANGLES 3106
437 #define FIFF_BEM_SURF_NORMALS 3107
438 #define FIFF_BEM_COORD_FRAME 3112
439 #define FIFF_BEM_SIGMA 3113
441  //
442  // BEM surface IDs
443  //
444 #define FIFFV_BEM_SURF_ID_UNKNOWN -1
445 #define FIFFV_BEM_SURF_ID_BRAIN 1
446 #define FIFFV_BEM_SURF_ID_SKULL 3
447 #define FIFFV_BEM_SURF_ID_HEAD 4
448 
449  //
450  // More of those defined in MNE
451  //
452 #define FIFFV_MNE_SURF_UNKNOWN -1
453 #define FIFFV_MNE_SURF_LEFT_HEMI 101
454 #define FIFFV_MNE_SURF_RIGHT_HEMI 102
455  //
456  // These relate to the Isotrak data
457  //
458 #define FIFFV_POINT_CARDINAL 1
459 #define FIFFV_POINT_HPI 2
460 #define FIFFV_POINT_EEG 3
461 #define FIFFV_POINT_ECG FIFFV_POINT_EEG
462 #define FIFFV_POINT_EXTRA 4
463 
464 #define FIFFV_POINT_LPA 1
465 #define FIFFV_POINT_NASION 2
466 #define FIFFV_POINT_RPA 3
467  //
468  // SSP
469  //
470 #define FIFF_PROJ_ITEM_KIND 3411
471 #define FIFF_PROJ_ITEM_TIME 3412
472 #define FIFF_PROJ_ITEM_NVEC 3414
473 #define FIFF_PROJ_ITEM_VECTORS 3415
474 #define FIFF_PROJ_ITEM_CH_NAME_LIST 3417
475  //
476  // MRIs
477  //
478 #define FIFF_MRI_SOURCE_PATH 1101
479 #define FIFF_MRI_SOURCE_FORMAT 2002
480 #define FIFF_MRI_PIXEL_ENCODING 2003
481 #define FIFF_MRI_PIXEL_DATA_OFFSET 2004
482 #define FIFF_MRI_PIXEL_SCALE 2005
483 #define FIFF_MRI_PIXEL_DATA 2006
484 #define FIFF_MRI_WIDTH 2010
485 #define FIFF_MRI_WIDTH_M 2011
486 #define FIFF_MRI_HEIGHT 2012
487 #define FIFF_MRI_HEIGHT_M 2013
488 #define FIFF_MRI_DEPTH 2014
489 #define FIFF_MRI_DEPTH_M 2015
490  //
491 #define FIFFV_MRI_PIXEL_BYTE 1
492 #define FIFFV_MRI_PIXEL_WORD 2
493 #define FIFFV_MRI_PIXEL_SWAP_WORD 3
494 #define FIFFV_MRI_PIXEL_FLOAT 4
495  //
496  // These are the MNE fiff definitions
497  //
498 #define FIFFB_MNE 350
499 #define FIFFB_MNE_SOURCE_SPACE 351
500 #define FIFFB_MNE_FORWARD_SOLUTION 352
501 #define FIFFB_MNE_PARENT_MRI_FILE 353
502 #define FIFFB_MNE_PARENT_MEAS_FILE 354
503 #define FIFFB_MNE_COV 355
504 #define FIFFB_MNE_INVERSE_SOLUTION 356
505 #define FIFFB_MNE_NAMED_MATRIX 357
506 #define FIFFB_MNE_ENV 358
507 #define FIFFB_MNE_BAD_CHANNELS 359
508 #define FIFFB_MNE_VERTEX_MAP 360
509 #define FIFFB_MNE_EVENTS 361
510 #define FIFFB_MNE_MORPH_MAP 362
511  //
512  // CTF compensation data
513  //
514 #define FIFFB_MNE_CTF_COMP 370
515 #define FIFFB_MNE_CTF_COMP_DATA 371
516  // Fiff tags associated with MNE computations (3500...)
518  //
519  //
520  // 3500... Bookkeeping
521  //
522 #define FIFF_MNE_ROW_NAMES 3502
523 #define FIFF_MNE_COL_NAMES 3503
524 #define FIFF_MNE_NROW 3504
525 #define FIFF_MNE_NCOL 3505
526 #define FIFF_MNE_COORD_FRAME 3506
527  //FIFFB_MNE_SOURCE_SPACE #define FIFFV_COORD_MRI
528  //FIFFB_MNE_FORWARD_SOLUTION FIFFV_COORD_HEAD
529  //FIFFB_MNE_INVERSE_SOLUTION FIFFV_COORD_HEAD
530 #define FIFF_MNE_CH_NAME_LIST 3507
531 #define FIFF_MNE_FILE_NAME 3508
532  //
533  // 3510... 3590... Source space or surface
534  //
535 #define FIFF_MNE_SOURCE_SPACE_POINTS 3510
536 #define FIFF_MNE_SOURCE_SPACE_NORMALS 3511
537 #define FIFF_MNE_SOURCE_SPACE_NPOINTS 3512
538 #define FIFF_MNE_SOURCE_SPACE_SELECTION 3513
539 #define FIFF_MNE_SOURCE_SPACE_NUSE 3514
540 #define FIFF_MNE_SOURCE_SPACE_NEAREST 3515
541 #define FIFF_MNE_SOURCE_SPACE_NEAREST_DIST 3516
542 #define FIFF_MNE_SOURCE_SPACE_ID 3517
543 #define FIFF_MNE_SOURCE_SPACE_TYPE 3518
545 #define FIFF_MNE_SOURCE_SPACE_NTRI 3590
546 #define FIFF_MNE_SOURCE_SPACE_TRIANGLES 3591
547 #define FIFF_MNE_SOURCE_SPACE_NUSE_TRI 3592
548 #define FIFF_MNE_SOURCE_SPACE_USE_TRIANGLES 3593
550 #define FIFF_MNE_SOURCE_SPACE_VOXEL_DIMS 3596
551 #define FIFF_MNE_SOURCE_SPACE_INTERPOLATOR 3597
552 #define FIFF_MNE_SOURCE_SPACE_MRI_FILE 3598
554 #define FIFF_MNE_SOURCE_SPACE_DIST 3599
555 #define FIFF_MNE_SOURCE_SPACE_DIST_LIMIT 3600
556  //
557  // 3520... Forward solution
558  //
559 #define FIFF_MNE_FORWARD_SOLUTION 3520
560 #define FIFF_MNE_SOURCE_ORIENTATION 3521
561 #define FIFF_MNE_INCLUDED_METHODS 3522
562 #define FIFF_MNE_FORWARD_SOLUTION_GRAD 3523
563  //
564  // 3530... Covariance matrix
565  //
566 #define FIFF_MNE_COV_KIND 3530
567 #define FIFF_MNE_COV_DIM 3531
568 #define FIFF_MNE_COV 3532
569 #define FIFF_MNE_COV_DIAG 3533
570 #define FIFF_MNE_COV_EIGENVALUES 3534
571 #define FIFF_MNE_COV_EIGENVECTORS 3535
572 #define FIFF_MNE_COV_NFREE 3536
573  //
574  // 3540... Inverse operator
575  //
576  // We store the inverse operator as the eigenleads eigenfields
577  // and weights
578  //
579 #define FIFF_MNE_INVERSE_LEADS 3540
580 #define FIFF_MNE_INVERSE_LEADS_WEIGHTED 3546
581 #define FIFF_MNE_INVERSE_FIELDS 3541
582 #define FIFF_MNE_INVERSE_SING 3542
583 #define FIFF_MNE_PRIORS_USED 3543
584 #define FIFF_MNE_INVERSE_FULL 3544
585  // This matrix includes the whitening operator as well
586  // The regularization is applied
587 #define FIFF_MNE_INVERSE_SOURCE_ORIENTATIONS 3545
588  // The source orientations must be expressed in the coordinate system
589  // given by FIFF_MNE_COORD_FRAME
590  //
591  // 3550... Saved environment info
592  //
593 #define FIFF_MNE_ENV_WORKING_DIR 3550
594 #define FIFF_MNE_ENV_COMMAND_LINE 3551
595  //
596  // 3560... Miscellaneous
597  //
598 #define FIFF_MNE_PROJ_ITEM_ACTIVE 3560
599 #define FIFF_MNE_EVENT_LIST 3561
600 #define FIFF_MNE_HEMI 3562
601  //
602  // 3570... Morphing maps
603  //
604 #define FIFF_MNE_MORPH_MAP 3570
605 #define FIFF_MNE_MORPH_MAP_FROM 3571
606 #define FIFF_MNE_MORPH_MAP_TO 3572
607  //
608  // 3580... CTF compensation data
609  //
610 #define FIFF_MNE_CTF_COMP_KIND 3580
611 #define FIFF_MNE_CTF_COMP_DATA 3581
612 #define FIFF_MNE_CTF_COMP_CALIBRATED 3582
615 //
616 // 3700... Real-Time Communication
617 //
618 #define FIFF_MNE_RT_COMMAND 3700
619 #define FIFF_MNE_RT_CLIENT_ID 3701
621 //
622 // 3710... Real-Time Blocks
623 //
624 #define FIFFB_MNE_RT_MEAS_INFO 3710
627 //
628 // Fiff values associated with MNE computations
629 //
630 #define FIFFV_MNE_FIXED_ORI 1
631 #define FIFFV_MNE_FREE_ORI 2
632 
633 #define FIFFV_MNE_MEG 1
634 #define FIFFV_MNE_EEG 2
635 #define FIFFV_MNE_MEG_EEG 3
636 
637 #define FIFFV_MNE_UNKNOWN_COV 0
638 #define FIFFV_MNE_SENSOR_COV 1
639 #define FIFFV_MNE_NOISE_COV 1
640 #define FIFFV_MNE_SOURCE_COV 2
641 #define FIFFV_MNE_FMRI_PRIOR_COV 3
642 #define FIFFV_MNE_SIGNAL_COV 4
643 #define FIFFV_MNE_DEPTH_PRIOR_COV 5
644 #define FIFFV_MNE_ORIENT_PRIOR_COV 6
645  //
646  // Source space types (values of FIFF_MNE_SOURCE_SPACE_TYPE)
647  //
648 #define FIFFV_MNE_SPACE_UNKNOWN -1
649 #define FIFFV_MNE_SPACE_SURFACE 1
650 #define FIFFV_MNE_SPACE_VOLUME 2
651 #define FIFFV_MNE_SPACE_DISCRETE 3
652  //
653  // Covariance matrix channel classification
654  //
655 #define FIFFV_MNE_COV_CH_UNKNOWN -1
656 #define FIFFV_MNE_COV_CH_MEG_MAG 0
657 #define FIFFV_MNE_COV_CH_MEG_GRAD 1
658 #define FIFFV_MNE_COV_CH_EEG 2
659  //
660  // Projection item kinds
661  //
662 #define FIFFV_PROJ_ITEM_NONE 0
663 #define FIFFV_PROJ_ITEM_FIELD 1
664 #define FIFFV_PROJ_ITEM_DIP_FIX 2
665 #define FIFFV_PROJ_ITEM_DIP_ROT 3
666 #define FIFFV_PROJ_ITEM_HOMOG_GRAD 4
667 #define FIFFV_PROJ_ITEM_HOMOG_FIELD 5
668 #define FIFFV_MNE_PROJ_ITEM_EEG_AVREF 10
669  //
670  // Additional coordinate frames
671  //
672 #define FIFFV_MNE_COORD_TUFTS_EEG 300
673 #define FIFFV_MNE_COORD_CTF_DEVICE 1001
674 #define FIFFV_MNE_COORD_CTF_HEAD 1004
675 #define FIFFV_MNE_COORD_MRI_VOXEL 2001
676 #define FIFFV_MNE_COORD_RAS 2002
677 #define FIFFV_MNE_COORD_MNI_TAL 2003
678 #define FIFFV_MNE_COORD_FS_TAL_GTZ 2004
679 #define FIFFV_MNE_COORD_FS_TAL_LTZ 2005
680 #define FIFFV_MNE_COORD_FS_TAL 2006
681  //
682  // CTF coil and channel types
683  //
684  //FIFFV_REF_MEG_CH 301
685  //
686  // Data types
687  //
688 #define FIFFT_VOID 0
689 #define FIFFT_BYTE 1
690 #define FIFFT_SHORT 2
691 #define FIFFT_INT 3
692 #define FIFFT_FLOAT 4
693 #define FIFFT_DOUBLE 5
694 #define FIFFT_JULIAN 6
695 #define FIFFT_USHORT 7
696 #define FIFFT_UINT 8
697 #define FIFFT_ULONG 9
698 #define FIFFT_STRING 10
699 #define FIFFT_LONG 11
700 #define FIFFT_DAU_PACK13 13
701 #define FIFFT_DAU_PACK14 14
702 #define FIFFT_DAU_PACK16 16
703 #define FIFFT_COMPLEX_FLOAT 20
704 #define FIFFT_COMPLEX_DOUBLE 21
705 #define FIFFT_OLD_PACK 23
706 #define FIFFT_CH_INFO_STRUCT 30
707 #define FIFFT_ID_STRUCT 31
708 #define FIFFT_DIR_ENTRY_STRUCT 32
709 #define FIFFT_DIG_POINT_STRUCT 33
710 #define FIFFT_CH_POS_STRUCT 34
711 #define FIFFT_COORD_TRANS_STRUCT 35
712 #define FIFFT_DIG_STRING_STRUCT 36
713 #define FIFFT_STREAM_SEGMENT_STRUCT 37
714  //
715  // Units of measurement
716  //
717 #define FIFF_UNIT_NONE -1
718  //
719  // SI base units
720  //
721 #define FIFF_UNIT_M 1
722 #define FIFF_UNIT_KG 2
723 #define FIFF_UNIT_SEC 3
724 #define FIFF_UNIT_A 4
725 #define FIFF_UNIT_K 5
726 #define FIFF_UNIT_MOL 6
727  //
728  // SI Supplementary units
729  //
730 #define FIFF_UNIT_RAD 7
731 #define FIFF_UNIT_SR 8
732  //
733  // SI base candela
734  //
735 #define FIFF_UNIT_CD 9
736  //
737  // SI derived units
738  //
739 #define FIFF_UNIT_HZ 101
740 #define FIFF_UNIT_N 102
741 #define FIFF_UNIT_PA 103
742 #define FIFF_UNIT_J 104
743 #define FIFF_UNIT_W 105
744 #define FIFF_UNIT_C 106
745 #define FIFF_UNIT_V 107
746 #define FIFF_UNIT_F 108
747 #define FIFF_UNIT_OHM 109
748 #define FIFF_UNIT_MHO 110
749 #define FIFF_UNIT_WB 111
750 #define FIFF_UNIT_T 112
751 #define FIFF_UNIT_H 113
752 #define FIFF_UNIT_CEL 114
753 #define FIFF_UNIT_LM 115
754 #define FIFF_UNIT_LX 116
755  //
756  // Others we need
757  //
758 #define FIFF_UNIT_T_M 201
759 #define FIFF_UNIT_AM 202
760 #define FIFF_UNIT_AM_M2 203
761 #define FIFF_UNIT_AM_M3 204
762  //
763  // Multipliers
764  //
765 #define FIFF_UNITM_E 18
766 #define FIFF_UNITM_PET 15
767 #define FIFF_UNITM_T 12
768 #define FIFF_UNITM_MEG 6
769 #define FIFF_UNITM_K 3
770 #define FIFF_UNITM_H 2
771 #define FIFF_UNITM_DA 1
772 #define FIFF_UNITM_NONE 0
773 #define FIFF_UNITM_D -1
774 #define FIFF_UNITM_C -2
775 #define FIFF_UNITM_M -3
776 #define FIFF_UNITM_MU -6
777 #define FIFF_UNITM_N -9
778 #define FIFF_UNITM_P -12
779 #define FIFF_UNITM_F -15
780 #define FIFF_UNITM_A -18
781 
782 
783 
784 
785 
786 
787 
788 #define FIFFT_DATA_REF_STRUCT 38
789 
790 /*
791 * These are for matrices of any of the above
792 */
793 
794 #define FIFFTS_FS_MASK 0xFF000000
795 #define FIFFTS_BASE_MASK 0x00000FFF
796 #define FIFFTS_MC_MASK 0x00FF0000
797 
798 #define FIFFTS_FS_SCALAR 0x00000000
799 #define FIFFTS_FS_MATRIX 0x40000000
800 
801 #define FIFFTS_MC_DENSE 0x00000000
802 #define FIFFTS_MC_CCS 0x00100000
803 #define FIFFTS_MC_RCS 0x00200000
804 
805 
806 /*
807  * Real-time shmem
808  */
809 #define FIFF_NEW_FILE 1
810 #define FIFF_CLOSE_FILE 2
811 #define FIFF_DISCARD_FILE 3
812 #define FIFF_ERROR_MESSAGE 4
813 #define FIFF_SUSPEND_READING 5
814 #define FIFF_FATAL_ERROR_MESSAGE 6
815 #define FIFF_CONNECTION_CHECK 7
816 #define FIFF_SUSPEND_FILING 8
817 #define FIFF_RESUME_FILING 9
818 #define FIFF_RAW_PREBASE 10
819 #define FIFF_RAW_PICK_LIST 11
820 #define FIFF_ECHO 12
821 #define FIFF_RESUME_READING 13
822 #define FIFF_DACQ_SYSTEM_TYPE 14
823 #define FIFF_SELECT_RAW_CH 15 /* Instruct rawdisp to select this channel */
824 #define FIFF_PLAYBACK_MODE 16 /* Tell that we are playing data back from the hard
825  * disks in the data acquisition front end */
826 #define FIFF_CONTINUE_FILE 17 /* Used to inform that data is saved into a continuation file. */
827 #define FIFF_JITTER_MAX 18 /* Used to tell the jitter in the timing of data packets */
828 #define FIFF_STREAM_SEGMENT 19 /* A segment of data stream */
829 
830 
831 /*
832 * Index
833 */
834 #define FIFF_INDEX_KIND 5001
835 #define FIFF_INDEX 5002
836 
837 
838 /*======================================================================
839 * Enumerated types used as tag values.
840 *=====================================================================*/
841 
842 /* Values for FIFF_REF_ROLE. The role of a reference */
843 
844 #define FIFFV_ROLE_PREV_FILE 1
845 #define FIFFV_ROLE_NEXT_FILE 2
846 
847 
848 /*
849 * Method by which a projection is defined (FIFF_PROJ_ITEM_DEFINITION).
850 * If tag is not present, FIFF_PROJ_BY_COMPLEMENT should be assumed.
851 */
852 #define FIFFV_PROJ_BY_COMPLEMENT 0
853 #define FIFFV_PROJ_BY_SPACE 1
854 
855 
856 /* Volume types used in FIFF_VOL_TYPE */
857 
858 #define FIFFV_VOL_TYPE_HD 1 /* Hard disk */
859 #define FIFFV_VOL_TYPE_MOD 2 /* Magneto-optical disk */
860 
861 
862 /*
863  * Byte order
864  */
865 #define FIFFV_NATIVE_ENDIAN 0 /* This refers to the byte order in the current system */
866 #define FIFFV_LITTLE_ENDIAN 1 /* The little-endian (Intel) byte order */
867 #define FIFFV_BIG_ENDIAN 2 /* The big-endian (Motorola) byte order */
868 
869 } // NAMESPACE
870 
871 #endif // FIFF_CONSTANTS_H
Definition: fiff.h:98