Skip to content

Commit

Permalink
Replace Schaefer atlases with AtlasPack (#928)
Browse files Browse the repository at this point in the history
  • Loading branch information
tsalo authored Sep 13, 2023
1 parent c230b7e commit 5a856ec
Show file tree
Hide file tree
Showing 57 changed files with 1,476 additions and 6,489 deletions.
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ orbs:
.dockersetup:
&dockersetup
docker:
- image: pennlinc/xcp_d_build:0.0.6rc15
- image: pennlinc/xcp_d_build:0.0.7
working_directory: /src/xcp_d

runinstall:
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM pennlinc/xcp_d_build:0.0.6rc15
FROM pennlinc/xcp_d_build:0.0.7

# Install xcp_d
COPY . /src/xcp_d
Expand Down
2 changes: 2 additions & 0 deletions docs/links.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@
.. _`Docker installation`: https://docs.docker.com/install/
.. _`Docker Hub`: https://hub.docker.com/r/pennlinc/xcp_d/tags
.. _`Singularity`: https://sylabs.io/guides/3.5/user-guide/introduction.html
.. _`QSIPrep`: https://qsiprep.readthedocs.io
.. _`ASLPrep`: https://aslprep.readthedocs.io
41 changes: 34 additions & 7 deletions docs/outputs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
Outputs of *XCP-D*
##################

The ``xcp_d`` outputs are written out in BIDS format and consist of three main parts.
The *XCP-D* outputs are written out in BIDS format and consist of three main parts.

.. admonition:: A note on BIDS compliance

``xcp_d`` attempts to follow the BIDS specification as best as possible.
However, many ``xcp_d`` derivatives are not currently covered by the specification.
*XCP-D* attempts to follow the BIDS specification as best as possible.
However, many *XCP-D* derivatives are not currently covered by the specification.
In those instances, we attempt to follow recommendations from existing BIDS Extension Proposals
(BEPs), which are in-progress proposals to add new features to BIDS.

Three BEPs that are of particular use in ``xcp_d`` are
Three BEPs that are of particular use in *XCP-D* are
`BEP012: Functional preprocessing derivatives <https://github.com/bids-standard/bids-specification/pull/519>`_,
`BEP017: BIDS connectivity matrix data schema <https://docs.google.com/document/d/1ugBdUF6dhElXdj3u9vw0iWjE6f_Bibsro3ah7sRV0GA/edit?usp=sharing>`_,
and
Expand All @@ -24,8 +24,8 @@ The ``xcp_d`` outputs are written out in BIDS format and consist of three main
In cases where a derivative type is not covered by an existing BEP,
we have simply attempted to follow the general principles of BIDS.

If you discover a problem with the BIDS compliance of ``xcp_d``'s derivatives, please open an
issue in the ``xcp_d`` repository.
If you discover a problem with the BIDS compliance of *XCP-D*'s derivatives, please open an
issue in the *XCP-D* repository.


***************
Expand All @@ -44,6 +44,33 @@ The executive summary is based on the DCAN lab's
sub-<label>[_ses-<label>]_executive_summary.html
*************************
Parcellations and Atlases
*************************

*XCP-D* produces parcellated anatomical and functional outputs using a series of atlases.
The individual outputs are documented in the relevant sections of this document,
with this section describing the atlases themselves.

The atlases currently used in *XCP-D* can be separated into three groups: subcortical, cortical,
and combined cortical/subcortical.
The two subcortical atlases are the Tian atlas :footcite:p:`tian2020topographic` and the
CIFTI subcortical parcellation.
The cortical atlases are the Glasser :footcite:p:`Glasser_2016` and the
Gordon :footcite:p:`Gordon_2014`.
The combined cortical/subcortical atlases are 10 different resolutions of the
4S (Schaefer Supplemented with Subcortical Structures) atlas.

The 4S atlas combines the Schaefer 2018 cortical atlas (version v0143) :footcite:p:`Schaefer_2017`
at 10 different resolutions (100, 200, 300, 400, 500, 600, 700, 800, 900, and 1000 parcels) with
the CIT168 subcortical atlas :footcite:p:`pauli2018high`,
the Diedrichson cerebellar atlas :footcite:p:`king2019functional`,
and the HCP thalamic atlas :footcite:p:`najdenovska2018vivo`.
The 4S atlas is used in the same manner across three PennLINC BIDS Apps:
XCP-D, QSIPrep_, and ASLPrep_, to produce synchronized outputs across modalities.
For more information about the 4S atlas, please see https://github.com/PennLINC/AtlasPack.


******************
Anatomical Outputs
******************
Expand Down Expand Up @@ -116,7 +143,7 @@ functional connectivity matrices, and resting-state derivatives.

.. important::

Prior to version 0.4.0, the denoised data outputted by ``xcp_d`` was interpolated,
Prior to version 0.4.0, the denoised data outputted by *XCP-D* was interpolated,
meaning that high-motion volumes were replaced with interpolated data prior to temporal
filtering.
**This was a bug.**
Expand Down
9 changes: 2 additions & 7 deletions docs/workflows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -392,13 +392,8 @@ Parcellation and functional connectivity estimation
:func:`~xcp_d.workflows.connectivity.init_functional_connectivity_cifti_wf`

The ``filtered, denoised BOLD`` is fed into a functional connectivity workflow,
which extracts parcel-wise time series from the BOLD using several atlases:

a. Schaefer 100, 200, 300, 400, 500, 600, 700, 800, 900, and 1000 parcel resolutions
b. Glasser 360
c. Gordon 333
d. Tian Subcortical Atlas :footcite:p:`tian2020topographic`
e. HCP Subcortical Atlas :footcite:p:`glasser2013minimal`
which extracts parcel-wise time series from the BOLD using several atlases.
These atlases are documented in :doc:`outputs`.

The resulting parcellated time series for each atlas is then used to generate static functional
connectivity matrices, as measured with Pearson correlation coefficients.
Expand Down
Loading

0 comments on commit 5a856ec

Please sign in to comment.