-
Notifications
You must be signed in to change notification settings - Fork 12
/
DictionaryStructures.txt
800 lines (738 loc) · 15.5 KB
/
DictionaryStructures.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
# Fiff file structure dictionary
#
# Copyright (C) Megin Oy
#
# This is the complete dictionary.
# All rights reserved.
#
# $Log: DictionaryStructures.txt,v $
# Revision 1.8 2019/09/16 06:44:11 jne
# maxshield_record -> ias_record
# MAXSHIELD_RECORD -> IAS_RECORD
# maxshield -> ias
# raw_maxshield -> raw_ias
# maxshield_raw_data -> ias_raw_data
# evoked_maxshield -> evoked_ias
# maxshield_aspect -> ias_aspect
#
# Revision 1.7 2019/05/20 09:24:36 skesti
# Fixed ISOTRAK (extra '?'), raw_single and raw_multiple_1/2/n (extra '}')
#
# Revision 1.6 2019/05/14 07:33:23 skesti
# Added orig_file_guid, DEVICE_INFO, HELIUM_INFO, utc_offset.
#
# Revision 1.5 2018/07/02 05:27:10 jne
# Revision 1.4
#
# Revision 1.4 2011/05/06 08:29:05 janne
# Checking in earlier updates.
#
# Revision 1.3 2010/04/21 10:44:15 janne
# Updates to make Framemaker file proper.
#
# Revision 1.2 2010/04/20 13:19:14 janne
# Updated syntax definition.
#
# Revision 1.1 2010/04/20 11:46:34 janne
# Initial revision
#
#
#======================================================================
#======================================================================
#
# Syntax used in defining Fiff structures
#
# BLOCKS
#
# A block is described as a C-like block inside curly brackets. The type of the block
# is given as a variable name found in "DictionaryIOD.txt" before the starting
# bracket. The tags inside the block are indented once compared to the level of the
# block name.
#
# An example:
#
# block {
# TAGS
# }
#
# TAGS
#
# Tags are given as variables defined in "DictionaryTags.txt". The data type of each
# tag is omitted. See "DictionaryTags.txt" for the data type and description of each
# tag. In general, no requirement is set for the ordering of tags inside a block.
#
# SEGMENT DEFINITIONS
#
# Below common segments are defined into separate variables in the following manner:
#
# SEGMENT =
# tag
# block {
# tag
# }
#
# These segments can be used inside other segments:
#
# tag
# SEGMENT
# block {
# tag
# }
#
# CONDITIONAL AND MULTIPLICATIVE STATEMENTS
#
# If the tag/block appears only once, and is required, it is written as it is:
#
# block {
# tag
# }
#
# If the tag/block is required to appear n times in a row, a number is used inside
# square brackets:
#
# block[n] {
# tag[n]
# }
#
# If the tag/block has to appear at least once, but can appear any number of times,
# use star symbol:
#
# block* {
# tag
# }
#
# If the tag/block is conditional, use a question mark:
#
# block?{
# tag?
# }
#
# Also multiplicative statements can be conditional. Place the question mark
# after the square brackets or the star symbol:
#
# block[n]? {
# tag[n]?
# }
#
# block*? {
# tag*?
# }
#
# If there are two interchangeable options for tag/block it is denoted by '|'
# between the options:
#
# block1 | block2 {
# tag1 | tag2
# }
#
#======================================================================
#======================================================================
#
# Common to blocks
#
#======================================================================
:id common_to_blocks
#======================================================================
<begin>
COMMON_TO_BLOCKS
block {
block_id?
parent_block_id?
}
<end>
#======================================================================
#
# Start of the file (common to all)
#
#======================================================================
:id file_start
#======================================================================
<begin>
FILE_START =
file_id
dir_pointer
free_list?
parent_file_id?
<end>
#======================================================================
#
# Subject information
#
#======================================================================
:id subject_info
#======================================================================
<begin>
SUBJECT_INFO =
subject {
subj_id
subj_his_id?
subj_last_name
subj_first_name
subj_middle_name?
subj_birth_day?
subj_sex?
subj_hand?
subj_weight?
subj_height?
subj_comment?
}
<end>
#======================================================================
#
# Project information
#
#======================================================================
:id project_info
#======================================================================
<begin>
PROJECT_INFO =
proj_id
proj_name
proj_comment?
<end>
#======================================================================
#
# Processing history
#
#======================================================================
:id processing_history
#======================================================================
<begin>
PROCESSING_HISTORY =
processing_history? {
PROCESSING_RECORD+
}
<end>
#======================================================================
#
# Processing history
#
#======================================================================
:id processing_record
#======================================================================
<begin>
PROCESSING_RECORD =
processing_record? {
meas_date
experimenter
creator?
PROCESSING_INFO+
}
<end>
#======================================================================
#
# SSS processing record
#
#======================================================================
:id sss_record
#======================================================================
<begin>
SSS_RECORD =
processing_record {
meas_date
experimenter
creator
sss_info {
sss_job
sss_frame
sss_origin
sss_ord_in
sss_ord_out
sss_nmag
sss_components
sss_nfree
}
channel_decoupler {
meas_date
creator
decoupler_matrix
sparse_ch_name_list
}
sss_cal_adjust {
sss_cal_chans
sss_cal_corrs
}
}
<end>
#======================================================================
#
# IAS processing record
#
#======================================================================
:id ias_record
#======================================================================
<begin>
IAS_RECORD =
processing_record {
meas_date
experimenter
ias {
}
}
<end>
#======================================================================
#
# Head position indicator (HPI) fitting results
#
#======================================================================
:id hpi_result
#======================================================================
<begin>
HPI_RESULT =
hpi_result {
dig_point*
hpi_digitization_order
hpi_coils_used
hpi_coil_moments
hpi_fit_goodness
hpi_fit_good_limit
hpi_fit_dist_limit
hpi_fit_accept
coord_trans # device -> head
}
<end>
#======================================================================
#
# Head position indicator (HPI) measurement
#
#======================================================================
:id hpi_meas
#======================================================================
<begin>
HPI_MEAS =
hpi_meas {
creator
sfreq
nchan
nave
hpi_ncoil
first_sample
last_sample
hpi_coil+ {
hpi_coil_no
epoch+
hpi_slopes
hpi_corr_coeff
hpi_coil_freq?
}
}
<end>
#======================================================================
#
# Isotrak digitized points and strings
#
#======================================================================
:id isotrak
#======================================================================
<begin>
ISOTRAK =
isotrak {
meas_date?
dig_point+
dig_string*
}
<end>
#======================================================================
#
# Linear projection (SSP)
#
#======================================================================
:id ssp
#======================================================================
<begin>
SSP =
ssp {
nchan?
proj_item+ {
description
proj_item_kind
nchan?
proj_item_ch_name_list
proj_item_time
proj_item_nvec
proj_item_vectors
}
}
<end>
#======================================================================
#
# Device information
#
#======================================================================
:id device_info
#======================================================================
<begin>
DEVICE_INFO =
device_info {
device_type
device_model?
device_serial?
device_site?
}
<end>
#======================================================================
#
# Helium information
#
#======================================================================
:id helium_info
#======================================================================
<begin>
HELIUM_INFO =
helium_info {
he_level_raw?
helium_level?
gantry_angle?
meas_date
}
<end>
#======================================================================
#
# Measurement information
#
#======================================================================
:id meas_info
#======================================================================
<begin>
MEAS_INFO =
meas_info {
experimenter?
description?
orig_file_guid?
events? {
event_channels
event_list
}
HPI_RESULT?
HPI_MEAS?
ISOTRAK?
dacq_pars? {
dacq_pars
dacq_stim?
}
SUBJECT_INFO?
PROJECT_INFO?
SSP?
DEVICE_INFO?
HELIUM_INFO?
meas_date
utc_offset?
nchan
sfreq
lowpass
highpass
line_freq?
data_pack?
gantry_angle?
ch_info[nchan]
bad_chs?
hpi_subsystem? {
hpi_ncoil
event_channel
hpi_coil+ {
event_bits
}
}
}
<end>
#======================================================================
#
# Raw data in single file
#
#======================================================================
:id raw_single
#======================================================================
<begin>
FILE_START
measurement {
MEAS_INFO
PROCESSING_HISTORY?
raw_data {
first_samp?
(data_buffer | data_skip | data_skip_samp)*
}
}
nop
<end>
#======================================================================
#
# File reference block used in data splitted in multiple files
#
#======================================================================
:id file_reference
#======================================================================
<begin>
FILE_REFERENCE =
ref {
ref_role
ref_file_id
ref_file_num
}
<end>
#======================================================================
#
# Raw data in multiple files
#
#======================================================================
:id raw_multiple_1
#======================================================================
<begin>
FILE_START
measurement {
MEAS_INFO
raw_data {
first_samp?
(data_buffer | data_skip | data_skip_samp)*
FILE_REFERENCE
}
}
nop
<end>
#======================================================================
:id raw_multiple_2
#======================================================================
<begin>
FILE_START
measurement {
MEAS_INFO
raw_data {
FILE_REFERENCE
first_samp?
(data_buffer | data_skip | data_skip_samp)*
FILE_REFERENCE
}
}
nop
<end>
#======================================================================
:id raw_multiple_n
#======================================================================
<begin>
FILE_START
measurement {
MEAS_INFO
raw_data {
FILE_REFERENCE
first_samp?
(data_buffer | data_skip | data_skip_samp)*
}
}
nop
<end>
#======================================================================
#
# Raw IAS data
#
#======================================================================
:id raw_ias
#======================================================================
<begin>
FILE_START
measurement {
MEAS_INFO
processing_history {
IAS_RECORD
}
ias_raw_data {
first_samp?
(data_buffer | data_skip | data_skip_samp)*
}
}
nop
<end>
#======================================================================
#
# Processed raw data
#
#======================================================================
:id processed_raw
#======================================================================
<begin>
FILE_START
measurement {
MEAS_INFO
PROCESSING_HISTORY
processed_data {
continuous_data {
first_samp?
(data_buffer | data_skip |
data_skip_samp)*
}
}
}
nop
<end>
#======================================================================
#
# Evoked (averaged) data
#
#======================================================================
:id evoked_data
#======================================================================
<begin>
FILE_START
measurement {
MEAS_INFO
PROCESSING_HISTORY
processed_data {
evoked+ {
ref_event
first_sample
last_sample
event_comment?
comment?
aspect {
aspect_kind
nave?
epoch+
}
}
}
}
nop
<end>
#======================================================================
#
# Evoked IAS data
#
#======================================================================
:id evoked_ias
#======================================================================
<begin>
FILE_START
measurement {
MEAS_INFO
processing_history? {
IAS_RECORD
}
processed_data {
evoked+ {
ref_event
first_sample
last_sample
event_comment?
comment?
ias_aspect {
aspect_kind
nave?
epoch+
}
}
}
}
nop
<end>
#======================================================================
#
# Pixel data is included in the FIFF file
#
#======================================================================
:id pixel_data_included
#======================================================================
<begin>
PIXEL_DATA_INCLUDED =
mri_pixel_data
mri_pixel_type? # Can be omitted only if mri_pixel_data's FIFF
# data type matches with the actual data type
mri_orig_source_path?
mri_orig_source_format?
<end>
#
#======================================================================
#
# Pixel data is referenced from an external file:
#
#======================================================================
:id pixel_data_referenced
#======================================================================
<begin>
PIXEL_DATA_REF =
ref_path
mri_source_format
mri_pixel_type
mri_pixel_data_offset
<end>
#======================================================================
#
# Structural image (mri) data
#
#======================================================================
:id structural_data
#======================================================================
<begin>
FILE_START
structural_data {
SUBJECT_INFO?
PROCESSING_HISTORY?
volume_data+ {
coord_trans? # head -> MRI
dig_point[3]?
volume_slice+ {
mri_width
mri_width_m
mri_height
mri_height_m
coord_trans # MRI slice ->MRI
PIXEL_DATA_INCLUDED | PIXEL_DATA_REF
mri_pixel_scale
}
}
}
nop
<end>
#======================================================================
#
# Triangular BEM meshes
#
#======================================================================
:id bem
#======================================================================
<begin>
FILE_START
bem {
SUBJECT_INFO?
PROCESSING_HISTORY?
bem_coord_frame
coord_trans # head -> mri
bem_surf+ {
bem_surf_id
bem_sigma
bem_surf_nnode
bem_surface_ntri
bem_surface_nodes
bem_surface_normals?
bem_surface_triangles
}
bem_approx?
bem_pot_solution?
}
nop
<end>
#======================================================================
#
# Screen captures
#
#======================================================================
:id scenery
#======================================================================
<begin>
FILE_START
scenery {
SUBJECT_INFO?
PROCESSING_HISTORY?
coord_trans # head -> MRI
mri_scene_aim
scene+ {
mri_width
mri_width_m
mri_height
mri_height_m
coord_trans # MRI slice -> MRI
block_name
mri_pixel_data
mri_source_format
mri_pixel_scale
}
}
nop
<end>