nipype.interfaces.slicer.filtering.thresholdscalarvolume module

Autogenerated file - DO NOT EDIT If you spot a bug, please report it on the mailing list and/or change the generator.

ThresholdScalarVolume

Link to code

Bases: SEMLikeCommandLine

Wrapped executable: 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.

Optional Inputs:

  • InputVolume (a pathlike object or string representing an existing file) – Input volume. Maps to a command-line argument: %s (position: -2).

  • OutputVolume (a boolean or a pathlike object or string representing a file) – Thresholded input volume. Maps to a command-line argument: %s (position: -1).

  • args (a string) – Additional parameters to the command. Maps to a command-line 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’) – Environment variables. (Nipype default value: {})

  • lower (an integer) – Lower threshold value. Maps to a command-line argument: --lower %d.

  • outsidevalue (an integer) – Set the voxels to this value if they fall outside the threshold range. Maps to a command-line argument: --outsidevalue %d.

  • threshold (an integer) – Threshold value. Maps to a command-line argument: --threshold %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. Maps to a command-line argument: --thresholdtype %s.

  • upper (an integer) – Upper threshold value. Maps to a command-line argument: --upper %d.

Outputs:

OutputVolume (a pathlike object or string representing an existing file) – Thresholded input volume.