README.rst 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. studyforrest.org Dataset
  2. ************************
  3. |license| |access|
  4. Template images and image space transformations
  5. ===============================================
  6. This repository contains data derived from the raw data releases of the
  7. *studyforrest.org* project. In particular these are:
  8. * participant/scan-specific template images
  9. * transformation between these respective image spaces
  10. For more information about the project visit: http://studyforrest.org
  11. File name conventions
  12. ---------------------
  13. Each directory in the subject directories and the "templates" directory
  14. corresponds to one image template. Templates in ``sub*`` directories are
  15. participant-specific (not aligned across participants). However, templates with
  16. the same name have corresponding input data. Templates in the ``templates``
  17. directory have been derived from all participants, and there are typically
  18. transformation from participant specific templates into the group template
  19. space provided. Group template images carry a ``grp`` prefix in their label.
  20. All transformations are the output if FSL tools: either MAT files with
  21. 4x4 affine transformation matrices from FLIRT, or FNIRT warp files.
  22. Here is an example of how transformations can be located. The transformation
  23. of the template image created from all 3T BOLD images of participant ``01``
  24. acquired in phase 2 of the project into the group template space for 3T BOLD
  25. scans can be found in:
  26. ``sub-01/bold3Tp2/in_grpbold3Tp2/subj2tmpl_warp.nii.gz``
  27. Each template directory contains one or more image files with more-or-less
  28. self-explanatory names, such as "head", "brain", or "brain_mask". File with
  29. such a name in the one of the ``in_*`` folders represent the image in the parent
  30. folder, aligned and resliced to the target space for this transformation.
  31. These images can be used to inspect the quality of the transformation.
  32. Lastly, the ``code/`` directory contains the source code for computing template
  33. images and transformation between them.
  34. How to obtain the dataset
  35. -------------------------
  36. This repository contains metadata and information on the identity of all
  37. included files. However, the actual content of the (sometime large) data
  38. files is stored elsewhere. To obtain any dataset component, git-annex_ is
  39. required in addition to Git_.
  40. 1. Clone this repository to the desired location.
  41. 2. Enter the directory with the local clone and run::
  42. git annex init
  43. Older versions of git-annex may require you to run the following
  44. command immediately afterwards::
  45. git annex enableremote mddatasrc
  46. Now any desired dataset component can be obtained by using the ``git annex get``
  47. command. To obtain the entire dataset content run::
  48. git annex get .
  49. Keep data up-to-date
  50. --------------------
  51. If updates to this dataset are made in the future, update any local clone by
  52. running::
  53. git pull
  54. followed by::
  55. git annex get .
  56. to fetch all new files.
  57. .. _Git: http://www.git-scm.com
  58. .. _git-annex: http://git-annex.branchable.com/
  59. .. |license|
  60. image:: https://img.shields.io/badge/license-PDDL-blue.svg
  61. :target: http://opendatacommons.org/licenses/pddl/summary
  62. :alt: PDDL-licensed
  63. .. |access|
  64. image:: https://img.shields.io/badge/data_access-unrestricted-green.svg
  65. :alt: No registration or authentication required