README.rst 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  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 is a `DataLad <https://www.datalad.org/>`__ dataset. It provides
  37. fine-grained data access down to the level of individual files, and allows for
  38. tracking future updates up to the level of single files. In order to use
  39. this repository for data retrieval, `DataLad <https://www.datalad.org>`_ is
  40. required. It is a free and open source command line tool, available for all
  41. major operating systems, and builds up on Git and `git-annex
  42. <https://git-annex.branchable.com>`__ to allow sharing, synchronizing, and
  43. version controlling collections of large files. You can find information on
  44. how to install DataLad at `handbook.datalad.org/en/latest/intro/installation.html
  45. <http://handbook.datalad.org/en/latest/intro/installation.html>`_.
  46. Get the dataset
  47. ^^^^^^^^^^^^^^^
  48. A DataLad dataset can be ``cloned`` by running::
  49. datalad clone <url>
  50. Once a dataset is cloned, it is a light-weight directory on your local machine.
  51. At this point, it contains only small metadata and information on the
  52. identity of the files in the dataset, but not actual *content* of the
  53. (sometimes large) data files.
  54. Retrieve dataset content
  55. ^^^^^^^^^^^^^^^^^^^^^^^^
  56. After cloning a dataset, you can retrieve file contents by running::
  57. datalad get <path/to/directory/or/file>
  58. This command will trigger a download of the files, directories, or
  59. subdatasets you have specified.
  60. DataLad datasets can contain other datasets, so called *subdatasets*. If you
  61. clone the top-level dataset, subdatasets do not yet contain metadata and
  62. information on the identity of files, but appear to be empty directories. In
  63. order to retrieve file availability metadata in subdatasets, run::
  64. datalad get -n <path/to/subdataset>
  65. Afterwards, you can browse the retrieved metadata to find out about
  66. subdataset contents, and retrieve individual files with ``datalad get``. If you
  67. use ``datalad get <path/to/subdataset>``, all contents of the subdataset will
  68. be downloaded at once.
  69. Stay up-to-date
  70. ^^^^^^^^^^^^^^^
  71. DataLad datasets can be updated. The command ``datalad update`` will *fetch*
  72. updates and store them on a different branch (by default
  73. ``remotes/origin/master``). Running::
  74. datalad update --merge
  75. will *pull* available updates and integrate them in one go.
  76. More information
  77. ^^^^^^^^^^^^^^^^
  78. More information on DataLad and how to use it can be found in the DataLad Handbook at
  79. `handbook.datalad.org <http://handbook.datalad.org/en/latest/index.html>`_. The
  80. chapter "DataLad datasets" can help you to familiarize yourself with the
  81. concept of a dataset.
  82. .. _Git: http://www.git-scm.com
  83. .. _git-annex: http://git-annex.branchable.com/
  84. .. |license|
  85. image:: https://img.shields.io/badge/license-PDDL-blue.svg
  86. :target: http://opendatacommons.org/licenses/pddl/summary
  87. :alt: PDDL-licensed
  88. .. |access|
  89. image:: https://img.shields.io/badge/data_access-unrestricted-green.svg
  90. :alt: No registration or authentication required