.. AUTO-GENERATED FILE -- DO NOT EDIT!

interfaces.semtools.registration.brainsresize
=============================================


.. _nipype.interfaces.semtools.registration.brainsresize.BRAINSResize:


.. index:: BRAINSResize

BRAINSResize
------------

`Link to code <file:///build/nipype-fj7ofr/nipype-1.0.0+git69-gdb2670326/nipype/interfaces/semtools/registration/brainsresize.py#L42>`__

Wraps command ** 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.

Inputs::

        [Mandatory]

        [Optional]
        args: (a unicode string)
                Additional parameters to the command
                flag: %s
        environ: (a dictionary with keys which are a newbytes or None or a
                 newstr or None and with values which are a newbytes or None or a
                 newstr or None, nipype default value: {})
                Environment variables
        ignore_exception: (a boolean, nipype default value: False)
                Print an error message instead of throwing an exception in case the
                interface fails to run
        inputVolume: (an existing file name)
                Image To Scale
                flag: --inputVolume %s
        outputVolume: (a boolean or a file name)
                Resulting scaled image
                flag: --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.
                flag: --pixelType %s
        scaleFactor: (a float)
                The scale factor for the image spacing.
                flag: --scaleFactor %f
        terminal_output: (u'stream' or u'allatonce' or u'file' or u'none')
                Control terminal output: `stream` - displays to terminal immediately
                (default), `allatonce` - waits till command is finished to display
                output, `file` - writes output to file, `none` - output is ignored

Outputs::

        outputVolume: (an existing file name)
                Resulting scaled image
