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

interfaces.semtools.registration.specialized
============================================


.. _nipype.interfaces.semtools.registration.specialized.BRAINSDemonWarp:


.. index:: BRAINSDemonWarp

BRAINSDemonWarp
---------------

`Link to code <file:///build/nipype-1.1.8/nipype/interfaces/semtools/registration/specialized.py#L478>`__

Wraps the executable command `` BRAINSDemonWarp ``.

title: Demon Registration (BRAINS)

category: Registration.Specialized

description: This program finds a deformation field to warp a moving image onto a fixed image.  The images must be of the same signal kind, and contain an image of the same kind of object.  This program uses the Thirion Demons warp software in ITK, the Insight Toolkit.  Additional information is available at: http://wiki.slicer.org/slicerWiki/index.php/Documentation/4.1/Modules/BRAINSDemonWarp.

version: 3.0.0

documentation-url: http://www.slicer.org/slicerWiki/index.php/Documentation/4.1/Modules/BRAINSDemonWarp

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

contributor: This tool was developed by Hans J. Johnson and Greg Harris.

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::

        [Optional]
        outputPixelType: ('float' or 'short' or 'ushort' or 'int' or 'uchar')
                outputVolume will be typecast to this format:
                float|short|ushort|int|uchar
                argument: ``--outputPixelType %s``
        medianFilterSize: (a list of items which are an integer (int or
                  long))
                Median filter radius in all 3 directions. When images have a lot of
                salt and pepper noise, this step can improve the registration.
                argument: ``--medianFilterSize %s``
        backgroundFillValue: (an integer (int or long))
                Replacement value to overwrite background when performing BOBF
                argument: ``--backgroundFillValue %d``
        upperThresholdForBOBF: (an integer (int or long))
                Upper threshold for performing BOBF
                argument: ``--upperThresholdForBOBF %d``
        promptUser: (a boolean)
                Prompt the user to hit enter each time an image is sent to the
                DebugImageViewer
                argument: ``--promptUser ``
        smoothDisplacementFieldSigma: (a float)
                A gaussian smoothing value to be applied to the deformation feild at
                each iteration.
                argument: ``--smoothDisplacementFieldSigma %f``
        histogramMatch: (a boolean)
                Histogram Match the input images. This is suitable for images of the
                same modality that may have different absolute scales, but the same
                overall intensity profile.
                argument: ``--histogramMatch ``
        interpolationMode: ('NearestNeighbor' or 'Linear' or
                  'ResampleInPlace' or 'BSpline' or 'WindowedSinc' or 'Hamming' or
                  'Cosine' or 'Welch' or 'Lanczos' or 'Blackman')
                Type of interpolation to be used when applying transform to moving
                volume. Options are Linear, ResampleInPlace, NearestNeighbor,
                BSpline, or WindowedSinc
                argument: ``--interpolationMode %s``
        fixedVolume: (an existing file name)
                Required: input fixed (target) image
                argument: ``--fixedVolume %s``
        initializeWithDisplacementField: (an existing file name)
                Initial deformation field vector image file name
                argument: ``--initializeWithDisplacementField %s``
        numberOfBCHApproximationTerms: (an integer (int or long))
                Number of terms in the BCH expansion
                argument: ``--numberOfBCHApproximationTerms %d``
        inputPixelType: ('float' or 'short' or 'ushort' or 'int' or 'uchar')
                Input volumes will be typecast to this format:
                float|short|ushort|int|uchar
                argument: ``--inputPixelType %s``
        minimumMovingPyramid: (a list of items which are an integer (int or
                  long))
                The shrink factor for the first level of the moving image pyramid.
                (i.e. start at 1/16 scale, then 1/8, then 1/4, then 1/2, and finally
                full scale)
                argument: ``--minimumMovingPyramid %s``
        registrationFilterType: ('Demons' or 'FastSymmetricForces' or
                  'Diffeomorphic')
                Registration Filter Type: Demons|FastSymmetricForces|Diffeomorphic
                argument: ``--registrationFilterType %s``
        upFieldSmoothing: (a float)
                Smoothing sigma for the update field at each iteration
                argument: ``--upFieldSmoothing %f``
        initializeWithTransform: (an existing file name)
                Initial Transform filename
                argument: ``--initializeWithTransform %s``
        numberOfHistogramBins: (an integer (int or long))
                The number of histogram levels
                argument: ``--numberOfHistogramBins %d``
        minimumFixedPyramid: (a list of items which are an integer (int or
                  long))
                The shrink factor for the first level of the fixed image pyramid.
                (i.e. start at 1/16 scale, then 1/8, then 1/4, then 1/2, and finally
                full scale)
                argument: ``--minimumFixedPyramid %s``
        outputNormalized: (a boolean)
                Flag to warp and write the normalized images to output. In
                normalized images the image values are fit-scaled to be between 0
                and the maximum storage type value.
                argument: ``--outputNormalized ``
        outputVolume: (a boolean or a file name)
                Required: output resampled moving image (will have the same physical
                space as the fixedVolume).
                argument: ``--outputVolume %s``
        outputCheckerboardVolume: (a boolean or a file name)
                Genete a checkerboard image volume between the fixedVolume and the
                deformed movingVolume.
                argument: ``--outputCheckerboardVolume %s``
        movingVolume: (an existing file name)
                Required: input moving image
                argument: ``--movingVolume %s``
        max_step_length: (a float)
                Maximum length of an update vector (0: no restriction)
                argument: ``--max_step_length %f``
        fixedBinaryVolume: (an existing file name)
                Mask filename for desired region of interest in the Fixed image.
                argument: ``--fixedBinaryVolume %s``
        args: (a unicode string)
                Additional parameters to the command
                argument: ``%s``
        arrayOfPyramidLevelIterations: (a list of items which are an integer
                  (int or long))
                The number of iterations for each pyramid level
                argument: ``--arrayOfPyramidLevelIterations %s``
        numberOfThreads: (an integer (int or long))
                Explicitly specify the maximum number of threads to use.
                argument: ``--numberOfThreads %d``
        movingBinaryVolume: (an existing file name)
                Mask filename for desired region of interest in the Moving image.
                argument: ``--movingBinaryVolume %s``
        neighborhoodForBOBF: (a list of items which are an integer (int or
                  long))
                neighborhood in all 3 directions to be included when performing BOBF
                argument: ``--neighborhoodForBOBF %s``
        outputDisplacementFieldVolume: (a boolean or a file name)
                Output deformation field vector image (will have the same physical
                space as the fixedVolume).
                argument: ``--outputDisplacementFieldVolume %s``
        checkerboardPatternSubdivisions: (a list of items which are an
                  integer (int or long))
                Number of Checkerboard subdivisions in all 3 directions
                argument: ``--checkerboardPatternSubdivisions %s``
        seedForBOBF: (a list of items which are an integer (int or long))
                coordinates in all 3 directions for Seed when performing BOBF
                argument: ``--seedForBOBF %s``
        outputDisplacementFieldPrefix: (a unicode string)
                Displacement field filename prefix for writing separate x, y, and z
                component images
                argument: ``--outputDisplacementFieldPrefix %s``
        numberOfPyramidLevels: (an integer (int or long))
                Number of image pyramid levels to use in the multi-resolution
                registration.
                argument: ``--numberOfPyramidLevels %d``
        gui: (a boolean)
                Display intermediate image volumes for debugging
                argument: ``--gui ``
        outputDebug: (a boolean)
                Flag to write debugging images after each step.
                argument: ``--outputDebug ``
        maskProcessingMode: ('NOMASK' or 'ROIAUTO' or 'ROI' or 'BOBF')
                What mode to use for using the masks: NOMASK|ROIAUTO|ROI|BOBF. If
                ROIAUTO is choosen, then the mask is implicitly defined using a otsu
                forground and hole filling algorithm. Where the Region Of Interest
                mode uses the masks to define what parts of the image should be used
                for computing the deformation field. Brain Only Background Fill uses
                the masks to pre-process the input images by clipping and filling in
                the background with a predefined value.
                argument: ``--maskProcessingMode %s``
        use_vanilla_dem: (a boolean)
                Run vanilla demons algorithm
                argument: ``--use_vanilla_dem ``
        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
        lowerThresholdForBOBF: (an integer (int or long))
                Lower threshold for performing BOBF
                argument: ``--lowerThresholdForBOBF %d``
        numberOfMatchPoints: (an integer (int or long))
                The number of match points for histrogramMatch
                argument: ``--numberOfMatchPoints %d``
        gradient_type: ('0' or '1' or '2')
                Type of gradient used for computing the demons force (0 is
                symmetrized, 1 is fixed image, 2 is moving image)
                argument: ``--gradient_type %s``

Outputs::

        outputVolume: (an existing file name)
                Required: output resampled moving image (will have the same physical
                space as the fixedVolume).
        outputCheckerboardVolume: (an existing file name)
                Genete a checkerboard image volume between the fixedVolume and the
                deformed movingVolume.
        outputDisplacementFieldVolume: (an existing file name)
                Output deformation field vector image (will have the same physical
                space as the fixedVolume).

.. _nipype.interfaces.semtools.registration.specialized.BRAINSTransformFromFiducials:


.. index:: BRAINSTransformFromFiducials

BRAINSTransformFromFiducials
----------------------------

`Link to code <file:///build/nipype-1.1.8/nipype/interfaces/semtools/registration/specialized.py#L547>`__

Wraps the executable command `` BRAINSTransformFromFiducials ``.

title: Fiducial Registration (BRAINS)

category: Registration.Specialized

description: Computes a rigid, similarity or affine transform from a matched list of fiducials

version: 0.1.0.$Revision$

documentation-url: http://www.slicer.org/slicerWiki/index.php/Modules:TransformFromFiducials-Documentation-3.6

contributor: Casey B Goodlett

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]
        transformType: ('Translation' or 'Rigid' or 'Similarity')
                Type of transform to produce
                argument: ``--transformType %s``
        saveTransform: (a boolean or a file name)
                Save the transform that results from registration
                argument: ``--saveTransform %s``
        args: (a unicode string)
                Additional parameters to the command
                argument: ``%s``
        movingLandmarksFile: (an existing file name)
                An fcsv formatted file with a list of landmark points.
                argument: ``--movingLandmarksFile %s``
        movingLandmarks: (a list of items which are a list of from 3 to 3
                  items which are a float)
                Ordered list of landmarks in the moving image
                argument: ``--movingLandmarks %s...``
        numberOfThreads: (an integer (int or long))
                Explicitly specify the maximum number of threads to use.
                argument: ``--numberOfThreads %d``
        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
        fixedLandmarksFile: (an existing file name)
                An fcsv formatted file with a list of landmark points.
                argument: ``--fixedLandmarksFile %s``
        fixedLandmarks: (a list of items which are a list of from 3 to 3
                  items which are a float)
                Ordered list of landmarks in the fixed image
                argument: ``--fixedLandmarks %s...``

Outputs::

        saveTransform: (an existing file name)
                Save the transform that results from registration

.. _nipype.interfaces.semtools.registration.specialized.VBRAINSDemonWarp:


.. index:: VBRAINSDemonWarp

VBRAINSDemonWarp
----------------

`Link to code <file:///build/nipype-1.1.8/nipype/interfaces/semtools/registration/specialized.py#L232>`__

Wraps the executable command `` VBRAINSDemonWarp ``.

title: Vector Demon Registration (BRAINS)

category: Registration.Specialized

description: This program finds a deformation field to warp a moving image onto a fixed image.  The images must be of the same signal kind, and contain an image of the same kind of object.  This program uses the Thirion Demons warp software in ITK, the Insight Toolkit.  Additional information is available at: http://www.nitrc.org/projects/brainsdemonwarp.

version: 3.0.0

documentation-url: http://www.slicer.org/slicerWiki/index.php/Documentation/4.1/Modules/BRAINSDemonWarp

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

contributor: This tool was developed by Hans J. Johnson and Greg Harris.

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::

        [Optional]
        outputPixelType: ('float' or 'short' or 'ushort' or 'int' or 'uchar')
                outputVolume will be typecast to this format:
                float|short|ushort|int|uchar
                argument: ``--outputPixelType %s``
        medianFilterSize: (a list of items which are an integer (int or
                  long))
                Median filter radius in all 3 directions. When images have a lot of
                salt and pepper noise, this step can improve the registration.
                argument: ``--medianFilterSize %s``
        backgroundFillValue: (an integer (int or long))
                Replacement value to overwrite background when performing BOBF
                argument: ``--backgroundFillValue %d``
        upperThresholdForBOBF: (an integer (int or long))
                Upper threshold for performing BOBF
                argument: ``--upperThresholdForBOBF %d``
        promptUser: (a boolean)
                Prompt the user to hit enter each time an image is sent to the
                DebugImageViewer
                argument: ``--promptUser ``
        smoothDisplacementFieldSigma: (a float)
                A gaussian smoothing value to be applied to the deformation feild at
                each iteration.
                argument: ``--smoothDisplacementFieldSigma %f``
        histogramMatch: (a boolean)
                Histogram Match the input images. This is suitable for images of the
                same modality that may have different absolute scales, but the same
                overall intensity profile.
                argument: ``--histogramMatch ``
        fixedVolume: (a list of items which are an existing file name)
                Required: input fixed (target) image
                argument: ``--fixedVolume %s...``
        initializeWithDisplacementField: (an existing file name)
                Initial deformation field vector image file name
                argument: ``--initializeWithDisplacementField %s``
        numberOfBCHApproximationTerms: (an integer (int or long))
                Number of terms in the BCH expansion
                argument: ``--numberOfBCHApproximationTerms %d``
        inputPixelType: ('float' or 'short' or 'ushort' or 'int' or 'uchar')
                Input volumes will be typecast to this format:
                float|short|ushort|int|uchar
                argument: ``--inputPixelType %s``
        minimumMovingPyramid: (a list of items which are an integer (int or
                  long))
                The shrink factor for the first level of the moving image pyramid.
                (i.e. start at 1/16 scale, then 1/8, then 1/4, then 1/2, and finally
                full scale)
                argument: ``--minimumMovingPyramid %s``
        registrationFilterType: ('Demons' or 'FastSymmetricForces' or
                  'Diffeomorphic' or 'LogDemons' or 'SymmetricLogDemons')
                Registration Filter Type: Demons|FastSymmetricForces|Diffeomorphic|L
                ogDemons|SymmetricLogDemons
                argument: ``--registrationFilterType %s``
        upFieldSmoothing: (a float)
                Smoothing sigma for the update field at each iteration
                argument: ``--upFieldSmoothing %f``
        initializeWithTransform: (an existing file name)
                Initial Transform filename
                argument: ``--initializeWithTransform %s``
        numberOfHistogramBins: (an integer (int or long))
                The number of histogram levels
                argument: ``--numberOfHistogramBins %d``
        minimumFixedPyramid: (a list of items which are an integer (int or
                  long))
                The shrink factor for the first level of the fixed image pyramid.
                (i.e. start at 1/16 scale, then 1/8, then 1/4, then 1/2, and finally
                full scale)
                argument: ``--minimumFixedPyramid %s``
        outputNormalized: (a boolean)
                Flag to warp and write the normalized images to output. In
                normalized images the image values are fit-scaled to be between 0
                and the maximum storage type value.
                argument: ``--outputNormalized ``
        outputVolume: (a boolean or a file name)
                Required: output resampled moving image (will have the same physical
                space as the fixedVolume).
                argument: ``--outputVolume %s``
        outputCheckerboardVolume: (a boolean or a file name)
                Genete a checkerboard image volume between the fixedVolume and the
                deformed movingVolume.
                argument: ``--outputCheckerboardVolume %s``
        movingVolume: (a list of items which are an existing file name)
                Required: input moving image
                argument: ``--movingVolume %s...``
        max_step_length: (a float)
                Maximum length of an update vector (0: no restriction)
                argument: ``--max_step_length %f``
        fixedBinaryVolume: (an existing file name)
                Mask filename for desired region of interest in the Fixed image.
                argument: ``--fixedBinaryVolume %s``
        args: (a unicode string)
                Additional parameters to the command
                argument: ``%s``
        weightFactors: (a list of items which are a float)
                Weight fatctors for each input images
                argument: ``--weightFactors %s``
        numberOfThreads: (an integer (int or long))
                Explicitly specify the maximum number of threads to use.
                argument: ``--numberOfThreads %d``
        movingBinaryVolume: (an existing file name)
                Mask filename for desired region of interest in the Moving image.
                argument: ``--movingBinaryVolume %s``
        neighborhoodForBOBF: (a list of items which are an integer (int or
                  long))
                neighborhood in all 3 directions to be included when performing BOBF
                argument: ``--neighborhoodForBOBF %s``
        outputDisplacementFieldVolume: (a boolean or a file name)
                Output deformation field vector image (will have the same physical
                space as the fixedVolume).
                argument: ``--outputDisplacementFieldVolume %s``
        makeBOBF: (a boolean)
                Flag to make Brain-Only Background-Filled versions of the input and
                target volumes.
                argument: ``--makeBOBF ``
        checkerboardPatternSubdivisions: (a list of items which are an
                  integer (int or long))
                Number of Checkerboard subdivisions in all 3 directions
                argument: ``--checkerboardPatternSubdivisions %s``
        seedForBOBF: (a list of items which are an integer (int or long))
                coordinates in all 3 directions for Seed when performing BOBF
                argument: ``--seedForBOBF %s``
        outputDisplacementFieldPrefix: (a unicode string)
                Displacement field filename prefix for writing separate x, y, and z
                component images
                argument: ``--outputDisplacementFieldPrefix %s``
        numberOfPyramidLevels: (an integer (int or long))
                Number of image pyramid levels to use in the multi-resolution
                registration.
                argument: ``--numberOfPyramidLevels %d``
        gui: (a boolean)
                Display intermediate image volumes for debugging
                argument: ``--gui ``
        outputDebug: (a boolean)
                Flag to write debugging images after each step.
                argument: ``--outputDebug ``
        interpolationMode: ('NearestNeighbor' or 'Linear' or
                  'ResampleInPlace' or 'BSpline' or 'WindowedSinc' or 'Hamming' or
                  'Cosine' or 'Welch' or 'Lanczos' or 'Blackman')
                Type of interpolation to be used when applying transform to moving
                volume. Options are Linear, ResampleInPlace, NearestNeighbor,
                BSpline, or WindowedSinc
                argument: ``--interpolationMode %s``
        use_vanilla_dem: (a boolean)
                Run vanilla demons algorithm
                argument: ``--use_vanilla_dem ``
        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
        lowerThresholdForBOBF: (an integer (int or long))
                Lower threshold for performing BOBF
                argument: ``--lowerThresholdForBOBF %d``
        numberOfMatchPoints: (an integer (int or long))
                The number of match points for histrogramMatch
                argument: ``--numberOfMatchPoints %d``
        gradient_type: ('0' or '1' or '2')
                Type of gradient used for computing the demons force (0 is
                symmetrized, 1 is fixed image, 2 is moving image)
                argument: ``--gradient_type %s``
        arrayOfPyramidLevelIterations: (a list of items which are an integer
                  (int or long))
                The number of iterations for each pyramid level
                argument: ``--arrayOfPyramidLevelIterations %s``

Outputs::

        outputVolume: (an existing file name)
                Required: output resampled moving image (will have the same physical
                space as the fixedVolume).
        outputCheckerboardVolume: (an existing file name)
                Genete a checkerboard image volume between the fixedVolume and the
                deformed movingVolume.
        outputDisplacementFieldVolume: (an existing file name)
                Output deformation field vector image (will have the same physical
                space as the fixedVolume).
