utils_templateflow
Module to fetch a population average template from TemplateFlow.
Keywords : template, population average, reference
Inputs
Section titled “Inputs”Input 1
Section titled “Input 1”Format : tuple path(template), val(res), val(cohort)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| template | file | TemplateFlow template name. e.g. MNI152NLin2009cAsym Refer to the TemplateFlow documentation for available templates. https://www.templateflow.org/browse/ | True | |
| res | integer | Resolution of the template. This is optional, but will be used to fetch the template at the specified resolution and make it accessible in the output channels. | False | |
| cohort | integer | Cohort of the template. This is optional, but will be used to fetch the template for the specified cohort and make it accessible in the output channels. | False |
Outputs
Section titled “Outputs”folder
Section titled “folder”Format : path(tpl-${template})
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| tpl-${template} | directory | Directory containing the requested template, with all available resolutions and masks/maps. | True |
Format : path(*T1w.nii.gz)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| *T1w.nii.gz | file | T1w image of the requested template. | True |
Format : path(*T2w.nii.gz)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| *T2w.nii.gz | file | T2w image of the requested template. | True |
brain_mask
Section titled “brain_mask”Format : path(*desc-brain_mask.nii.gz)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| *desc-brain_mask.nii.gz | file | Brain mask of the requested template. | True |
label_CSF
Section titled “label_CSF”Format : path(*label-CSF_probseg.nii.gz)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| *label-CSF_probseg.nii.gz | file | CSF probability map of the requested template. | True |
label_GM
Section titled “label_GM”Format : path(*label-GM_probseg.nii.gz)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| *label-GM_probseg.nii.gz | file | GM probability map of the requested template. | True |
label_WM
Section titled “label_WM”Format : path(*label-WM_probseg.nii.gz)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| *label-WM_probseg.nii.gz | file | WM probability map of the requested template. | True |
metadata
Section titled “metadata”Format : path(${template}_metadata.json)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| ${template}_metadata.json | file | Metadata file containing information about the template. | True | *.json |
citations
Section titled “citations”Format : path(${template}_citations.bib)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| ${template}_citations.bib | file | File containing citations for the template. | True | *.bib |
versions
Section titled “versions”Format : path(versions.yml)
| Type | Description | Mandatory | Pattern | |
|---|---|---|---|---|
| versions.yml | file | File containing software versions | True | versions.yml |
| Description | DOI | |
|---|---|---|
| TemplateFlow | TemplateFlow is a modular, version-controlled resource that allows researchers to use templates “off-the-shelf”. | 10.1038/s41592-022-01681-2 |
Authors
Section titled “Authors”Last updated : 2025-10-30