interfaces.slicer.filtering.thresholdscalarvolume¶
ThresholdScalarVolume¶
Wraps the executable command ``ThresholdScalarVolume ``.
title: Threshold Scalar Volume
category: Filtering
description: <p>Threshold an image.</p><p>Set image values to a user-specified outside value if they are below, above, or between simple threshold values.</p><p>ThresholdAbove: The values greater than or equal to the threshold value are set to OutsideValue.</p><p>ThresholdBelow: The values less than or equal to the threshold value are set to OutsideValue.</p><p>ThresholdOutside: The values outside the range Lower-Upper are set to OutsideValue.</p><p>Although all image types are supported on input, only signed types are produced.</p><p>
version: 0.1.0.$Revision: 2104 $(alpha)
documentation-url: http://wiki.slicer.org/slicerWiki/index.php/Documentation/4.1/Modules/Threshold
contributor: Nicole Aucoin (SPL, BWH), Ron Kikinis (SPL, BWH)
acknowledgements: This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149.
Inputs:
[Optional]
InputVolume: (a pathlike object or string representing an existing
file)
Input volume
argument: ``%s``, position: -2
OutputVolume: (a boolean or a pathlike object or string representing
a file)
Thresholded input volume
argument: ``%s``, position: -1
threshold: (an integer (int or long))
Threshold value
argument: ``--threshold %d``
lower: (an integer (int or long))
Lower threshold value
argument: ``--lower %d``
upper: (an integer (int or long))
Upper threshold value
argument: ``--upper %d``
outsidevalue: (an integer (int or long))
Set the voxels to this value if they fall outside the threshold
range
argument: ``--outsidevalue %d``
thresholdtype: ('Below' or 'Above' or 'Outside')
What kind of threshold to perform. If Outside is selected, uses
Upper and Lower values. If Below is selected, uses the
ThresholdValue, if Above is selected, uses the ThresholdValue.
argument: ``--thresholdtype %s``
args: (a unicode string)
Additional parameters to the command
argument: ``%s``
environ: (a dictionary with keys which are a bytes or None or a value
of class 'str' and with values which are a bytes or None or a
value of class 'str', nipype default value: {})
Environment variables
Outputs:
OutputVolume: (a pathlike object or string representing an existing
file)
Thresholded input volume