FCP-INDI / fcp-indi.github.io

Github Pages Repo for FCP-INDI
https://fcp-indi.github.io
2 stars 8 forks source link

📚 Document lack of support for CIFTI atlases #238

Closed shnizzedy closed 4 years ago

shnizzedy commented 4 years ago

Fixes

Fixes #231 by @shnizzedy & @lgibson212

Description

  1. Adds to the bottom of docs/nightly/user/pipeline_config#definitions:
  • Atlas

    An atlas provides a guide to the location of anatomical features in a coordinate space.

    —[1] p. 55

    An atlas provides a defined coordinate space, a template for aligning images, and labels for regions of interest.

    Currently C-PAC only supports atlases in NifTI format.

    CIFTI is a popular atlas format not yet supported by C-PAC. As always, if anyone wants to share any tips or hacks with us, we are an open-source platform after all. Below are some resources that might help enable CIFTI atlas support in a future version of C-PAC.

    CIFTI Resources

  • Template

    A template is an image that is representative of the atlas and provides a target to which individual images can be aligned. —[1] p. 55

Reference [1] (1,2) Poldrack, R. A., Mumford, J. A., and Nichols, T. E. 2011 August. Handbook of Functional MRI Data Analysis. New York: Cambridge University Press.

With individual definition's SSOT at docs/nightly/glossary/atlas and docs/nightly/glossary/template and the atlas support text and resources (.. include::d in the atlas definition source) docs/nightly/developer/atlas_support

  1. Installs and configures sphinxcontrib-bibtex in the interest of single-sourcing references and their formatting. Documentation for this plugin added to CONTRIBUTING.

  2. Updates the BibTeX in the quickstart to specify that the capitalization of "Configurable Pipeline for the Analysis of Connectomes (C-PAC)" should remain as-is in sentence case.

Screenshots

end of definitions

Checklist

Developer Certificate of Origin

Developer Certificate of Origin ``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```
shnizzedy commented 4 years ago

As always with the documentation PRs, please check the language and placement.

For this one in particular, would something be preferable to quoting the definitions of "atlas" and "template" from Russ's book?