Skip to content

Commit 4d67a6f

Browse files
committed
Doc fixes.
1 parent 961fc02 commit 4d67a6f

File tree

3 files changed

+22
-13
lines changed

3 files changed

+22
-13
lines changed

nipype/interfaces/ants/preprocess.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,16 @@ class N4BiasFieldCorrectionOutputSpec(TraitedSpec):
3434

3535

3636
class N4BiasFieldCorrection(ANTSCommand):
37-
"""Warps an image from one space to another
37+
"""N4 is a variant of the popular N3 (nonparameteric nonuniform normalization)
38+
retrospective bias correction algorithm. Based on the assumption that the
39+
corruption of the low frequency bias field can be modeled as a convolution of
40+
the intensity histogram by a Gaussian, the basic algorithmic protocol is to
41+
iterate between deconvolving the intensity histogram by a Gaussian, remapping
42+
the intensities, and then spatially smoothing this result by a B-spline modeling
43+
of the bias field itself. The modifications from and improvements obtained over
44+
the original N3 algorithm are described in the following paper: N. Tustison et
45+
al., N4ITK: Improved N3 Bias Correction, IEEE Transactions on Medical Imaging,
46+
29(6):1310-1320, June 2010.
3847
3948
Examples
4049
--------

nipype/interfaces/ants/segment.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,11 @@ class AtroposOutputSpec(TraitedSpec):
5151

5252

5353
class Atropos(ANTSCommand):
54-
"""
55-
A finite mixture modeling (FMM) segmentation approach with possibilities for
56-
specifying prior constraints. These prior constraints include the specification
57-
of a prior label image, prior probability images (one for each class), and/or an
58-
MRF prior to enforce spatial smoothing of the labels. Similar algorithms include
59-
FAST and SPM.
54+
"""A finite mixture modeling (FMM) segmentation approach with possibilities for
55+
specifying prior constraints. These prior constraints include the specification
56+
of a prior label image, prior probability images (one for each class), and/or an
57+
MRF prior to enforce spatial smoothing of the labels. Similar algorithms include
58+
FAST and SPM.
6059
6160
Examples
6261
--------

nipype/interfaces/ants/utils.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,18 @@ class ApplyTransformsOutputSpec(TraitedSpec):
3636

3737

3838
class ApplyTransforms(ANTSCommand):
39-
"""Warps an image from one space to another
39+
"""antsApplyTransforms, applied to an input image, transforms it according to a
40+
reference image and a transform (or a set of transforms).
4041
4142
Examples
4243
--------
4344
4445
>>> from nipype.interfaces.ants import ApplyTransforms
45-
>>> wimt = ApplyTransforms()
46-
>>> wimt.inputs.input_image = 'structural.nii'
47-
>>> wimt.inputs.reference_image = 'ants_deformed.nii.gz'
48-
>>> wimt.inputs.transformation_files = ['ants_Warp.nii.gz','ants_Affine.txt']
49-
>>> wimt.cmdline
46+
>>> atms = ApplyTransforms()
47+
>>> atms.inputs.input_image = 'structural.nii'
48+
>>> atms.inputs.reference_image = 'ants_deformed.nii.gz'
49+
>>> atms.inputs.transformation_files = ['ants_Warp.nii.gz','ants_Affine.txt']
50+
>>> atms.cmdline
5051
'antsApplyTransforms --dimensionality 3 --input structural.nii --output structural_trans.nii --reference-image ants_deformed.nii.gz --transform ants_Warp.nii.gz --transform ants_Affine.txt'
5152
5253
"""

0 commit comments

Comments
 (0)