From 48b76a666bc5a59b40e5b6cb9fe434aca5d80e40 Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauld.mccarthy@gmail.com>
Date: Fri, 14 Apr 2017 18:53:10 +0100
Subject: [PATCH] Some more docs in featdesign
---
fsl/data/featdesign.py | 15 ++++++++++-----
1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/fsl/data/featdesign.py b/fsl/data/featdesign.py
index 0ba4e3682..c271fc59e 100644
--- a/fsl/data/featdesign.py
+++ b/fsl/data/featdesign.py
@@ -141,7 +141,10 @@ class FEATFSFDesign(object):
:func:`.featanalysis.loadSettings`.
:arg loadVoxelwiseEVs: If ``True`` (the default), image files
- for all voxelwise EVs are loaded.
+ for all voxelwise EVs are loaded. Otherwise
+ they are not loaded, and all calls to
+ meth:`getDesign` will contain the mean
+ data for any voxelwise EV columns.
"""
if settings is None:
@@ -201,10 +204,12 @@ class FEATFSFDesign(object):
def getDesign(self, voxel=None):
"""Returns the design matrix for the specified voxel.
- :arg voxel: A tuple containing the ``(x, y, z)`` voxel coordinates
- of interest. If ``None`` (the default), the design
- matrix is returned, with any voxelwise EV columns
- containing the mean voxelwise EV data.
+ :arg voxel: A tuple containing the ``(x, y, z)`` voxel coordinates of
+ interest. If ``None`` (the default), or if this
+ ``FEATFSFDesign`` was created with
+ ``loadVoxelwiseEVs=False``, the design matrix is returned,
+ with any voxelwise EV columns containing the mean
+ voxelwise EV data.
"""
design = np.array(self.__design)
--
GitLab