Templates and atlases
In the following, we describe how the outcomes of analyses that produce templates and atlases are organized as BIDS-Derivatives.
Important
For outcomes of analyses corresponding to individual subjects that derive from atlases and may refer to spaces other than the original subject's space, please refer to the Derivatives from atlases subsection.
Derived templates
Many analyses include spatial standardization to pull individuals' data into a common spatial frame. For example, creating an atlas will most likely require the creation of a new template or the integration of existing ones to define a stereotactic space.
For derivatives of template-generating pipelines, which typically aggregate
several sessions and/or subjects, the derivatives-specific
tpl-<label>
entity indicates that the
spatial frame of analysis is not defined by a single brain image but an
aggregation thereof.
Recommendation
The selected <label>
in the tpl-<label>
entity
is RECOMMENDED for the space-<label>
entity
in downstream derivatives from this particular template (see previous section
Derivatives from atlases).
Template:
<pipeline_name>/
tpl-<label>/
[cohort-<label>/]
[<datatype>/]
tpl-<label>_[cohort-<label>][_space-<label>][_atlas-<label>][seg-<label>][_scale-<label>][_res-<label>][_den-<label>][_desc-<label>]_<suffix>.<extension>
where suffix
SHOULD be an existing BIDS modality
such as T1w
or PET
; and
extension
MAY take values such as nii[.gz]
, dscalar.nii[.gz]
,
dlabel.nii[.gz]
, label.gii[.gz]
, tsv
, or json
.
The <datatype>/
directory MAY be omitted in the case
only one data type (such as anat/
) is stored under the tpl-<label>/
directory.
The cohort-<label>
directory and entity MUST be specified for templates
with several cohorts.
Dataset structure
In templates/atlases the tpl-<label>
and
cohort-<label>
entities are structurally
analogous to the sub-<label>
and ses-<label>
entities,
appearing as both directories and entities.
The cohort-<label>
entity is used
to track mappings of arbitrary subject/session pairs.
In BIDS, a template is considered any aggregation of data and the tpl-
entity
replaces the subject-level sub-
entity when aggregating data across subjects.
The tpl-
entity and sub-
entity are mutually exclusive in a given file.
When the tpl-
entity is used without the atlas-
entity, as in the following examples,
the imaging data serves as an instantiation of a space.
When the tpl-
entity is used in conjunction with the atlas-
entity,
the intention is to describe aggregations of data in a particular space,
as described in the Derived atlases section, below.
For uses of the atlas-
entity without the tpl-
entity,
see Imaging derivatives - Derivatives from atlases.
Example: the MNI152NLin2009cAsym
template
For the pipeline that generated MNI152NLin2009cAsym
,
the outputs could look like the following example:
└─ mni152nlin2009casym-pipeline/
└─ tpl-MNI152NLin2009cAsym/
└─ anat/
├─ tpl-MNI152NLin2009cAsym_res-1_label-brain_mask.nii.gz
├─ tpl-MNI152NLin2009cAsym_res-1_label-eye_mask.nii.gz
├─ tpl-MNI152NLin2009cAsym_res-1_label-face_mask.nii.gz
├─ tpl-MNI152NLin2009cAsym_res-1_label-head_mask.nii.gz
├─ tpl-MNI152NLin2009cAsym_res-1_label-CSF_probseg.nii.gz
├─ tpl-MNI152NLin2009cAsym_res-1_label-GM_probseg.nii.gz
├─ tpl-MNI152NLin2009cAsym_res-1_label-WM_probseg.nii.gz
├─ tpl-MNI152NLin2009cAsym_res-1_T1w.nii.gz
├─ tpl-MNI152NLin2009cAsym_res-1_T1w.json
├─ tpl-MNI152NLin2009cAsym_res-2_label-brain_mask.nii.gz
├─ tpl-MNI152NLin2009cAsym_res-2_label-eye_mask.nii.gz
├─ tpl-MNI152NLin2009cAsym_res-2_label-face_mask.nii.gz
├─ tpl-MNI152NLin2009cAsym_res-2_label-head_mask.nii.gz
├─ tpl-MNI152NLin2009cAsym_res-2_label-CSF_probseg.nii.gz
├─ tpl-MNI152NLin2009cAsym_res-2_label-GM_probseg.nii.gz
├─ tpl-MNI152NLin2009cAsym_res-2_label-WM_probseg.nii.gz
├─ tpl-MNI152NLin2009cAsym_res-2_T1w.nii.gz
└─ tpl-MNI152NLin2009cAsym_res-2_T1w.json
Example: multi-cohort templates
In the case that the template-generating pipeline derives
several cohorts, the file structure must employ the
cohort-<label>
directory and entity.
└─ mnipediatricasym-pipeline/
└─ tpl-MNIPediatricAsym/
├─ cohort-1/
│ └─ anat/
│ ├─ tpl-MNIPediatricAsym_cohort-1_res-1_PD.nii.gz
│ ├─ tpl-MNIPediatricAsym_cohort-1_res-1_T1w.nii.gz
│ ├─ tpl-MNIPediatricAsym_cohort-1_res-1_T2w.nii.gz
│ ├─ tpl-MNIPediatricAsym_cohort-1_res-1_desc-brain_mask.nii.gz
│ ├─ tpl-MNIPediatricAsym_cohort-1_res-1_label-CSF_probseg.nii.gz
│ ├─ tpl-MNIPediatricAsym_cohort-1_res-1_label-GM_probseg.nii.gz
│ ├─ tpl-MNIPediatricAsym_cohort-1_res-1_label-WM_probseg.nii.gz
│ ├─ tpl-MNIPediatricAsym_cohort-1_res-2_PD.nii.gz
│ ├─ tpl-MNIPediatricAsym_cohort-1_res-2_T1w.nii.gz
│ ├─ tpl-MNIPediatricAsym_cohort-1_res-2_T2w.nii.gz
│ ├─ tpl-MNIPediatricAsym_cohort-1_res-2_desc-brain_mask.nii.gz
│ ├─ tpl-MNIPediatricAsym_cohort-1_res-2_label-CSF_probseg.nii.gz
│ ├─ tpl-MNIPediatricAsym_cohort-1_res-2_label-GM_probseg.nii.gz
│ └─ tpl-MNIPediatricAsym_cohort-1_res-2_label-WM_probseg.nii.gz
├─ ...
└─ cohort-6/
└─ anat/
├─ tpl-MNIPediatricAsym_cohort-6_res-1_PD.nii.gz
├─ tpl-MNIPediatricAsym_cohort-6_res-1_T1w.nii.gz
├─ tpl-MNIPediatricAsym_cohort-6_res-1_T2w.nii.gz
├─ tpl-MNIPediatricAsym_cohort-6_res-1_desc-brain_mask.nii.gz
├─ tpl-MNIPediatricAsym_cohort-6_res-1_label-CSF_probseg.nii.gz
├─ tpl-MNIPediatricAsym_cohort-6_res-1_label-GM_probseg.nii.gz
├─ tpl-MNIPediatricAsym_cohort-6_res-1_label-WM_probseg.nii.gz
├─ tpl-MNIPediatricAsym_cohort-6_res-2_PD.nii.gz
├─ tpl-MNIPediatricAsym_cohort-6_res-2_T1w.nii.gz
├─ tpl-MNIPediatricAsym_cohort-6_res-2_T2w.nii.gz
├─ tpl-MNIPediatricAsym_cohort-6_res-2_desc-brain_mask.nii.gz
├─ tpl-MNIPediatricAsym_cohort-6_res-2_label-CSF_probseg.nii.gz
├─ tpl-MNIPediatricAsym_cohort-6_res-2_label-GM_probseg.nii.gz
└─ tpl-MNIPediatricAsym_cohort-6_res-2_label-WM_probseg.nii.gz
Subject-level and template derivatives
Both subject-level and template-level results MAY coexist in a single pipeline directory. If the subject-level results based on which a template was generated are to be shared with the template, it is RECOMMENDED to store both families of results within the pipeline directory:
└─ mni152nlin2009casym-pipeline/
├─ sub-001/
│ └─ anat/
│ ├─ sub-001_from-T1w_to-MNI152NLin2009cAsym_mode-image_xfm.h5
│ ├─ sub-001_space-MNI152NLin2009cAsym_T1w.nii.gz
│ └─ sub-001_T1w.nii.gz
├─ ...
├─ sub-152/
│ └─ anat/
│ ├─ sub-152_from-T1w_to-MNI152NLin2009cAsym_mode-image_xfm.h5
│ ├─ sub-152_space-MNI152NLin2009cAsym_T1w.nii.gz
│ └─ sub-152_T1w.nii.gz
└─ tpl-MNI152NLin2009cAsym/
└─ anat/
├─ tpl-MNI152NLin2009cAsym_res-1_label-brain_mask.nii.gz
├─ ...
└─ tpl-MNI152NLin2009cAsym_res-2_T1w.json
Warning
Please note that the specification for spatial transforms (BEP 014) is currently under development, and therefore, the specification of transforms files may change in the future.
Single-subject templates
Early digital templates and atlases such as MNI's 'Colin 27 Average Brain, Stereotaxic Registration Model' (Holmes et al., 1998) were built by examining single individuals. For example, the outputs of the pipeline that generated 'Colin27' would have been organized as follows:
└─ colin27-pipeline/
├─ sub-01/
│ ├─ ses-01/
│ │ └─ anat/
│ │ ├─ sub-01_ses-01_label-brain_mask.nii.gz
│ │ ├─ sub-01_ses-01_label-head_mask.nii.gz
│ │ ├─ sub-01_ses-01_T1w.nii.gz
│ │ └─ sub-01_ses-01_T1w.json
│ ├─ ses-02/
│ │ └─ anat/
│ │ ├─ sub-01_ses-02_label-brain_mask.nii.gz
│ │ ├─ sub-01_ses-02_label-head_mask.nii.gz
│ │ ├─ sub-01_ses-02_T1w.nii.gz
│ │ └─ sub-01_ses-02_T1w.json
│ ├─ ...
│ └─ ses-27/
│ └─ anat/
│ ├─ sub-01_ses-27_label-brain_mask.nii.gz
│ ├─ sub-01_ses-27_label-head_mask.nii.gz
│ ├─ sub-01_ses-27_T1w.nii.gz
│ └─ sub-01_ses-27_T1w.json
└─ tpl-Colin27/
└─ anat/
├─ tpl-Colin27_probseg.nii.gz
├─ tpl-Colin27_label-brain_mask.nii.gz
├─ tpl-Colin27_label-head_mask.nii.gz
├─ tpl-Colin27_T1w.nii.gz
└─ tpl-Colin27_T1w.json
Derived atlases
Atlas identification and metadata
The atlas-<label>_description.json
file provides metadata to uniquely identify,
describe and characterize the atlas, as well as give proper attribution to the creators.
Atlases MUST include atlas-<label>_description.json
files
corresponding to the atlas or atlases in the structure.
Recommendation
The selected <label>
in the atlas-<label>_description.json
file is RECOMMENDED
for the atlas-<label>
entity
in downstream derivatives from this particular atlas (see previous section
Derivatives from atlases).
Template:
<pipeline_name>/
tpl-<label>/
atlas-<label>_description.json
[cohort-<label>/]
[<datatype>/]
tpl-<label>_[cohort-<label>][_space-<label>][_atlas-<label>][seg-<label>][_scale-<label>][_res-<label>][_den-<label>][_desc-<label>]_<suffix>.<extension>
Atlas metadata fields:
Key name | Requirement Level | Data type | Description |
---|---|---|---|
Name | REQUIRED | string | Name of the atlas. |
SampleSize | REQUIRED | number | Number of items (typically, independent participants, although it could also refer, for example, to sessions) that employed to create the corresponding atlas. |
SpatialReference | REQUIRED | string or object | For images with a single reference, the value MUST be a single string. For images with multiple references, such as surface and volume references, a JSON object MUST be used. |
Description | RECOMMENDED | string | Free-form natural language description. |
Authors | RECOMMENDED | array of strings | List of individuals who contributed to the creation/curation of the dataset. |
Curators | RECOMMENDED | array of strings | List of curators who helped make the atlas accessible in a database or dataset. |
Funding | RECOMMENDED | array of strings | List of sources of funding (grant numbers). |
License | RECOMMENDED | string | The license for the dataset. The use of license name abbreviations is RECOMMENDED for specifying a license (see Licenses). The corresponding full license text MAY be specified in an additional LICENSE file. |
ReferencesAndLinks | RECOMMENDED | array of strings | List of references to publications that contain information on the dataset. A reference may be textual or a URI. |
Species | RECOMMENDED | string | The species the atlas was derived from. For example, could be Human, Macaque, Rat, or Mouse. |
DerivedFrom | RECOMMENDED | string | Indicate what data modality the atlas was derived from, for example, "cytoarchitecture", "resting-state", "task". |
LevelType | RECOMMENDED | string | Indicate what analysis level the atlas was derived from, for example, "group", "individual". |
Additionally, SpatialReference
serves the important purpose of unambiguously identifying
the space the atlas is labeled in.
Example atlas-MyAtlas2025_description.json
:
{
"Name": "A new atlas of the human brain",
"Authors": [
"Jane Doe",
"John Doe"
],
"SpatialReference": "https://templateflow.s3.amazonaws.com/tpl-MNI152NLin6Asym_res-02_T1w.nii.gz",
"License": "CC0",
"RRID": "SCR_002823",
"Species": "Human"
}
Deriving templates and atlases
A common use-case of brain templates is establishing stereotaxy for the creation of atlases. For example, the Spatially Unbiased Infratentorial Template (SUIT; Diedrichsen, 2006), presents an atlas template of the human cerebellum and brainstem based on the anatomy of 20 young healthy individuals.
The authors first developed a template of the cerebellum and brainstem, which is spatially standardized in MNI space. This could be the organization of the template part:
└─ suit-pipeline/
└─ tpl-SUIT/
└─ anat/
├─ tpl-SUIT_T1w.nii.gz
├─ tpl-SUIT_flat.surf.gii
└─ tpl-SUIT_sulc.shape.gii
Once the standard space of analysis was prepared, a first atlas was developed in 2009, integrating some segmentations and parcellations:
└─ suit-pipeline/
└─ tpl-SUIT/
└─ anat/
├─ atlas-Diedrichsen2009_description.json
├─ tpl-SUIT_T1w.nii.gz
├─ tpl-SUIT_dseg.json
├─ tpl-SUIT_dseg.label.gii
├─ tpl-SUIT_dseg.nii.gz
├─ tpl-SUIT_dseg.tsv
├─ tpl-SUIT_probseg.nii.gz
├─ tpl-SUIT_flat.surf.gii
└─ tpl-SUIT_sulc.shape.gii
where atlas-Diedrichsen2009_description.json
could contain:
{
"Name": "A probabilistic MR atlas of the human cerebellum",
"Authors": [
"Jörn Diedrichsen",
"Joshua H Balsters",
"Jonathan Flavell",
"Emma Cussans",
"Narender Ramnani"
],
"Sample Size": 20,
"SpatialReference": "https://templateflow.s3.amazonaws.com/tpl-MNI152Lin_res-01_T1w.nii.gz",
"License": "LICENSE file",
"ReferencesAndLinks": [
"https://doi.org/10.1016/j.neuroimage.2009.01.045",
"https://github.com/jdiedrichsen/suit"
],
"Species": "Human"
}
Finally, in 2011 a second atlas was developed integrating new segmentations.
Now, to disambiguate between the two atlases,
the atlas-<label>
entity MUST be used:
└─ suit-pipeline/
└─ tpl-SUIT/
└─ anat/
├─ atlas-Buckner2011_description.json
├─ atlas-Diedrichsen2009_description.json
├─ tpl-SUIT_T1w.nii.gz
├─ tpl-SUIT_atlas-Buckner2011_dseg.json
├─ tpl-SUIT_atlas-Buckner2011_seg-17n_dseg.label.gii
├─ tpl-SUIT_atlas-Buckner2011_seg-17n_dseg.nii.gz
├─ tpl-SUIT_atlas-Buckner2011_seg-17n_dseg.tsv
├─ tpl-SUIT_atlas-Buckner2011_seg-17n_stat-confidence_probseg.nii.gz
├─ tpl-SUIT_atlas-Buckner2011_seg-7n_dseg.label.gii
├─ tpl-SUIT_atlas-Buckner2011_seg-7n_dseg.nii.gz
├─ tpl-SUIT_atlas-Buckner2011_seg-7n_dseg.tsv
├─ tpl-SUIT_atlas-Buckner2011_seg-7n_stat-confidence_probseg.nii.gz
├─ tpl-SUIT_atlas-Diedrichsen2009_dseg.json
├─ tpl-SUIT_atlas-Diedrichsen2009_dseg.label.gii
├─ tpl-SUIT_atlas-Diedrichsen2009_dseg.nii.gz
├─ tpl-SUIT_atlas-Diedrichsen2009_dseg.tsv
├─ tpl-SUIT_atlas-Diedrichsen2009_probseg.nii.gz
├─ tpl-SUIT_flat.surf.gii
└─ tpl-SUIT_sulc.shape.gii
where atlas-Diedrichsen2009_description.json
remains as above,
and atlas-Buckner2011_description.json
could contain:
{
"Name": "Atlas of the human cerebellum estimated by intrinsic functional connectivity",
"Authors": [
"Randy L Buckner",
"Fenna M Krienen",
"Angela Castellanos",
"Julio C Diaz",
"B T Thomas Yeo"
],
"Sample Size": 1000,
"SpatialReference": "https://templateflow.s3.amazonaws.com/tpl-MNI152Lin_res-01_T1w.nii.gz",
"License": "LICENSE file",
"ReferencesAndLinks": [
"https://doi.org/10.1152/jn.00339.2011",
"https://github.com/jdiedrichsen/suit"
],
"Species": "Human"
}
Deriving a new atlas referenced in an existing template
For example, the MIAL67ThalamicNuclei
(Najdenovska et al., 2018)
atlas-generation pipeline could display the following structure:
└─ mial67thalamicnuclei-pipeline/
├─ sub-01/
│ └─ anat/
│ ├─ sub-01_seg-ThalamicNuclei_dseg.json
│ ├─ sub-01_seg-ThalamicNuclei_dseg.tsv
│ ├─ sub-01_seg-ThalamicNuclei_dseg.nii.gz
│ ├─ sub-01_space-MNI152NLin2009cAsym_T1w.nii.gz
│ └─ sub-01_T1w.nii.gz
├─ ...
├─ sub-67/
│ └─ anat/
│ ├─ sub-67_seg-ThalamicNuclei_dseg.json
│ ├─ sub-67_seg-ThalamicNuclei_dseg.tsv
│ ├─ sub-67_seg-ThalamicNuclei_dseg.nii.gz
│ ├─ sub-67_space-MNI152NLin2009cAsym_T1w.nii.gz
│ └─ sub-67_T1w.nii.gz
└─ tpl-MNI152NLin2009cAsym/
└─ anat/
├─ atlas-MIAL67ThalamicNuclei_description.json
├─ tpl-MNI152NLin2009cAsym_dseg.json
├─ tpl-MNI152NLin2009cAsym_dseg.tsv
├─ tpl-MNI152NLin2009cAsym_res-1_dseg.nii.gz
└─ tpl-MNI152NLin2009cAsym_res-1_probseg.nii.gz
where the derivatives of anatomical processing of the 67 subjects that were employed to generate the atlas coexist with the template structure.
The inheritance principle applies uniformly, allowing the segmentation metadata be stored only once at the root of the pipeline directory and apply to all the individual subject segmentations:
└─ mial67thalamicnuclei-pipeline/
├─ seg-ThalamicNuclei_dseg.json
├─ seg-ThalamicNuclei_dseg.tsv
├─ sub-01/
│ └─ anat/
│ ├─ sub-01_seg-ThalamicNuclei_dseg.nii.gz
│ ├─ sub-01_space-MNI152NLin2009cAsym_T1w.nii.gz
│ └─ sub-01_T1w.nii.gz
├─ ...
├─ sub-67/
│ └─ anat/
│ ├─ sub-67_seg-ThalamicNuclei_dseg.nii.gz
│ ├─ sub-67_space-MNI152NLin2009cAsym_T1w.nii.gz
│ └─ sub-67_T1w.nii.gz
└─ tpl-MNI152NLin2009cAsym/
└─ anat/
├─ atlas-MIAL67ThalamicNuclei_description.json
├─ tpl-MNI152NLin2009cAsym_dseg.json
├─ tpl-MNI152NLin2009cAsym_dseg.tsv
├─ tpl-MNI152NLin2009cAsym_res-1_dseg.nii.gz
└─ tpl-MNI152NLin2009cAsym_res-1_probseg.nii.gz
In the case the pipeline generated atlas-based segmentations of the original subjects in
their native T1w space (for example, to compare with the original segmentation given by
seg-ThalamicNuclei
), the above example translates into:
└─ mial67thalamicnuclei-pipeline/
├─ atlas-MIAL67ThalamicNuclei_dseg.json
├─ atlas-MIAL67ThalamicNuclei_dseg.tsv
├─ seg-ThalamicNuclei_dseg.json
├─ seg-ThalamicNuclei_dseg.tsv
├─ sub-01/
│ └─ anat/
│ ├─ sub-01_atlas-MIAL67ThalamicNuclei_dseg.nii.gz
│ ├─ sub-01_seg-ThalamicNuclei_dseg.nii.gz
│ ├─ sub-01_space-MNI152NLin2009cAsym_T1w.nii.gz
│ └─ sub-01_T1w.nii.gz
├─ ...
├─ sub-67/
│ └─ anat/
│ ├─ sub-67_atlas-MIAL67ThalamicNuclei_dseg.nii.gz
│ ├─ sub-67_seg-ThalamicNuclei_dseg.nii.gz
│ ├─ sub-67_space-MNI152NLin2009cAsym_T1w.nii.gz
│ └─ sub-67_T1w.nii.gz
└─ tpl-MNI152NLin2009cAsym/
└─ anat/
├─ atlas-MIAL67ThalamicNuclei_description.json
├─ tpl-MNI152NLin2009cAsym_res-1_dseg.nii.gz
└─ tpl-MNI152NLin2009cAsym_res-1_probseg.nii.gz
Deriving one atlas from two or more existing templates
This directory structure can be generally applied when the atlas is derived into several template spaces, for example:
└─ mial67thalamicnuclei-pipeline/
├─ atlas-MIAL67ThalamicNuclei_dseg.json
├─ atlas-MIAL67ThalamicNuclei_dseg.tsv
├─ seg-ThalamicNuclei_dseg.json
├─ seg-ThalamicNuclei_dseg.tsv
├─ sub-01/
│ └─ anat/
│ ├─ sub-01_seg-ThalamicNuclei_dseg.nii.gz
│ ├─ sub-01_space-MNI152NLin2009cAsym_T1w.nii.gz
│ ├─ sub-01_space-MNI152NLin6Asym_T1w.nii.gz
│ └─ sub-01_T1w.nii.gz
├─ ...
├─ sub-67/
│ └─ anat/
│ ├─ sub-67_seg-ThalamicNuclei_dseg.nii.gz
│ ├─ sub-67_space-MNI152NLin2009cAsym_T1w.nii.gz
│ ├─ sub-67_space-MNI152NLin6Asym_T1w.nii.gz
│ └─ sub-67_T1w.nii.gz
├─ tpl-MNI152NLin2009cAsym/
│ └─ anat/
│ ├─ atlas-MIAL67ThalamicNuclei_description.json
│ ├─ tpl-MNI152NLin2009cAsym_res-1_dseg.nii.gz
│ └─ tpl-MNI152NLin2009cAsym_res-1_probseg.nii.gz
└─ tpl-MNI152NLin6Asym/
└─ anat/
├─ atlas-MIAL67ThalamicNuclei_description.json
├─ tpl-MNI152NLin6Asym_res-1_dseg.nii.gz
└─ tpl-MNI152NLin6Asym_res-1_probseg.nii.gz
Without any loss in generality, we can store subjects' spatially normalizing transforms, as well as transforms between template spaces:
└─ mial67thalamicnuclei-pipeline/
├─ atlas-MIAL67ThalamicNuclei_description.json
├─ atlas-MIAL67ThalamicNuclei_dseg.json
├─ atlas-MIAL67ThalamicNuclei_dseg.tsv
├─ seg-ThalamicNuclei_dseg.json
├─ seg-ThalamicNuclei_dseg.tsv
├─ sub-01/
│ └─ anat/
│ ├─ sub-01_from-T1w_to-MNI152NLin2009cAsym_mode-image_xfm.h5
│ ├─ sub-01_from-T1w_to-MNI152NLin6Asym_mode-image_xfm.h5
│ ├─ sub-01_seg-ThalamicNuclei_dseg.nii.gz
│ ├─ sub-01_space-MNI152NLin2009cAsym_T1w.nii.gz
│ ├─ sub-01_space-MNI152NLin6Asym_T1w.nii.gz
│ └─ sub-01_T1w.nii.gz
├─ ...
├─ sub-67/
│ └─ anat/
│ ├─ sub-67_from-T1w_to-MNI152NLin2009cAsym_mode-image_xfm.h5
│ ├─ sub-67_from-T1w_to-MNI152NLin6Asym_mode-image_xfm.h5
│ ├─ sub-67_seg-ThalamicNuclei_dseg.nii.gz
│ ├─ sub-67_space-MNI152NLin2009cAsym_T1w.nii.gz
│ ├─ sub-67_space-MNI152NLin6Asym_T1w.nii.gz
│ └─ sub-67_T1w.nii.gz
├─ tpl-MNI152NLin2009cAsym/
│ └─ anat/
│ ├─ tpl-MNI152NLin2009cAsym_from-MNI152NLin6Asym_mode-image_xfm.h5
│ ├─ tpl-MNI152NLin2009cAsym_res-1_dseg.nii.gz
│ └─ tpl-MNI152NLin2009cAsym_res-1_probseg.nii.gz
└─ tpl-MNI152NLin6Asym/
└─ anat/
├─ tpl-MNI152NLin6Asym_res-1_dseg.nii.gz
└─ tpl-MNI152NLin6Asym_res-1_probseg.nii.gz
A more comprehensive example.
For example, the PS13 atlas,
a molecular imaging brain atlas of Cyclooxygenase-1 (PET),
was generated in two standard spaces
(MNI152Lin
and fsaverage
):
└─ ps13-pipeline/
├─ atlas-ps13_description.json
├─ tpl-fsaverage/
│ └─ pet/
│ ├─ tpl-fsaverage_desc-nopvc_pet.json
│ ├─ tpl-fsaverage_desc-nopvc_pet.nii.gz
│ ├─ tpl-fsaverage_desc-pvc_pet.json
│ ├─ tpl-fsaverage_desc-pvc_pet.nii.gz
│ ├─ tpl-fsaverage_dseg.json
│ ├─ tpl-fsaverage_dseg.tsv
│ ├─ tpl-fsaverage_hemi-L_den-164k_desc-nopvc_pet.json
│ ├─ tpl-fsaverage_hemi-L_den-164k_desc-nopvc_pet.shape.gii
│ ├─ tpl-fsaverage_hemi-L_den-164k_desc-pvc_pet.json
│ ├─ tpl-fsaverage_hemi-L_den-164k_desc-pvc_pet.shape.gii
│ ├─ tpl-fsaverage_hemi-L_den-164k_stat-std_desc-nopvc_pet.json
│ ├─ tpl-fsaverage_hemi-L_den-164k_stat-std_desc-nopvc_pet.shape.gii
│ ├─ tpl-fsaverage_hemi-L_den-164k_stat-std_desc-pvc_pet.json
│ ├─ tpl-fsaverage_hemi-L_den-164k_stat-std_desc-pvc_pet.shape.gii
│ ├─ tpl-fsaverage_hemi-R_den-164k_desc-nopvc_pet.json
│ ├─ tpl-fsaverage_hemi-R_den-164k_desc-nopvc_pet.shape.gii
│ ├─ tpl-fsaverage_hemi-R_den-164k_desc-pvc_pet.json
│ ├─ tpl-fsaverage_hemi-R_den-164k_desc-pvc_pet.shape.gii
│ ├─ tpl-fsaverage_hemi-R_den-164k_stat-std_desc-nopvc_pet.json
│ ├─ tpl-fsaverage_hemi-R_den-164k_stat-std_desc-nopvc_pet.shape.gii
│ ├─ tpl-fsaverage_hemi-R_den-164k_stat-std_desc-pvc_pet.json
│ ├─ tpl-fsaverage_hemi-R_den-164k_stat-std_desc-pvc_pet.shape.gii
│ ├─ tpl-fsaverage_seg-nopvc_dseg.nii.gz
│ ├─ tpl-fsaverage_seg-pvc_dseg.nii.gz
│ ├─ tpl-fsaverage_stat-std_desc-nopvc_pet.json
│ ├─ tpl-fsaverage_stat-std_desc-nopvc_pet.nii.gz
│ ├─ tpl-fsaverage_stat-std_desc-pvc_pet.json
│ └─ tpl-fsaverage_stat-std_desc-pvc_pet.nii.gz
└─ tpl-MNI152Lin/
└─ pet/
├─ tpl-MNI152Lin_dseg.json
├─ tpl-MNI152Lin_dseg.tsv
├─ tpl-MNI152Lin_res-1p5_desc-spmvbmNopvc_pet.json
├─ tpl-MNI152Lin_res-1p5_desc-spmvbmNopvc_pet.nii.gz
├─ tpl-MNI152Lin_res-1p5_desc-spmvbmPvc_pet.json
├─ tpl-MNI152Lin_res-1p5_desc-spmvbmPvc_pet.nii.gz
├─ tpl-MNI152Lin_res-1p5_stat-std_desc-spmvbmNopvc_pet.json
├─ tpl-MNI152Lin_res-1p5_stat-std_desc-spmvbmNopvc_pet.nii.gz
├─ tpl-MNI152Lin_res-1p5_stat-std_desc-spmvbmPvc_pet.json
├─ tpl-MNI152Lin_res-1p5_stat-std_desc-spmvbmPvc_pet.nii.gz
├─ tpl-MNI152Lin_res-2_desc-fnirtNopvc_pet.json
├─ tpl-MNI152Lin_res-2_desc-fnirtNopvc_pet.nii.gz
├─ tpl-MNI152Lin_res-2_desc-fnirtPvc_pet.json
├─ tpl-MNI152Lin_res-2_desc-fnirtPvc_pet.nii.gz
├─ tpl-MNI152Lin_res-2_desc-nopvc_pet.json
├─ tpl-MNI152Lin_res-2_desc-nopvc_pet.nii.gz
├─ tpl-MNI152Lin_res-2_desc-pvc_pet.json
├─ tpl-MNI152Lin_res-2_desc-pvc_pet.nii.gz
├─ tpl-MNI152Lin_res-2_stat-std_desc-fnirtNopvc_pet.json
├─ tpl-MNI152Lin_res-2_stat-std_desc-fnirtNopvc_pet.nii.gz
├─ tpl-MNI152Lin_res-2_stat-std_desc-fnirtPvc_pet.json
├─ tpl-MNI152Lin_res-2_stat-std_desc-fnirtPvc_pet.nii.gz
├─ tpl-MNI152Lin_res-2_stat-std_desc-nopvc_pet.json
├─ tpl-MNI152Lin_res-2_stat-std_desc-nopvc_pet.nii.gz
├─ tpl-MNI152Lin_res-2_stat-std_desc-pvc_pet.json
├─ tpl-MNI152Lin_res-2_stat-std_desc-pvc_pet.nii.gz
├─ tpl-MNI152Lin_seg-nopvc_dseg.nii.gz
└─ tpl-MNI152Lin_seg-pvc_dseg.nii.gz
If the pipeline generates two different atlases for at least one template space
in the output, then atlas-<label>
is REQUIRED
for disambiguation.
For example, let's imagine the PS13 atlas is revised in 2034, and based on the
original pipeline and data, it generates now a new manual segmentation
in the MNI152Lin
space
with some new regions defined.
The new atlas can be structured as follows:
└─ ps13rev2034-pipeline/
├─ atlas-ps13_description.json
├─ tpl-fsaverage/
│ └─ pet/
│ ├─ tpl-fsaverage_seg-nopvc_dseg.nii.gz
│ ├─ tpl-fsaverage_seg-pvc_dseg.nii.gz
│ ├─ tpl-fsaverage_dseg.json
│ ├─ tpl-fsaverage_dseg.tsv
│ ├─ tpl-fsaverage_hemi-L_den-164k_desc-nopvc_pet.json
│ ├─ ...
│ └─ tpl-fsaverage_stat-std_desc-pvc_pet.nii.gz
└─ tpl-MNI152Lin/
└─ pet/
├─ atlas-ps13rev2034_description.json
├─ tpl-MNI152Lin_atlas-ps13_seg-nopvc_dseg.nii.gz
├─ tpl-MNI152Lin_atlas-ps13_seg-pvc_dseg.nii.gz
├─ tpl-MNI152Lin_atlas-ps13_dseg.json
├─ tpl-MNI152Lin_atlas-ps13_dseg.tsv
├─ tpl-MNI152Lin_atlas-ps13_res-1p5_desc-spmvbmNopvc_pet.json
├─ ...
├─ tpl-MNI152Lin_atlas-ps13_res-2_stat-std_desc-pvc_pet.nii.gz
├─ tpl-MNI152Lin_atlas-ps13rev2034_seg-nopvc_dseg.nii.gz
├─ tpl-MNI152Lin_atlas-ps13rev2034_seg-pvc_dseg.nii.gz
├─ tpl-MNI152Lin_atlas-ps13rev2034_dseg.json
└─ tpl-MNI152Lin_atlas-ps13rev2034_dseg.tsv
Deriving an atlas in a study-specific template space and generating conversions to pre-existing template references
A usual scenario involves the generation of the atlas in a new, study-specific space and then provide resamplings of the template with reference to existing, standard spaces.
In this case, all atlas' derivatives MUST be stored within a single tpl-<label>/
directory
For example, if the previous PS13 example had been generated that way, the previous
example would be updated as follows:
└─ ps13-pipeline/
├─ atlas-ps13_description.json
└─ tpl-ps13/
└─ pet/
├─ tpl-ps13_desc-nopvc_pet.json
├─ tpl-ps13_desc-nopvc_pet.nii.gz
├─ tpl-ps13_desc-pvc_pet.json
├─ tpl-ps13_desc-pvc_pet.nii.gz
├─ tpl-ps13_space-fsaverage_desc-nopvc_pet.json
├─ tpl-ps13_space-fsaverage_desc-nopvc_pet.nii.gz
├─ tpl-ps13_space-fsaverage_desc-pvc_pet.json
├─ tpl-ps13_space-fsaverage_desc-pvc_pet.nii.gz
├─ tpl-ps13_space-fsaverage_dseg.json
├─ tpl-ps13_space-fsaverage_dseg.tsv
├─ tpl-ps13_space-fsaverage_hemi-L_den-164k_desc-nopvc_pet.json
├─ tpl-ps13_space-fsaverage_hemi-L_den-164k_desc-nopvc_pet.shape.gii
├─ tpl-ps13_space-fsaverage_hemi-L_den-164k_desc-pvc_pet.json
├─ tpl-ps13_space-fsaverage_hemi-L_den-164k_desc-pvc_pet.shape.gii
├─ tpl-ps13_space-fsaverage_hemi-L_den-164k_stat-std_desc-nopvc_pet.json
├─ tpl-ps13_space-fsaverage_hemi-L_den-164k_stat-std_desc-nopvc_pet.shape.gii
├─ tpl-ps13_space-fsaverage_hemi-L_den-164k_stat-std_desc-pvc_pet.json
├─ tpl-ps13_space-fsaverage_hemi-L_den-164k_stat-std_desc-pvc_pet.shape.gii
├─ tpl-ps13_space-fsaverage_hemi-R_den-164k_desc-nopvc_pet.json
├─ tpl-ps13_space-fsaverage_hemi-R_den-164k_desc-nopvc_pet.shape.gii
├─ tpl-ps13_space-fsaverage_hemi-R_den-164k_desc-pvc_pet.json
├─ tpl-ps13_space-fsaverage_hemi-R_den-164k_desc-pvc_pet.shape.gii
├─ tpl-ps13_space-fsaverage_hemi-R_den-164k_stat-std_desc-nopvc_pet.json
├─ tpl-ps13_space-fsaverage_hemi-R_den-164k_stat-std_desc-nopvc_pet.shape.gii
├─ tpl-ps13_space-fsaverage_hemi-R_den-164k_stat-std_desc-pvc_pet.json
├─ tpl-ps13_space-fsaverage_hemi-R_den-164k_stat-std_desc-pvc_pet.shape.gii
├─ tpl-ps13_space-fsaverage_seg-nopvc_dseg.nii.gz
├─ tpl-ps13_space-fsaverage_seg-pvc_dseg.nii.gz
├─ tpl-ps13_space-fsaverage_stat-std_desc-nopvc_pet.json
├─ tpl-ps13_space-fsaverage_stat-std_desc-nopvc_pet.nii.gz
├─ tpl-ps13_space-fsaverage_stat-std_desc-pvc_pet.json
├─ tpl-ps13_space-fsaverage_stat-std_desc-pvc_pet.nii.gz
├─ tpl-ps13_space-MNI152Lin_dseg.json
├─ tpl-ps13_space-MNI152Lin_dseg.tsv
├─ tpl-ps13_space-MNI152Lin_res-1p5_desc-spmvbmNopvc_pet.json
├─ tpl-ps13_space-MNI152Lin_res-1p5_desc-spmvbmNopvc_pet.nii.gz
├─ tpl-ps13_space-MNI152Lin_res-1p5_desc-spmvbmPvc_pet.json
├─ tpl-ps13_space-MNI152Lin_res-1p5_desc-spmvbmPvc_pet.nii.gz
├─ tpl-ps13_space-MNI152Lin_res-1p5_stat-std_desc-spmvbmNopvc_pet.json
├─ tpl-ps13_space-MNI152Lin_res-1p5_stat-std_desc-spmvbmNopvc_pet.nii.gz
├─ tpl-ps13_space-MNI152Lin_res-1p5_stat-std_desc-spmvbmPvc_pet.json
├─ tpl-ps13_space-MNI152Lin_res-1p5_stat-std_desc-spmvbmPvc_pet.nii.gz
├─ tpl-ps13_space-MNI152Lin_res-2_desc-fnirtNopvc_pet.json
├─ tpl-ps13_space-MNI152Lin_res-2_desc-fnirtNopvc_pet.nii.gz
├─ tpl-ps13_space-MNI152Lin_res-2_desc-fnirtPvc_pet.json
├─ tpl-ps13_space-MNI152Lin_res-2_desc-fnirtPvc_pet.nii.gz
├─ tpl-ps13_space-MNI152Lin_res-2_desc-nopvc_pet.json
├─ tpl-ps13_space-MNI152Lin_res-2_desc-nopvc_pet.nii.gz
├─ tpl-ps13_space-MNI152Lin_res-2_desc-pvc_pet.json
├─ tpl-ps13_space-MNI152Lin_res-2_desc-pvc_pet.nii.gz
├─ tpl-ps13_space-MNI152Lin_res-2_stat-std_desc-fnirtNopvc_pet.json
├─ tpl-ps13_space-MNI152Lin_res-2_stat-std_desc-fnirtNopvc_pet.nii.gz
├─ tpl-ps13_space-MNI152Lin_res-2_stat-std_desc-fnirtPvc_pet.json
├─ tpl-ps13_space-MNI152Lin_res-2_stat-std_desc-fnirtPvc_pet.nii.gz
├─ tpl-ps13_space-MNI152Lin_res-2_stat-std_desc-nopvc_pet.json
├─ tpl-ps13_space-MNI152Lin_res-2_stat-std_desc-nopvc_pet.nii.gz
├─ tpl-ps13_space-MNI152Lin_res-2_stat-std_desc-pvc_pet.json
├─ tpl-ps13_space-MNI152Lin_res-2_stat-std_desc-pvc_pet.nii.gz
├─ tpl-ps13_space-MNI152Lin_seg-nopvc_dseg.nii.gz
└─ tpl-ps13_space-MNI152Lin_seg-pvc_dseg.nii.gz
where tpl-ps13_desc-nopvc_pet.nii.gz
and tpl-ps13_desc-pvc_pet.nii.gz
SHOULD NOT define
a space-<label>
and therefore
MUST be defined in the space defined by tpl-<label>
entity,
that is, the study-specific template.
This example can be further extended to the example in which a revision of the atlas
is done later in time:
└─ ps13-pipeline/
├─ atlas-ps13_description.json
├─ atlas-ps13rev2034_description.json
└─ tpl-ps13/
└─ pet/
├─ tpl-ps13_space-fsaverage_atlas-ps13_seg-nopvc_dseg.nii.gz
├─ tpl-ps13_space-fsaverage_atlas-ps13_seg-pvc_dseg.nii.gz
├─ tpl-ps13_space-fsaverage_atlas-ps13_dseg.json
├─ tpl-ps13_space-fsaverage_atlas-ps13_dseg.tsv
├─ tpl-ps13_space-fsaverage_atlas-ps13_hemi-L_den-164k_desc-nopvc_pet.json
├─ ...
├─ tpl-ps13_space-fsaverage_atlas-ps13_stat-std_desc-pvc_pet.nii.gz
├─ tpl-ps13_space-MNI152Lin_atlas-ps13_seg-nopvc_dseg.nii.gz
├─ tpl-ps13_space-MNI152Lin_atlas-ps13_seg-pvc_dseg.nii.gz
├─ tpl-ps13_space-MNI152Lin_atlas-ps13_dseg.json
├─ tpl-ps13_space-MNI152Lin_atlas-ps13_dseg.tsv
├─ tpl-ps13_space-MNI152Lin_atlas-ps13_res-1p5_desc-spmvbmNopvc_pet.json
├─ tpl-ps13_space-MNI152Lin_atlas-ps13_res-2_stat-std_desc-pvc_pet.nii.gz
├─ tpl-ps13_space-MNI152Lin_atlas-ps13rev2034_seg-nopvc_dseg.nii.gz
├─ tpl-ps13_space-MNI152Lin_atlas-ps13rev2034_seg-pvc_dseg.nii.gz
├─ tpl-ps13_space-MNI152Lin_atlas-ps13rev2034_dseg.json
└─ tpl-ps13_space-MNI152Lin_atlas-ps13rev2034_dseg.tsv
Single-subject atlases
Single-subject atlases regularly follow the previously described BIDS Derivatives and single-subject template specifications.