Skip to content

Commit dcd0f15

Browse files
committed
add documentation
1 parent c73fb80 commit dcd0f15

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

nipype/interfaces/dipy/simulate.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,20 @@ def _list_outputs(self):
180180

181181

182182
def _compute_voxel(args):
183+
"""
184+
Simulate DW signal for one voxel. Uses the multi-tensor model and
185+
three isotropic compartments.
186+
187+
Apparent diffusivity tensors are taken from [Alexander2002]_
188+
and [Pierpaoli1996]_.
189+
190+
.. [Alexander2002] Alexander et al., Detection and modeling of non-Gaussian
191+
apparent diffusion coefficient profiles in human brain data, MRM
192+
48(2):331-340, 2002, doi: `10.1002/mrm.10209
193+
<http://dx.doi.org/10.1002/mrm.10209>`_.
194+
.. [Pierpaoli1996] Pierpaoli et al., Diffusion tensor MR imaging
195+
of the human brain, Radiology 201:637-648. 1996.
196+
"""
183197
D_ball = [3000e-6, 960e-6, 680e-6]
184198
sf_evals = [1700e-6, 200e-6, 200e-6]
185199

0 commit comments

Comments
 (0)