-
Notifications
You must be signed in to change notification settings - Fork 169
/
metadata.yaml
4043 lines (4040 loc) · 136 KB
/
metadata.yaml
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
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
# This file defines valid BIDS metadata fields.
# These definitions include the field names, their descriptions, and valid values.
# This file **does not** define how and when metadata fields can be used with a given file.
ACCELChannelCount:
name: ACCELChannelCount
display_name: Acceleration channel count
description: |
Number of acceleration channels.
type: integer
minimum: 0
Acknowledgements:
name: Acknowledgements
display_name: Acknowledgements
description: |
Text acknowledging contributions of individuals or institutions beyond
those listed in Authors or Funding.
type: string
AcquisitionDuration:
name: AcquisitionDuration
display_name: Acquisition Duration
description: |
Duration (in seconds) of volume acquisition.
Corresponds to [DICOM Tag 0018, 9073](https://dicomlookup.com/dicomtags/(0018,9073)) `Acquisition Duration`.
This field is mutually exclusive with `"RepetitionTime"`.
type: number
exclusiveMinimum: 0
unit: s
AcquisitionMode:
name: AcquisitionMode
display_name: Acquisition Mode
description: |
Type of acquisition of the PET data (for example, `"list mode"`).
type: string
AcquisitionVoxelSize:
name: AcquisitionVoxelSize
display_name: Acquisition Voxel Size
description: |
An array of numbers with a length of 3, in millimeters.
This field denotes the original acquisition voxel size,
excluding any inter-slice gaps and before any interpolation or resampling
within reconstruction or image processing.
Any point spread function effects, for example due to T2-blurring,
that would decrease the effective resolution are not considered here.
type: array
minItems: 3
maxItems: 3
items:
type: number
exclusiveMinimum: 0
unit: mm
Anaesthesia:
name: Anaesthesia
display_name: Anaesthesia
description: |
Details of anaesthesia used, if any.
type: string
AnalyticalApproach:
name: AnalyticalApproach
display_name: Analytical Approach
description: |
Methodology or methodologies used to analyze the `"GeneticLevel"`.
Values MUST be taken from the
[database of Genotypes and Phenotypes
(dbGaP)](https://www.ncbi.nlm.nih.gov/gap/advanced)
under /Study/Molecular Data Type (for example, SNP Genotypes (Array) or
Methylation (CpG).
anyOf:
- type: string
- type: array
items:
type: string
AnatomicalImage:
name: AnatomicalImage
display_name: Anatomical Image
description: |
The path(s) to the anatomical MR image file(s), if present,
to which the associated MRS data file corresponds.
Contains one or more [BIDS URIs](SPEC_ROOT/common-principles.md#bids-uri).
anyOf:
- type: string
format: bids_uri
- type: array
items:
type: string
format: bids_uri
AnatomicalLandmarkCoordinateSystem:
name: AnatomicalLandmarkCoordinateSystem
display_name: Anatomical Landmark Coordinate System
description: |
Defines the coordinate system for the anatomical landmarks.
See the [Coordinate Systems Appendix](SPEC_ROOT/appendices/coordinate-systems.md)
for a list of restricted keywords for coordinate systems.
If `"Other"`, provide definition of the coordinate system in
`"AnatomicalLandmarkCoordinateSystemDescription"`.
anyOf:
- $ref: objects.enums._MEGCoordSys
- $ref: objects.enums._EEGCoordSys
- $ref: objects.enums._StandardTemplateCoordSys
- $ref: objects.enums._StandardTemplateDeprecatedCoordSys
AnatomicalLandmarkCoordinateSystemDescription:
name: AnatomicalLandmarkCoordinateSystemDescription
display_name: Anatomical Landmark Coordinate System Description
description: |
Free-form text description of the coordinate system.
May also include a link to a documentation page or paper describing the
system in greater detail.
type: string
AnatomicalLandmarkCoordinateUnits:
name: AnatomicalLandmarkCoordinateUnits
display_name: Anatomical Landmark Coordinate Units
description: |
Units of the coordinates of `"AnatomicalLandmarkCoordinateSystem"`.
type: string
# TODO: Add definitions for these values. (perhaps don't specify)
enum:
- m
- mm
- cm
- n/a
AnatomicalLandmarkCoordinates:
name: AnatomicalLandmarkCoordinates
display_name: Anatomical Landmark Coordinates
description: |
Key-value pairs of the labels and 3-D digitized locations of anatomical landmarks,
interpreted following the `"AnatomicalLandmarkCoordinateSystem"`
(for example, `{"NAS": [12.7,21.3,13.9], "LPA": [5.2,11.3,9.6],
"RPA": [20.2,11.3,9.1]}`.
Each array MUST contain three numeric values corresponding to x, y, and z
axis of the coordinate system in that exact order.
type: object
additionalProperties:
type: array
items:
type: number
minItems: 3
maxItems: 3
# Redefinition of AnatomicalLandmarkCoordinates for MRI data
AnatomicalLandmarkCoordinates__mri:
name: AnatomicalLandmarkCoordinates
display_name: Anatomical Landmark Coordinates
description: |
Key-value pairs of any number of additional anatomical landmarks and their
coordinates in voxel units (where first voxel has index 0,0,0)
relative to the associated anatomical MRI
(for example, `{"AC": [127,119,149], "PC": [128,93,141],
"IH": [131,114,206]}`, or `{"NAS": [127,213,139], "LPA": [52,113,96],
"RPA": [202,113,91]}`).
Each array MUST contain three numeric values corresponding to x, y, and z
axis of the coordinate system in that exact order.
type: object
additionalProperties:
type: array
items:
type: number
minItems: 3
maxItems: 3
ANGACCELChannelCount:
name: ANGACCELChannelCount
display_name: Angular acceleration channel count
description: |
Number of angular acceleration channels.
type: integer
minimum: 0
ArterialSpinLabelingType:
name: ArterialSpinLabelingType
display_name: Arterial Spin Labeling Type
description: |
The arterial spin labeling type.
type: string
enum:
- $ref: objects.enums.CASL.value
- $ref: objects.enums.PCASL.value
- $ref: objects.enums.PASL.value
AssociatedEmptyRoom:
name: AssociatedEmptyRoom
display_name: Associated Empty Room
description: |
One or more [BIDS URIs](SPEC_ROOT/common-principles.md#bids-uri)
pointing to empty-room file(s) associated with the subject's MEG recording.
Using forward-slash separated paths relative to the dataset root is
[DEPRECATED](SPEC_ROOT/common-principles.md#definitions).
anyOf:
- type: array
items:
anyOf:
- type: string
format: dataset_relative
- type: string
format: bids_uri
- type: string
format: dataset_relative
- type: string
format: bids_uri
AttenuationCorrection:
name: AttenuationCorrection
display_name: Attenuation Correction
description: |
Short description of the attenuation correction method used.
type: string
AttenuationCorrectionMethodReference:
name: AttenuationCorrectionMethodReference
display_name: Attenuation Correction Method Reference
description: |
Reference paper for the attenuation correction method used.
type: string
Authors:
name: Authors
display_name: Authors
description: |
List of individuals who contributed to the creation/curation of the dataset.
type: array
items:
type: string
B0FieldIdentifier:
name: B0FieldIdentifier
display_name: B0 Field Identifier
description: |
The presence of this key states that this particular 3D or 4D image MAY be
used for fieldmap estimation purposes.
Each `"B0FieldIdentifier"` MUST be a unique string within one participant's tree,
shared only by the images meant to be used as inputs for the estimation of a
particular instance of the *B<sub>0</sub> field* estimation.
It is RECOMMENDED to derive this identifier from DICOM Tags, for example,
DICOM tag 0018, 1030 `Protocol Name`, or DICOM tag 0018, 0024 `Sequence Name`
when the former is not defined (for example, in GE devices.)
anyOf:
- type: string
- type: array
items:
type: string
B0FieldSource:
name: B0FieldSource
display_name: B0 Field Source
description: |
At least one existing `"B0FieldIdentifier"` defined by images in the
participant's tree.
This field states the *B<sub>0</sub> field* estimation designated by the
`"B0FieldIdentifier"` that may be used to correct the dataset for distortions
caused by B<sub>0</sub> inhomogeneities.
`"B0FieldSource"` and `"B0FieldIdentifier"` MAY both be present for images that
are used to estimate their own B<sub>0</sub> field, for example, in "pepolar"
acquisitions.
anyOf:
- type: string
- type: array
items:
type: string
B0ShimmingTechnique:
name: B0ShimmingTechnique
display_name: B0 Shimming Technique
description: |
The technique used to shim the *B*<sub>0</sub> field (for example, `"Dynamic shim updating"`
or `"FASTMAP"`).
type: string
B1ShimmingTechnique:
name: B1ShimmingTechnique
display_name: B1 Shimming Technique
description: |
The technique used to shim the *B*<sub>1</sub> field (for example, `"Simple phase align"`
or `"Pre-saturated TurboFLASH"`).
type: string
BIDSVersion:
name: BIDSVersion
display_name: BIDS Version
description: |
The version of the BIDS standard that was used.
type: string
BackgroundSuppression:
name: BackgroundSuppression
display_name: Background Suppression
description: |
Boolean indicating if background suppression is used.
type: boolean
BackgroundSuppressionNumberPulses:
name: BackgroundSuppressionNumberPulses
display_name: Background Suppression Number Pulses
description: |
The number of background suppression pulses used.
Note that this excludes any effect of background suppression pulses applied
before the labeling.
type: number
minimum: 0
BackgroundSuppressionPulseTime:
name: BackgroundSuppressionPulseTime
display_name: Background Suppression Pulse Time
description: |
Array of numbers containing timing, in seconds,
of the background suppression pulses with respect to the start of the
labeling.
In case of multi-PLD with different background suppression pulse times,
only the pulse time of the first PLD should be defined.
type: array
items:
type: number
minimum: 0
unit: s
BasedOn:
name: BasedOn
display_name: Based On
description: |
List of files in a file collection to generate the map.
Fieldmaps are also listed, if involved in the processing.
This field is DEPRECATED, and this metadata SHOULD be recorded in the
`Sources` field using [BIDS URIs](SPEC_ROOT/common-principles.md#bids-uri)
to distinguish sources from different datasets.
anyOf:
- type: string
format: participant_relative
- type: array
items:
type: string
format: participant_relative
BloodDensity:
name: BloodDensity
display_name: Blood Density
description: |
Measured blood density. Unit of blood density should be in `"g/mL"`.
type: number
unit: g/mL
BodyPart:
name: BodyPart
display_name: Body Part
description: |
Body part of the organ / body region scanned.
type: string
BodyPartDetails:
name: BodyPartDetails
display_name: Body Part Details
description: |
Additional details about body part or location (for example: `"corpus callosum"`).
type: string
BodyPartDetailsOntology:
name: BodyPartDetailsOntology
display_name: Body Part Details Ontology
description: |
[URI](SPEC_ROOT/common-principles.md#uniform-resource-indicator) of ontology used for
BodyPartDetails (for example: `"https://www.ebi.ac.uk/ols/ontologies/uberon"`).
type: string
format: uri
BolusCutOffDelayTime:
name: BolusCutOffDelayTime
display_name: Bolus Cut Off Delay Time
description: |
Duration between the end of the labeling and the start of the bolus cut-off
saturation pulse(s), in seconds.
This can be a number or array of numbers, of which the values must be
non-negative and monotonically increasing, depending on the number of bolus
cut-off saturation pulses.
For Q2TIPS, only the values for the first and last bolus cut-off saturation
pulses are provided.
Based on [DICOM Tag 0018, 925F](https://dicomlookup.com/dicomtags/(0018,925F)) `ASL Bolus Cut-off Delay Time`.
anyOf:
- type: number
minimum: 0
unit: s
- type: array
items:
type: number
unit: s
minimum: 0
BolusCutOffFlag:
name: BolusCutOffFlag
display_name: Bolus Cut Off Flag
description: |
Boolean indicating if a bolus cut-off technique is used.
Corresponds to [DICOM Tag 0018, 925C](https://dicomlookup.com/dicomtags/(0018,925C)) `ASL Bolus Cut-off Flag`.
type: boolean
BolusCutOffTechnique:
name: BolusCutOffTechnique
display_name: Bolus Cut Off Technique
description: |
Name of the technique used, for example `"Q2TIPS"`, `"QUIPSS"`, `"QUIPSSII"`.
Corresponds to [DICOM Tag 0018, 925E](https://dicomlookup.com/dicomtags/(0018,925E)) `ASL Bolus Cut-off Technique`.
type: string
BrainLocation:
name: BrainLocation
display_name: Brain Location
description: |
Refers to the location in space of the `"TissueOrigin"`.
Values may be an MNI coordinate,
a label taken from the
[Allen Brain Atlas](https://atlas.brain-map.org/atlas?atlas=265297125&plate=\
112360888&structure=4392&x=40348.15104166667&y=46928.75&zoom=-7&resolution=\
206.60&z=3),
or layer to refer to layer-specific gene expression,
which can also tie up with laminar fMRI.
type: string
CASLType:
name: CASLType
display_name: CASL Type
description: |
Describes if a separate coil is used for labeling.
type: string
enum:
- $ref: objects.enums.single_coil.value
- $ref: objects.enums.double_coil.value
CapManufacturer:
name: CapManufacturer
display_name: Cap Manufacturer
description: |
Name of the cap manufacturer (for example, `"EasyCap"`).
type: string
CapManufacturersModelName:
name: CapManufacturersModelName
display_name: Cap Manufacturers Model Name
description: |
Manufacturer's designation of the cap model
(for example, `"actiCAP 64 Ch Standard-2"`).
type: string
CellType:
name: CellType
display_name: Cell Type
description: |
Describes the type of cell analyzed.
Values SHOULD come from the
[cell ontology](https://obofoundry.org/ontology/cl.html).
type: string
ChemicalShiftOffset:
name: ChemicalShiftOffset
display_name: Chemical Shift Offset
description: |
The chemical shift at the center of `SpectralWidth` corresponding to 0 Hz,
specified in ppm (for example, `4.65`).
type: number
unit: ppm
ChemicalShiftReference:
name: ChemicalShiftReference
display_name: Chemical Shift Reference
description: |
The chemical shift at the transmitter frequency, specified in ppm (for example, `2.68`).
Corresponds to [DICOM Tag 0018, 9053](https://dicomlookup.com/dicomtags/(0018,9053)) `Chemical Shift Reference`.
type: number
unit: ppm
ChunkTransformationMatrix:
name: ChunkTransformationMatrix
display_name: Chunk Transformation Matrix
description: |
3x3 or 4x4 affine transformation matrix describing spatial chunk transformation,
for 2D and 3D respectively (for examples: `[[2, 0, 0], [0, 3, 0], [0, 0, 1]]`
in 2D for 2x and 3x scaling along the first and second axis respectively; or
`[[1, 0, 0, 0], [0, 2, 0, 0], [0, 0, 3, 0], [0, 0, 0, 1]]` in 3D for 2x and 3x
scaling along the second and third axis respectively).
Note that non-spatial dimensions like time and channel are not included in the
transformation matrix.
anyOf:
- type: array
minItems: 3
maxItems: 3
items:
type: array
minItems: 3
maxItems: 3
items:
type: number
- type: array
minItems: 4
maxItems: 4
items:
type: array
minItems: 4
maxItems: 4
items:
type: number
ChunkTransformationMatrixAxis:
name: ChunkTransformationMatrixAxis
display_name: Chunk Transformation Matrix Axis
description: |
Describe the axis of the ChunkTransformationMatrix
(for examples: `["X", "Y"]` or `["Z", "Y", "X"]`).
type: array
minItems: 2
maxItems: 3
items:
type: string
Code:
name: Code
display_name: Code
description: |
[URI](SPEC_ROOT/common-principles.md#uniform-resource-indicator)
of the code used to present the stimuli.
Persistent identifiers such as DOIs are preferred.
If multiple versions of code may be hosted at the same location,
revision-specific URIs are recommended.
type: string
format: uri
CogAtlasID:
name: CogAtlasID
display_name: Cognitive Atlas ID
description: |
[URI](SPEC_ROOT/common-principles.md#uniform-resource-indicator)
of the corresponding [Cognitive Atlas](https://www.cognitiveatlas.org/)
Task term.
type: string
format: uri
CogPOID:
name: CogPOID
display_name: Cognitive Paradigm Ontology ID
description: |
[URI](SPEC_ROOT/common-principles.md#uniform-resource-indicator)
of the corresponding [CogPO](http://www.cogpo.org/) term.
type: string
format: uri
CoilCombinationMethod:
name: CoilCombinationMethod
display_name: Coil Combination Method
description: |
Almost all fMRI studies using phased-array coils use root-sum-of-squares
(rSOS) combination, but other methods exist.
The image reconstruction is changed by the coil combination method
(as for the matrix coil mode above),
so anything non-standard should be reported.
type: string
Columns:
name: Columns
display_name: Columns
description: |
Names of columns in file.
type: array
items:
type: string
ContinuousHeadLocalization:
name: ContinuousHeadLocalization
display_name: Continuous Head Localization
description: |
`true` or `false` value indicating whether continuous head localisation
was performed.
type: boolean
ContrastBolusIngredient:
name: ContrastBolusIngredient
display_name: Contrast Bolus Ingredient
description: |
Active ingredient of agent.
Corresponds to [DICOM Tag 0018, 1048](https://dicomlookup.com/dicomtags/(0018,1048)) `Contrast/Bolus Ingredient`.
type: string
enum:
- $ref: objects.enums.IODINE.value
- $ref: objects.enums.GADOLINIUM.value
- $ref: objects.enums.CARBON_DIOXIDE.value
- $ref: objects.enums.BARIUM.value
- $ref: objects.enums.XENON.value
# TODO: Add definitions for these values. (perhaps don't specify)
- UNKNOWN
- NONE
DCOffsetCorrection:
name: DCOffsetCorrection
display_name: DC Offset Correction
description: |
A description of the method (if any) used to correct for a DC offset.
If the method used was subtracting the mean value for each channel,
use "mean".
type: string
DatasetDOI:
name: DatasetDOI
display_name: DatasetDOI
description: |
The Digital Object Identifier of the dataset (not the corresponding paper).
DOIs SHOULD be expressed as a valid
[URI](SPEC_ROOT/common-principles.md#uniform-resource-indicator);
bare DOIs such as `10.0.2.3/dfjj.10` are
[DEPRECATED](SPEC_ROOT/common-principles.md#definitions).
type: string
format: uri
DatasetLinks:
name: DatasetLinks
display_name: Dataset Links
description: |
Used to map a given `<dataset-name>` from a [BIDS URI](SPEC_ROOT/common-principles.md#bids-uri)
of the form `bids:<dataset-name>:path/within/dataset` to a local or remote location.
The `<dataset-name>`: `""` (an empty string) is a reserved keyword that MUST NOT be a key in
`DatasetLinks` (example: `bids::path/within/dataset`).
type: object
additionalProperties:
type: string
format: uri
DatasetType:
name: DatasetType
display_name: Dataset Type
description: |
The interpretation of the dataset.
For backwards compatibility, the default value is `"raw"`.
type: string
enum:
- $ref: objects.enums.raw.value
- $ref: objects.enums.derivative.value
DecayCorrectionFactor:
name: DecayCorrectionFactor
display_name: Decay Correction Factor
description: |
Decay correction factor for each frame.
type: array
items:
type: number
DeidentificationMethod:
name: DeidentificationMethod
display_name: Deidentification Method
description: |
A description of the mechanism or method used to remove the Patient's identity.
Corresponds to [DICOM Tag 0012, 0063](https://dicomlookup.com/dicomtags/(0012,0063)) `De-identification Method`.
type: array
items:
type: string
DeidentificationMethodCodeSequence:
name: DeidentificationMethodCodeSequence
display_name: Deidentification Method Code Sequence
description: |
A sequence of code objects describing the mechanism or method use to remove the Patient's identity.
Corresponds to [DICOM Tag 0012, 0064](https://dicomlookup.com/dicomtags/(0012,0064))
`De-identification Method Code Sequence`.
type: array
items:
type: object
recommended_fields:
- CodeValue
- CodeMeaning
- CodingSchemeDesignator
- CodingSchemeVersion
properties:
CodeValue:
name: CodeValue
type: string
description: |
An identifier that is unambiguous within the Coding Scheme
denoted by Coding Scheme Designator and Coding Scheme Version.
Corresponds to [DICOM Tag 0008, 0100](https://dicomlookup.com/dicomtags/(0008,0100)) `Code Value`.
CodeMeaning:
name: CodeMeaning
type: string
description: |
Text that has meaning to a human and conveys the meaning of the term
Corresponds to [DICOM Tag 0008, 0104](https://dicomlookup.com/dicomtags/(0008,0104)) `Code Meaning`.
CodingSchemeDesignator:
name: CodingSchemeDesignator
type: string
description: |
The identifier of the coding scheme in which the coded entry is defined.
Corresponds to [DICOM Tag 0008, 0102](https://dicomlookup.com/dicomtags/(0008,0102))
`Coding Scheme Designator`.
CodingSchemeVersion:
name: CodingSchemeVersion
type: string
description: |
An identifier of the version of the coding scheme if necessary to resolve ambiguity.
Corresponds to [DICOM Tag 0008, 0103](https://dicomlookup.com/dicomtags/(0008,0103)) `Coding Scheme Version`.
DelayAfterTrigger:
name: DelayAfterTrigger
display_name: Delay After Trigger
description: |
Duration (in seconds) from trigger delivery to scan onset.
This delay is commonly caused by adjustments and loading times.
This specification is entirely independent of
`"NumberOfVolumesDiscardedByScanner"` or `"NumberOfVolumesDiscardedByUser"`,
as the delay precedes the acquisition.
type: number
unit: s
DelayTime:
name: DelayTime
display_name: Delay Time
description: |
User specified time (in seconds) to delay the acquisition of data for the
following volume.
If the field is not present it is assumed to be set to zero.
Corresponds to Siemens CSA header field `lDelayTimeInTR`.
This field is REQUIRED for sparse sequences using the `"RepetitionTime"` field
that do not have the `"SliceTiming"` field set to allowed for accurate
calculation of "acquisition time".
This field is mutually exclusive with `"VolumeTiming"`.
type: number
unit: s
Delimiter:
name: Delimiter
display_name: Delimiter
description: |
If rows in a column may be interpreted as a lists of values, the character that
separates one value from the next.
type: string
Density:
name: Density
display_name: Density
description: |
Specifies the interpretation of the density keyword.
If an object is used, then the keys should be values for the `den` entity
and values should be descriptions of those `den` values.
anyOf:
- type: string
- type: object
additionalProperties:
type: string
Derivative:
name: Derivative
display_name: Derivative
description: |
Indicates that values in the corresponding column are transformations of values
from other columns (for example a summary score based on a subset of items in a
questionnaire).
type: boolean
Description:
name: Description
display_name: Description
description: |
Free-form natural language description.
type: string
DetectorType:
name: DetectorType
display_name: Detector Type
description: |
Type of detector. This is a free form description with the following suggested terms:
`"SiPD"`, `"APD"`. Preferably a specific model/part number is supplied.
If individual channels have different `DetectorType`,
then the field here should be specified as `"mixed"`
and this column should be included in `optodes.tsv`.
anyOf:
- type: string
format: unit
- type: string
enum:
- $ref: objects.enums.mixed.value
DeviceSerialNumber:
name: DeviceSerialNumber
display_name: Device Serial Number
description: |
The serial number of the equipment that produced the measurements.
A pseudonym can also be used to prevent the equipment from being
identifiable, so long as each pseudonym is unique within the dataset.
type: string
DewarPosition:
name: DewarPosition
display_name: Dewar Position
description: |
Position of the dewar during the MEG scan:
`"upright"`, `"supine"` or `"degrees"` of angle from vertical:
for example on CTF systems, `"upright=15°, supine=90°"`.
type: string
DigitizedHeadPoints:
name: DigitizedHeadPoints
display_name: Digitized Head Points
description: |
`true` or `false` value indicating whether head points outlining the
scalp/face surface are contained within this recording.
type: boolean
DigitizedHeadPoints__coordsystem:
name: DigitizedHeadPoints
display_name: Digitized Head Points
description: |
Relative path to the file containing the locations of digitized head points
collected during the session (for example, `"sub-01_headshape.pos"`).
RECOMMENDED for all MEG systems, especially for CTF and BTi/4D.
For Neuromag/Elekta/MEGIN, the head points will be stored in the `.fif` file.
type: string
format: file_relative
DigitizedHeadPointsCoordinateSystem:
name: DigitizedHeadPointsCoordinateSystem
display_name: Digitized Head Points Coordinate System
description: |
Defines the coordinate system for the digitized head points.
See the
[Coordinate Systems Appendix](SPEC_ROOT/appendices/coordinate-systems.md)
for a list of restricted keywords for coordinate systems.
If `"Other"`, provide definition of the coordinate system in
`"DigitizedHeadPointsCoordinateSystemDescription"`.
anyOf:
- $ref: objects.enums._MEGCoordSys
- $ref: objects.enums._EEGCoordSys
- $ref: objects.enums._StandardTemplateCoordSys
- $ref: objects.enums._StandardTemplateDeprecatedCoordSys
DigitizedHeadPointsCoordinateSystemDescription:
name: DigitizedHeadPointsCoordinateSystemDescription
display_name: Digitized Head Points Coordinate System Description
description: |
Free-form text description of the coordinate system.
May also include a link to a documentation page or paper describing the
system in greater detail.
type: string
DigitizedHeadPointsCoordinateUnits:
name: DigitizedHeadPointsCoordinateUnits
display_name: Digitized Head Points Coordinate Units
description: |
Units of the coordinates of `"DigitizedHeadPointsCoordinateSystem"`.
type: string
# TODO: Add definitions for these values. (perhaps don't specify)
enum:
- m
- mm
- cm
- n/a
DigitizedLandmarks:
name: DigitizedLandmarks
display_name: Digitized Landmarks
description: |
`true` or `false` value indicating whether anatomical landmark points
(fiducials) are contained within this recording.
type: boolean
DispersionConstant:
name: DispersionConstant
display_name: Dispersion Constant
description: |
External dispersion time constant resulting from tubing in default unit
seconds.
type: number
unit: s
DispersionCorrected:
name: DispersionCorrected
display_name: Dispersion Corrected
description: |
Boolean flag specifying whether the blood data have been dispersion-corrected.
NOTE: not customary for manual samples, and hence should be set to `false`.
type: boolean
DoseCalibrationFactor:
name: DoseCalibrationFactor
display_name: Dose Calibration Factor
description: |
Multiplication factor used to transform raw data (in counts/sec) to meaningful unit (Bq/ml).
Corresponds to [DICOM Tag 0054, 1322](https://dicomlookup.com/dicomtags/(0054,1322)) `Dose Calibration Factor`.
type: number
DwellTime:
name: DwellTime
display_name: Dwell Time
description: |
Actual dwell time (in seconds) of the receiver per point in the readout
direction, including any oversampling.
For Siemens, this corresponds to DICOM field 0019, 1018 (in ns).
This value is necessary for the optional readout distortion correction of
anatomicals in the HCP Pipelines.
It also usefully provides a handle on the readout bandwidth,
which isn't captured in the other metadata tags.
Not to be confused with `"EffectiveEchoSpacing"`, and the frequent mislabeling
of echo spacing (which is spacing in the phase encoding direction) as
"dwell time" (which is spacing in the readout direction).
type: number
unit: s
ECGChannelCount:
name: ECGChannelCount
display_name: ECG Channel Count
description: |
Number of ECG channels.
type: integer
minimum: 0
ECOGChannelCount:
name: ECOGChannelCount
display_name: ECOG Channel Count
description: |
Number of ECoG channels.
type: integer
minimum: 0
EEGChannelCount:
name: EEGChannelCount
display_name: EEG Channel Count
description: |
Number of EEG channels recorded simultaneously (for example, `21`).
type: integer
minimum: 0
EEGCoordinateSystem:
name: EEGCoordinateSystem
display_name: EEG Coordinate System
description: |
Defines the coordinate system for the EEG sensors.
See the
[Coordinate Systems Appendix](SPEC_ROOT/appendices/coordinate-systems.md)
for a list of restricted keywords for coordinate systems.
If `"Other"`, provide definition of the coordinate system in
`EEGCoordinateSystemDescription`.
anyOf:
- $ref: objects.enums._MEGCoordSys
- $ref: objects.enums._EEGCoordSys
- $ref: objects.enums._StandardTemplateCoordSys
- $ref: objects.enums._StandardTemplateDeprecatedCoordSys
EEGCoordinateSystemDescription:
name: EEGCoordinateSystemDescription
display_name: EEG Coordinate System Description
description: |
Free-form text description of the coordinate system.
May also include a link to a documentation page or paper describing the
system in greater detail.
type: string
EEGCoordinateUnits:
name: EEGCoordinateUnits
display_name: EEG Coordinate Units
description: |
Units of the coordinates of `EEGCoordinateSystem`.
type: string
# TODO: Add definitions for these values. (perhaps don't specify)
enum:
- m
- mm
- cm
- n/a
EEGGround:
name: EEGGround
display_name: EEG Ground
description: |
Description of the location of the ground electrode
(for example, `"placed on right mastoid (M2)"`).
type: string
EEGPlacementScheme:
name: EEGPlacementScheme
display_name: EEG Placement Scheme
description: |
Placement scheme of EEG electrodes.
Either the name of a standardized placement system (for example, `"10-20"`)
or a list of standardized electrode names (for example, `["Cz", "Pz"]`).
type: string
EEGReference:
name: EEGReference
display_name: EEG Reference
description: |
General description of the reference scheme used and (when applicable) of
location of the reference electrode in the raw recordings
(for example, `"left mastoid"`, `"Cz"`, `"CMS"`).
If different channels have a different reference,
this field should have a general description and the channel specific
reference should be defined in the `channels.tsv` file.
type: string
EMGChannelCount:
name: EMGChannelCount
display_name: EMG Channel Count
description: |
Number of EMG channels.
type: integer
minimum: 0
EOGChannelCount:
name: EOGChannelCount
display_name: EOG Channel Count
description: |
Number of EOG channels.
type: integer
minimum: 0
EchoAcquisition:
name: EchoAcquisition
display_name: Echo Acquisition
description: |
How the detected echo was acquired when the analog-to-digital converter was turned on.
For example, `"Half echo"`, `"Full echo"`.
type: string
EchoTime:
name: EchoTime
display_name: Echo Time
description: |
The echo time (TE) for the acquisition, specified in seconds.
Corresponds to [DICOM Tag 0018, 0081](https://dicomlookup.com/dicomtags/(0018,0081)) `Echo Time`
(please note that the DICOM term is in milliseconds not seconds).
The data type number may apply to files from any MRI modality concerned with
a single value for this field, or to the files in a
[file collection](SPEC_ROOT/appendices/file-collections.md)
where the value of this field is iterated using the
[`echo` entity](SPEC_ROOT/appendices/entities.md#echo).
anyOf:
- type: number
unit: s
exclusiveMinimum: 0
- type: array
items:
type: number
unit: s
exclusiveMinimum: 0
EchoTime1:
name: EchoTime1
display_name: Echo Time1
description: |
The time (in seconds) when the first (shorter) echo occurs.
type: number
unit: s
exclusiveMinimum: 0
EchoTime2:
name: EchoTime2
display_name: Echo Time2
description: |
The time (in seconds) when the second (longer) echo occurs.
type: number
unit: s
exclusiveMinimum: 0
# Redefinition of EchoTime for fieldmap data
EchoTime__fmap:
name: EchoTime
display_name: Echo Time
description: |
The time (in seconds) when the echo corresponding to this map was acquired.
type: number
unit: s
exclusiveMinimum: 0
EditCondition:
name: EditCondition
display_name: Editing Condition
description: |
If spectral editing was applied, this lists the application order of `"EditPulse"`.
For example, `["ON", "OFF"]` for a MEGA-edited experiment or
`["A", "B", "C", "D"]` for a HERMES-edited experiment.
anyOf:
- type: string
- type: array
items:
type: string
EditPulse:
name: EditPulse
display_name: Editing Pulse
description: |
If spectral editing was applied, this details the editing parameters.
For example:
`{"ON": {"FrequencyOffset": 1.9, "PulseDuration": 16},
"OFF": {"FrequencyOffset": 7.5, "PulseDuration": 16}}`.