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

interfaces.c3
=============


.. _nipype.interfaces.c3.C3dAffineTool:


.. index:: C3dAffineTool

C3dAffineTool
-------------

`Link to code <file:///build/nipype-4ReYCB/nipype-0.11.0/nipype/interfaces/c3.py#L27>`__

Wraps command **c3d_affine_tool**

Converts fsl-style Affine registration into ANTS compatible itk format

Example
~~~~~~~

>>> from nipype.interfaces.c3 import C3dAffineTool
>>> c3 = C3dAffineTool()
>>> c3.inputs.source_file = 'cmatrix.mat'
>>> c3.inputs.itk_transform = 'affine.txt'
>>> c3.inputs.fsl2ras = True
>>> c3.cmdline
'c3d_affine_tool -src cmatrix.mat -fsl2ras -oitk affine.txt'

Inputs::

        [Mandatory]

        [Optional]
        args: (a string)
                Additional parameters to the command
                flag: %s
        environ: (a dictionary with keys which are a value of type 'str' and
                 with values which are a value of type 'str', nipype default value:
                 {})
                Environment variables
        fsl2ras: (a boolean)
                flag: -fsl2ras, position: 4
        ignore_exception: (a boolean, nipype default value: False)
                Print an error message instead of throwing an exception in case the
                interface fails to run
        itk_transform: (a boolean or a file name)
                Export ITK transform.
                flag: -oitk %s, position: 5
        reference_file: (an existing file name)
                flag: -ref %s, position: 1
        source_file: (an existing file name)
                flag: -src %s, position: 2
        terminal_output: ('stream' or 'allatonce' or 'file' or '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
        transform_file: (an existing file name)
                flag: %s, position: 3

Outputs::

        itk_transform: (an existing file name)
