You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/01overview.rst
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,5 +16,5 @@ The analysis spaces (or regions of interest) are defined by an ``Atlas``. While
16
16
There are three main steps to using this framework on new data:
17
17
18
18
* **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.
Copy file name to clipboardExpand all lines: docs/02atlas.rst
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
Atlases, Regions, and Parcellations
2
2
===================================
3
3
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.
6
6
7
7
Atlas Spaces
8
8
------------
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/>`_.
10
10
11
11
The following spaces are defined so far:
12
12
* ``MNI152NLin6Asym``: MNI152NLin6Asym space, the standard MNI space template in FSL
@@ -45,7 +45,7 @@ Optional fields:
45
45
* ``res``: resolution (not used yet) - voxel locations are defined by mask image
46
46
* ``normspace``: Norm space for suit.vol2surf -
47
47
48
-
Getting atlases
48
+
Getting Atlases
49
49
---------------
50
50
You can get an atlas by calling:
51
51
@@ -59,7 +59,7 @@ You can get an atlas by calling:
59
59
60
60
Defining new Atlases or Regions
61
61
-------------------------------
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.
63
63
64
64
.. code-block:: python
65
65
@@ -68,7 +68,7 @@ If an Atlas or Region is not defined in the repository, you can obtain a new Atl
68
68
``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.
69
69
70
70
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.
0 commit comments