Skip to content

Commit d0bc9c5

Browse files
committed
DOC: improve descriptions for N4BiasFieldCorrection InputSpec
1 parent cd5567b commit d0bc9c5

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

nipype/interfaces/ants/segmentation.py

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -266,10 +266,15 @@ class N4BiasFieldCorrectionInputSpec(ANTSCommandInputSpec):
266266
input_image = File(
267267
argstr='--input-image %s',
268268
mandatory=True,
269-
desc=('image to apply transformation to (generally a '
270-
'coregistered functional)'))
271-
mask_image = File(argstr='--mask-image %s')
272-
weight_image = File(argstr='--weight-image %s')
269+
desc=('input for bias correction. Negative values or values close to '
270+
'zero should be processed prior to correction'))
271+
mask_image = File(
272+
argstr='--mask-image %s',
273+
desc=('image to specify region to perform final bias correction in'))
274+
weight_image = File(
275+
argstr='--weight-image %s',
276+
desc=('image for relative weighting (e.g. probability map of the white '
277+
'matter) of voxels during the B-spline fitting. '))
273278
output_image = traits.Str(
274279
argstr='--output %s',
275280
desc='output file name',
@@ -284,8 +289,7 @@ class N4BiasFieldCorrectionInputSpec(ANTSCommandInputSpec):
284289
False,
285290
mandatory=True,
286291
usedefault=True,
287-
desc=('True if the estimated bias should be saved'
288-
' to file.'),
292+
desc=('True if the estimated bias should be saved to file.'),
289293
xor=['bias_image'])
290294
bias_image = File(
291295
desc='Filename for the estimated bias.', hash_files=False)

0 commit comments

Comments
 (0)