Skip to content

Commit 3af3faa

Browse files
committed
documenatation
1 parent 9a5aeb1 commit 3af3faa

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/01overview.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ The analysis spaces (or regions of interest) are defined by an ``Atlas``. While
1616
There are three main steps to using this framework on new data:
1717

1818
* **Data Import**: Bringing the data into the common framework. This includes the import of the preprocessed time series or the contrast (beta) estimates. The data files are stored in the ``ffimport`` directory. A number of :ref:`datasets` are already imported and can be downloaded freely.
19-
* **Data Extraction**: Pull the data in a specific atlas space, defined by an ``atlas``. The resulting CIFTI-file are by default stored in the ``ffextract`` directory for each dataset for quick retrieval.
20-
* **Data Analysis**: After the data is extracted, you can simply load the data with ``dataset.get_data()``. which gives you a ``(nsubj x nfeatures x voxel/vertices)`` tensor. You can then perform any analysis on this data. The repository provides a number of common analysis function for data aggregation and reliability estimation.
19+
* **Data Extraction**: Pull the data in a specific atlas space, defined by an ``Atlas``. The resulting CIFTI-file are by default stored in the ``ffextract`` directory for each dataset for quick retrieval.
20+
* **Data Analysis**: After the data is extracted, you can simply load the data from the ``ffextract`` directory with ``dataset.get_data()``. which gives you a ``(nsubj x nfeatures x voxel/vertices)`` tensor. You can then perform any analysis on this data. The repository provides a number of common analysis function for data aggregation and reliability estimation.

docs/02atlas.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
Atlases, Regions, and Parcellations
22
===================================
33

4-
The Atlas class defines the atlas space, the voxel resolution, and the set of voxels or vertices that will form the basis of the analysis.
5-
Subclasses are ``AtlasVolumetric``, and ``AtlasSurface``. Each Atlas contains :math:`P` locations (vertices or voxels) that are being sampled for the analysis.
4+
The ``Atlas`` class defines the atlas space, the voxel resolution, and the set of voxels or vertices that will form the basis of the analysis.
5+
Subclasses are ``AtlasVolumetric``, and ``AtlasSurface``. Each atlas contains :math:`P` locations (vertices or voxels) that are being sampled for the analysis.
66

77
Atlas Spaces
88
------------
9-
Each Atlas is defined in a specific space. The atlas space defines how data is transformed between Native space and the atlas, or between different atlases. ``Functional_Fusion`` follows the convention of atlas space naming used in `Templateflow.org <https://www.templateflow.org/>`_.
9+
Each atlas is defined in a specific space. The atlas space defines how data is transformed between native space and the atlas, or between different atlases. ``Functional_Fusion`` follows the convention of atlas space naming used in `Templateflow.org <https://www.templateflow.org/>`_.
1010

1111
The following spaces are defined so far:
1212
* ``MNI152NLin6Asym``: MNI152NLin6Asym space, the standard MNI space template in FSL
@@ -45,7 +45,7 @@ Optional fields:
4545
* ``res``: resolution (not used yet) - voxel locations are defined by mask image
4646
* ``normspace``: Norm space for suit.vol2surf -
4747

48-
Getting atlases
48+
Getting Atlases
4949
---------------
5050
You can get an atlas by calling:
5151

@@ -59,7 +59,7 @@ You can get an atlas by calling:
5959

6060
Defining new Atlases or Regions
6161
-------------------------------
62-
If an Atlas or Region is not defined in the repository, you can obtain a new Atlas object by calling the constructor of the Atlas class.
62+
If an atlas or region is not defined in the repository, you can obtain a new Atlas object by calling the constructor of the Atlas class.
6363

6464
.. code-block:: python
6565
@@ -68,7 +68,7 @@ If an Atlas or Region is not defined in the repository, you can obtain a new Atl
6868
``mask.nii`` is a `NIFTI` file that defines the voxels of the atlas, ``structure`` is the `CIFTI`-structure name, and ``space`` is the space in which the atlas is defined.
6969

7070

71-
If an Atlas or Region is not defined in the repository, you can obtain a new Atlas object by calling the constructor of the Atlas class.
71+
If an atlas or region is not defined in the repository, you can obtain a new ``Atlas`` object by calling the constructor of the ``Atlas`` class.
7272

7373
.. code-block:: python
7474

0 commit comments

Comments
 (0)