~nipy-developers/nipy/fff2

223.1.1 by Gael Varoquaux
First version of the sphinx documentation. Documented the mask utilities to numpy documentation standards
1
Mask-extraction utilities
2
==========================
3
4
.. currentmodule:: fff2.utils.mask
5
6
The module :mod:`fff2.utils.mask` contains utilities to extract brain
7
masks from fMRI data:
8
9
.. autosummary::
10
    :toctree: generated
11
 
223.1.2 by Gael Varoquaux
DOC: Document the enn. Fix the custom sphinx directive to work with trunk sphinx
12
    compute_mask
223.1.1 by Gael Varoquaux
First version of the sphinx documentation. Documented the mask utilities to numpy documentation standards
13
    compute_mask_files
14
    compute_mask_sessions
15
16
The :func:`compute_mask_files` and :func:`compute_mask_sessions`
17
functions work with Nifti files rather than numpy ndarrays. This is
18
convenient to reduce memory pressure when working with long time series,
19
as there is no need to store the whole series in memory.
20
21