bids-specification/src/schema/meta/templates.yaml at 2fe2e8eef1e12a974dc55e572024b154d07c00c3 · bids-standard/bids-specification · GitHub

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
---
# This section is unstructured, for inclusion in rules by reference

# Entities that apply to most raw files
# Include thus:
#
# filerule:
#   entities:
#     $ref: meta.templates.raw.base.entities
#     task: optional
#     ...
#   datatypes:
#     ...
raw:
  base:
    entities:
      subject: required
      session: optional

  recording:
    entities:
      $ref: meta.templates.raw.base.entities
      acquisition: optional
      run: optional

  task:
    entities:
      $ref: meta.templates.raw.recording.entities
      task: required

  mri:
    entities:
      $ref: meta.templates.raw.recording.entities
      ceagent: optional
      reconstruction: optional
      chunk: optional

  epi:
    entities:
      $ref: meta.templates.raw.mri.entities
      direction: optional
      part: optional

  pet:
    entities:
      $ref: meta.templates.raw.base.entities
      task: optional
      tracer: optional
      reconstruction: optional
      run: optional

  mrs:
    entities:
      $ref: meta.templates.raw.recording.entities
      task: optional
      nucleus: optional
      volume: optional
      reconstruction: optional

# Entities that apply to most derivative files
# Include thus:
#
# filerule:
#   entities:
#     $ref: meta.templates.deriv.base.entities
#     task: optional
#     ...
#   datatypes:
#     ...
deriv:
  base:
    selectors:
      - dataset.dataset_description.DatasetType == 'derivative'
    entities:
      subject: optional
      session: optional
      description: optional

  spatial:
    $ref: meta.templates.deriv.base
    entities:
      $ref: meta.templates.deriv.base.entities
      space: optional

  # Imaging derivatives
  volumetric:
    $ref: meta.templates.deriv.spatial
    extensions:
      - .nii.gz
      - .nii
      - .ome.zarr/
      - .json
    entities:
      $ref: meta.templates.deriv.spatial.entities
      resolution: optional

  surface:
    $ref: meta.templates.deriv.spatial
    entities:
      $ref: meta.templates.deriv.spatial.entities
      hemisphere: optional
      density: optional

  mask:
    $ref: meta.templates.deriv.volumetric
    suffixes:
      - mask
    entities:
      $ref: meta.templates.deriv.volumetric.entities
      label: optional

  dseg:
    $ref: meta.templates.deriv.volumetric
    extensions:
      - .nii.gz
      - .nii
      - .tsv
      - .json
    suffixes:
      - dseg
    entities:
      $ref: meta.templates.deriv.volumetric.entities
      atlas: optional
      segmentation: optional
      scale: optional

  probseg:
    $ref: meta.templates.deriv.volumetric
    extensions:
      - .nii.gz
      - .nii
      - .json
    suffixes:
      - probseg
    entities:
      $ref: meta.templates.deriv.volumetric.entities
      atlas: optional
      segmentation: optional
      scale: optional
      label: optional

  dseg_surface:
    $ref: meta.templates.deriv.surface
    extensions:
      - .label.gii
      - .dlabel.nii
      - .tsv
      - .json
    suffixes:
      - dseg
    entities:
      $ref: meta.templates.deriv.surface.entities
      atlas: optional
      segmentation: optional
      scale: optional

# Entities that apply to most atlas files
# Include thus:
#
# filerule:
#   entities:
#     $ref: meta.templates.atlas.base.entities
atlas:
  base:
    entities:
      template: required
      cohort: optional