Skip to content

Commit 074ae6f

Browse files
effigiesmelanieganzPeerHerholzCPernetoesteban
authored
BEP-038: Atlases (#1714)
Co-authored-by: melanieganz <[email protected]> Co-authored-by: PeerHerholz <[email protected]> Co-authored-by: Cyril Pernet <[email protected]> Co-authored-by: Oscar Esteban <[email protected]> Co-authored-by: James Kent <[email protected]> Co-authored-by: melanieganz <[email protected]> Co-authored-by: Paul Wighton <[email protected]> Co-authored-by: mnoergaard <[email protected]> Co-authored-by: Taylor Salo <[email protected]> Co-authored-by: Mathieu Guay-Paquet <[email protected]> Co-authored-by: Mark Mikkelsen <[email protected]> Co-authored-by: Yaroslav Halchenko <[email protected]>
1 parent a7a9d80 commit 074ae6f

24 files changed

+1419
-51
lines changed

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ nav:
2929
- BIDS Derivatives: derivatives/introduction.md
3030
- Common data types and metadata: derivatives/common-data-types.md
3131
- Imaging data types: derivatives/imaging.md
32+
- Templates and atlases: derivatives/atlas.md
3233
- Longitudinal and multi-site studies: longitudinal-and-multi-site-studies.md
3334
- Glossary: glossary.md
3435
- BIDS Extension Proposals: extensions.md

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/common-principles.md

Lines changed: 30 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+
template (`tpl-<label>`) directories may be found at the root of the dataset,
134+
and these may include cohort (`cohort-<label>`) subdirectories.
135+
These directories are described in [Templates and atlases](derivatives/atlas.md).
136+
131137
### Other top level directories
132138

133139
In addition to the subject directories, the root directory of a BIDS dataset
@@ -297,6 +303,15 @@ However, in the case that these data are to be included:
297303
through the `sourcedata/` directory mechanism.
298304
In the case of source data, these aspects are likely more stringent.
299305

306+
**Templates and atlases as derived data.**
307+
Templates and atlases are key neuroscientific tools to carry out group-level inferences
308+
and also employed in many atlas-based methodologies (such as atlas-based segmentation).
309+
Original templates and atlases employed as primary data to the analysis MAY be stored
310+
within the `sourcedata/atlases/` directory.
311+
Atlases and artifacts derived from atlases are considered derived data
312+
and MUST be stored as derivative datasets,
313+
as described in the next section.
314+
300315
### Storage of derived datasets
301316

302317
Derivatives can be stored/distributed in two ways:
@@ -332,6 +347,15 @@ Derivatives can be stored/distributed in two ways:
332347
<dataset>/derivatives/spm-stats/sub-0001
333348
```
334349
350+
Example of an atlas-generating pipeline, including outputs for individual subjects
351+
prior to aggregation in the
352+
[`MNI152NLin2009cAsym` standard space](appendices/coordinate-systems.md):
353+
354+
```Plain
355+
<dataset>/derivatives/atlasgenerator/sub-0001
356+
<dataset>/derivatives/atlasgenerator/tpl-MNI152NLin2009cAsym
357+
```
358+
335359
Example of a pipeline with nested derivative directories:
336360
337361
```Plain
@@ -386,11 +410,14 @@ Case 2.
386410
In both cases, every derivatives dataset is considered a BIDS dataset and must
387411
include a `dataset_description.json` file at the root level (see
388412
[Dataset description][dataset-description]).
389-
Consequently, files should be organized to comply with BIDS to the full extent
413+
Consequently, files SHOULD be organized to comply with BIDS to the full extent
390414
possible (that is, unless explicitly contradicted for derivatives).
391-
Any subject-specific derivatives should be housed within each subject's directory;
392-
if session-specific derivatives are generated, they should be deposited under a
415+
Any subject-specific derivatives SHOULD be housed within each subject's directory;
416+
if session-specific derivatives are generated, they SHOULD be deposited under a
393417
session subdirectory within the corresponding subject directory; and so on.
418+
Likewise, any template-specific derivatives SHOULD be housed within each template's directory;
419+
if cohort-specific derivatives are generated, they SHOULD be deposited under a
420+
cohort subdirectory within the corresponding template directory; and so on.
394421
395422
### Non-compliant derivatives
396423

0 commit comments

Comments
 (0)