nipype.interfaces.semtools.registration.brainsresize module

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

BRAINSResize

Link to code

Bases: SEMLikeCommandLine

Wrapped executable: BRAINSResize.

title: Resize Image (BRAINS)

category: Registration

description: This program is useful for downsampling an image by a constant scale factor.

version: 3.0.0

license: https://www.nitrc.org/svn/brains/BuildScripts/trunk/License.txt

contributor: This tool was developed by Hans Johnson.

acknowledgements: The development of this tool was supported by funding from grants NS050568 and NS40068 from the National Institute of Neurological Disorders and Stroke and grants MH31593, MH40856, from the National Institute of Mental Health.

Optional Inputs:

  • 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: {})

  • inputVolume (a pathlike object or string representing an existing file) – Image To Scale. Maps to a command-line argument: --inputVolume %s.

  • outputVolume (a boolean or a pathlike object or string representing a file) – Resulting scaled image. Maps to a command-line argument: --outputVolume %s.

  • pixelType (‘float’ or ‘short’ or ‘ushort’ or ‘int’ or ‘uint’ or ‘uchar’ or ‘binary’) – Specifies the pixel type for the input/output images. The ‘binary’ pixel type uses a modified algorithm whereby the image is read in as unsigned char, a signed distance map is created, signed distance map is resampled, and then a thresholded image of type unsigned char is written to disk. Maps to a command-line argument: --pixelType %s.

  • scaleFactor (a float) – The scale factor for the image spacing. Maps to a command-line argument: --scaleFactor %f.

Outputs:

outputVolume (a pathlike object or string representing an existing file) – Resulting scaled image.