Skip to content

Commit

Permalink
Merge pull request #2466 from nipreps/docs/1847-spaces
Browse files Browse the repository at this point in the history
DOC: Clarify that ``res-2`` entity does not mean 2mm
  • Loading branch information
oesteban authored Jul 20, 2021
2 parents e82deba + ab5825f commit 934f41b
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/spaces.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,15 @@ the data on ``MNI152NLin6Asym`` space and the original BOLD resolution
This is equivalent to saying
``--output-spaces MNI152NLin6Asym:res-2 MNI152NLin2009cAsym:res-native``.

.. danger::

Please remember that the ``resolution`` entity of *TemplateFlow* is an **index**,
and therefore, ``res-2`` does not necessarily mean 2mm\ :sup:`3` - although, it
coincidentally does in the example above.
However, it may not be the case.
For instance, ``MNI152NLin6Asym:res-3`` contains a template with
isotropic voxels of 0.5mm\ :sup:`3`.

Other possible modifiers are, for instance, the ``cohort`` selector.
For instance, ``--output-spaces MNIPediatricAsym:res-1:cohort-2`` selects
the resolution ``1`` of ``cohort-2`` which, for the ``MNIPediatricAsym``
Expand Down

0 comments on commit 934f41b

Please sign in to comment.