Skip to content

Commit 0ec4649

Browse files
authored
Merge pull request #1856 from oesteban/bep038-review
Alternative proposal to BEP038
2 parents b527298 + d615e66 commit 0ec4649

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+2425
-816
lines changed

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ nav:
2424
- BIDS Derivatives: derivatives/introduction.md
2525
- Common data types and metadata: derivatives/common-data-types.md
2626
- Imaging data types: derivatives/imaging.md
27+
- Templates and atlases: derivatives/atlas.md
2728
- Longitudinal and multi-site studies: longitudinal-and-multi-site-studies.md
28-
- Atlases: atlas.md
2929
- Glossary: glossary.md
3030
- BIDS Extension Proposals: extensions.md
3131
- Appendix:

src/appendices/coordinate-systems.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,13 @@ However, their use is [DEPRECATED][deprecated].
225225
| fsaverage\[3\|4\|5\|6\|sym\] | Images were sampled to the FreeSurfer surface reconstructed from the subject's T1w image, and registered to an fsaverage template | fsaverage\[Sym\] |
226226
| UNCInfant\[0\|1\|2\]V\[21\|22\|23\] | Infant Brain Atlases from Neonates to 1- and 2-year-olds. [https://www.nitrc.org/projects/pediatricatlas](https://www.nitrc.org/projects/pediatricatlas) | UNCInfant |
227227

228+
!!! note "Important"
229+
230+
Please note that the template identifiers starting with `MNI` (for example `MNI305`)
231+
are typically referred to with the umbrella term of *MNI Space*.
232+
The [Common Principles](../common-principles.md#definitions) deliver a more precise definitions
233+
of template, space, and atlas.
234+
228235
### Nonstandard coordinate system identifiers
229236

230237
The following template identifiers are RECOMMENDED for individual- and study-specific reference

src/atlas.md

Lines changed: 0 additions & 672 deletions
This file was deleted.

src/common-principles.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,12 @@ data type as defined above.
128128
A data type directory SHOULD NOT be defined if there are no files to be placed
129129
in that directory.
130130

131+
**Specific structure of derived data**.
132+
In the case of [storing derived data (see below)](#source-vs-raw-vs-derived-data),
133+
the subject (`sub-<label>`) and session (`ses-<label>`) entities MAY map onto
134+
the template (`tpl-<label>`) and cohort (`cohort-<label>`) entities
135+
as described in the [corresponding section](derivatives/atlas.md) of this specification.
136+
131137
### Other top level directories
132138

133139
In addition to the subject directories, the root directory of a BIDS dataset
@@ -340,6 +346,16 @@ field in `dataset_description.json` of each subdirectory of `derivatives` to:
340346
through the `sourcedata/` directory mechanism.
341347
In the case of source data, these aspects are likely more stringent.
342348

349+
**Templates and atlases as derived data.**
350+
Templates and atlases are key neuroscientific tools to carry out group-level inferences
351+
and also employed in many atlas-based methodologies (such as atlas-based segmentation).
352+
Original templates and atlases employed as primary data to the analysis MAY be stored
353+
within the `sourcedata/atlases/`.
354+
Any artifacts deriving from atlases, or the creation of new templates and atlases MUST
355+
follow the [corresponding specification](derivatives/atlas.md) and stored under the
356+
`derivatives/` directory, and follow the general specifications for derivatives regarding
357+
storage and distribution, as described in the next section.
358+
343359
### Storage of derived datasets
344360

345361
Derivatives can be stored/distributed in two ways:
@@ -375,6 +391,15 @@ Derivatives can be stored/distributed in two ways:
375391
<dataset>/derivatives/spm-stats/sub-0001
376392
```
377393
394+
Example of an atlas-generating pipeline with outputs for individual subjects
395+
and the aggregation in an atlas defined with respect to the widely-used
396+
[`MNI152NLin2009cAsym` standard space](appendices/coordinate-systems.md):
397+
398+
```Plain
399+
<dataset>/derivatives/atlas-generator/sub-0001
400+
<dataset>/derivatives/atlas-generator/tpl-MNI152NLin2009cAsym
401+
```
402+
378403
Example of a pipeline with nested derivative directories:
379404
380405
```Plain
@@ -427,11 +452,14 @@ Case 2.
427452
In both cases, every derivatives dataset is considered a BIDS dataset and must
428453
include a `dataset_description.json` file at the root level (see
429454
[Dataset description][dataset-description]).
430-
Consequently, files should be organized to comply with BIDS to the full extent
455+
Consequently, files SHOULD be organized to comply with BIDS to the full extent
431456
possible (that is, unless explicitly contradicted for derivatives).
432-
Any subject-specific derivatives should be housed within each subject's directory;
433-
if session-specific derivatives are generated, they should be deposited under a
457+
Any subject-specific derivatives SHOULD be housed within each subject's directory;
458+
if session-specific derivatives are generated, they SHOULD be deposited under a
434459
session subdirectory within the corresponding subject directory; and so on.
460+
Likewise, any template-specific derivatives SHOULD be housed within each template's directory;
461+
if cohort-specific derivatives are generated, they SHOULD be deposited under a
462+
cohort subdirectory within the corresponding template directory; and so on.
435463
436464
### Non-compliant derivatives
437465

0 commit comments

Comments
 (0)