Skip to content

Commit

Permalink
Merge pull request #1304 from jhlegarreta/FixDTIReconstDocTypos
Browse files Browse the repository at this point in the history
DOC: Fix typos in dti.py reconstruction file doc.
  • Loading branch information
RafaelNH committed Jul 17, 2017
2 parents c155950 + 25489b2 commit 08d8d90
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions dipy/reconst/dti.py
Expand Up @@ -910,7 +910,7 @@ def mode(self):
@auto_attr
def md(self):
r"""
Mean diffusitivity (MD) calculated from cached eigenvalues.
Mean diffusivity (MD) calculated from cached eigenvalues.
Returns
---------
Expand All @@ -931,7 +931,7 @@ def md(self):
@auto_attr
def rd(self):
r"""
Radial diffusitivity (RD) calculated from cached eigenvalues.
Radial diffusivity (RD) calculated from cached eigenvalues.
Returns
---------
Expand Down Expand Up @@ -1007,7 +1007,7 @@ def planarity(self):
.. math::
Sphericity =
\frac{2 (\lambda2 - \lambda_3)}{\lambda_1+\lambda_2+\lambda_3}
\frac{2 (\lambda_2 - \lambda_3)}{\lambda_1+\lambda_2+\lambda_3}
Notes
-----
Expand Down Expand Up @@ -1343,7 +1343,7 @@ def wls_fit_tensor(design_matrix, data, return_S0_hat=False):
1. calculate OLS estimates of the data
2. apply the OLS estimates as weights to the WLS fit of the data
This ensured heteroscadasticity could be properly modeled for various
This ensured heteroscedasticity could be properly modeled for various
types of bootstrap resampling (namely residual bootstrap).
.. math::
Expand Down Expand Up @@ -1477,7 +1477,7 @@ def _nlls_err_func(tensor, design_matrix, data, weighting=None,
The voxel signal in all gradient directions
weighting : str (optional).
Whether to use the Geman McClure weighting criterion (see [1]_
Whether to use the Geman-McClure weighting criterion (see [1]_
for details)
sigma : float or float array (optional)
Expand All @@ -1490,7 +1490,7 @@ def _nlls_err_func(tensor, design_matrix, data, weighting=None,
Notes
-----
The GemanMcClure M-estimator is described as follows [1]_ (page 1089): "The
The Geman-McClure M-estimator is described as follows [1]_ (page 1089): "The
scale factor C affects the shape of the GMM [Geman-McClure M-estimator]
weighting function and represents the expected spread of the residuals
(i.e., the SD of the residuals) due to Gaussian distributed noise. The
Expand Down Expand Up @@ -1534,7 +1534,7 @@ def _nlls_err_func(tensor, design_matrix, data, weighting=None,
w = 1 / (sigma**2)

elif weighting == 'gmm':
# We use the Geman McClure M-estimator to compute the weights on the
# We use the Geman-McClure M-estimator to compute the weights on the
# residuals:
C = 1.4826 * np.median(np.abs(residuals - np.median(residuals)))
with warnings.catch_warnings():
Expand Down Expand Up @@ -1573,7 +1573,7 @@ def _decompose_tensor_nan(tensor, tensor_alternative, min_diffusivity=0):
Computes tensor eigen decomposition to calculate eigenvalues and
eigenvectors (Basser et al., 1994a). Some fit approaches can produce nan
tensor elements in background voxels (particularly non-linear approachs).
tensor elements in background voxels (particularly non-linear approaches).
This function avoids the eigen decomposition errors of nan tensor elements
by replacing tensor with nan elements by a given alternative tensor
estimate.
Expand Down Expand Up @@ -1732,7 +1732,7 @@ def restore_fit_tensor(design_matrix, data, sigma=None, jac=True,
jac : bool, optional
Whether to use the Jacobian of the tensor to speed the non-linear
optimization procedure used to fit the tensor paramters (see also
optimization procedure used to fit the tensor parameters (see also
:func:`nlls_fit_tensor`). Default: True
return_S0_hat : bool
Expand Down Expand Up @@ -1856,8 +1856,9 @@ def restore_fit_tensor(design_matrix, data, sigma=None, jac=True,
def from_lower_triangular(D):
""" Returns a tensor given the six unique tensor elements
Given the six unique tensor elments (in the order: Dxx, Dxy, Dyy, Dxz, Dyz,
Dzz) returns a 3 by 3 tensor. All elements after the sixth are ignored.
Given the six unique tensor elements (in the order: Dxx, Dxy, Dyy, Dxz,
Dyz, Dzz) returns a 3 by 3 tensor. All elements after the sixth are
ignored.
Parameters
-----------
Expand Down

0 comments on commit 08d8d90

Please sign in to comment.