Home · Quickstart · User Guide and Examples · Interfaces Index · Developers · About · Nipy

# nipype.interfaces.slicer.legacy.registration module

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

## AffineRegistration

Link to code

> Bases: SEMLikeCommandLine

> Wrapped executable: `AffineRegistration`.

> title: Affine Registration

> category: Legacy.Registration

> description: Registers two images together using an affine transform and mutual information. This module is often used to align images of different subjects or images of the same subject from different modalities.

> This module can smooth images prior to registration to mitigate noise and improve convergence. Many of the registration parameters require a working knowledge of the algorithm although the default parameters are sufficient for many registration tasks.

> version: 0.1.0.$Revision: 19608 $(alpha)

> documentation-url: http://wiki.slicer.org/slicerWiki/index.php/Documentation/4.1/Modules/AffineRegistration

> contributor: Daniel Blezek (GE)

> acknowledgements: This module was developed by Daniel Blezek while at GE Research with contributions from Jim Miller.

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

> FixedImageFileNamea pathlike object or string representing an existing file

>   Fixed image to which to register. Maps to a command-line argument: `%s` (position: -2).

> MovingImageFileNamea pathlike object or string representing an existing file

>   Moving image. Maps to a command-line argument: `%s` (position: -1).

> argsa string

>   Additional parameters to the command. Maps to a command-line argument: `%s`.

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

> fixedsmoothingfactoran integer

>   Amount of smoothing applied to fixed image prior to registration. Default is 0 (none). Range is 0-5 (unitless). Consider smoothing the input data if there is considerable amounts of noise or the noise pattern in the fixed and moving images is very different. Maps to a command-line argument: `--fixedsmoothingfactor %d`.

> histogrambinsan integer

>   Number of histogram bins to use for Mattes Mutual Information. Reduce the number of bins if a registration fails. If the number of bins is too large, the estimated PDFs will be a field of impulses and will inhibit reliable registration estimation. Maps to a command-line argument: `--histogrambins %d`.

> initialtransforma pathlike object or string representing an existing file

>   Initial transform for aligning the fixed and moving image. Maps positions in the fixed coordinate frame to positions in the moving coordinate frame. Optional. Maps to a command-line argument: `--initialtransform %s`.

> iterationsan integer

>   Number of iterations. Maps to a command-line argument: `--iterations %d`.

> movingsmoothingfactoran integer

>   Amount of smoothing applied to moving image prior to registration. Default is 0 (none). Range is 0-5 (unitless). Consider smoothing the input data if there is considerable amounts of noise or the noise pattern in the fixed and moving images is very different. Maps to a command-line argument: `--movingsmoothingfactor %d`.

> outputtransforma boolean or a pathlike object or string representing a file

>   Transform calculated that aligns the fixed and moving image. Maps positions in the fixed coordinate frame to the moving coordinate frame. Optional (specify an output transform or an output volume or both). Maps to a command-line argument: `--outputtransform %s`.

> resampledmovingfilenamea boolean or a pathlike object or string representing a file

>   Resampled moving image to the fixed image coordinate frame. Optional (specify an output transform or an output volume or both). Maps to a command-line argument: `--resampledmovingfilename %s`.

> spatialsamplesan integer

>   Number of spatial samples to use in estimating Mattes Mutual Information. Larger values yield more accurate PDFs and improved registration quality. Maps to a command-line argument: `--spatialsamples %d`.

> translationscalea float

>   Relative scale of translations to rotations, i.e. a value of 100 means 10mm = 1 degree. (Actual scale used is 1/(TranslationScale^2)). This parameter is used to ‘weight’ or ‘standardized’ the transform parameters and their effect on the registration objective function. Maps to a command-line argument: `--translationscale %f`.

> outputtransforma pathlike object or string representing an existing file

>   Transform calculated that aligns the fixed and moving image. Maps positions in the fixed coordinate frame to the moving coordinate frame. Optional (specify an output transform or an output volume or both).

> resampledmovingfilenamea pathlike object or string representing an existing file

>   Resampled moving image to the fixed image coordinate frame. Optional (specify an output transform or an output volume or both).

## BSplineDeformableRegistration

Link to code

> Bases: SEMLikeCommandLine

> Wrapped executable: `BSplineDeformableRegistration`.

> title: BSpline Deformable Registration

> category: Legacy.Registration

> description: Registers two images together using BSpline transform and mutual information.

> version: 0.1.0.$Revision: 19608 $(alpha)

> documentation-url: http://wiki.slicer.org/slicerWiki/index.php/Documentation/4.1/Modules/BSplineDeformableRegistration

> contributor: Bill Lorensen (GE)

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

> FixedImageFileNamea pathlike object or string representing an existing file

>   Fixed image to which to register. Maps to a command-line argument: `%s` (position: -2).

> MovingImageFileNamea pathlike object or string representing an existing file

>   Moving image. Maps to a command-line argument: `%s` (position: -1).

> argsa string

>   Additional parameters to the command. Maps to a command-line argument: `%s`.

> constraina boolean

>   Constrain the deformation to the amount specified in Maximum Deformation. Maps to a command-line argument: `--constrain`.

> defaultan integer

>   Default pixel value used if resampling a pixel outside of the volume. Maps to a command-line argument: `--default %d`.

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

> gridSizean integer

>   Number of grid points on interior of the fixed image. Larger grid sizes allow for finer registrations. Maps to a command-line argument: `--gridSize %d`.

> histogrambinsan integer

>   Number of histogram bins to use for Mattes Mutual Information. Reduce the number of bins if a deformable registration fails. If the number of bins is too large, the estimated PDFs will be a field of impulses and will inhibit reliable registration estimation. Maps to a command-line argument: `--histogrambins %d`.

> initialtransforma pathlike object or string representing an existing file

>   Initial transform for aligning the fixed and moving image. Maps positions in the fixed coordinate frame to positions in the moving coordinate frame. This transform should be an affine or rigid transform. It is used an a bulk transform for the BSpline. Optional. Maps to a command-line argument: `--initialtransform %s`.

> iterationsan integer

>   Number of iterations. Maps to a command-line argument: `--iterations %d`.

> maximumDeformationa float

>   If Constrain Deformation is checked, limit the deformation to this amount. Maps to a command-line argument: `--maximumDeformation %f`.

> outputtransforma boolean or a pathlike object or string representing a file

>   Transform calculated that aligns the fixed and moving image. Maps positions from the fixed coordinate frame to the moving coordinate frame. Optional (specify an output transform or an output volume or both). Maps to a command-line argument: `--outputtransform %s`.

> outputwarpa boolean or a pathlike object or string representing a file

>   Vector field that applies an equivalent warp as the BSpline. Maps positions from the fixed coordinate frame to the moving coordinate frame. Optional. Maps to a command-line argument: `--outputwarp %s`.

> resampledmovingfilenamea boolean or a pathlike object or string representing a file

>   Resampled moving image to fixed image coordinate frame. Optional (specify an output transform or an output volume or both). Maps to a command-line argument: `--resampledmovingfilename %s`.

> spatialsamplesan integer

>   Number of spatial samples to use in estimating Mattes Mutual Information. Larger values yield more accurate PDFs and improved registration quality. Maps to a command-line argument: `--spatialsamples %d`.

> outputtransforma pathlike object or string representing an existing file

>   Transform calculated that aligns the fixed and moving image. Maps positions from the fixed coordinate frame to the moving coordinate frame. Optional (specify an output transform or an output volume or both).

> outputwarpa pathlike object or string representing an existing file

>   Vector field that applies an equivalent warp as the BSpline. Maps positions from the fixed coordinate frame to the moving coordinate frame. Optional.

> resampledmovingfilenamea pathlike object or string representing an existing file

>   Resampled moving image to fixed image coordinate frame. Optional (specify an output transform or an output volume or both).

## ExpertAutomatedRegistration

Link to code

> Bases: SEMLikeCommandLine

> Wrapped executable: `ExpertAutomatedRegistration`.

> title: Expert Automated Registration

> category: Legacy.Registration

> description: Provides rigid, affine, and BSpline registration methods via a simple GUI

> version: 0.1.0.$Revision: 2104 $(alpha)

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

> contributor: Stephen R Aylward (Kitware), Casey B Goodlett (Kitware)

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

> affineMaxIterationsan integer

>   Maximum number of affine optimization iterations. Maps to a command-line argument: `--affineMaxIterations %d`.

> affineSamplingRatioa float

>   Portion of the image to use in computing the metric during affine registration. Maps to a command-line argument: `--affineSamplingRatio %f`.

> argsa string

>   Additional parameters to the command. Maps to a command-line argument: `%s`.

> bsplineMaxIterationsan integer

>   Maximum number of bspline optimization iterations. Maps to a command-line argument: `--bsplineMaxIterations %d`.

> bsplineSamplingRatioa float

>   Portion of the image to use in computing the metric during BSpline registration. Maps to a command-line argument: `--bsplineSamplingRatio %f`.

> controlPointSpacingan integer

>   Number of pixels between control points. Maps to a command-line argument: `--controlPointSpacing %d`.

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

> expectedOffseta float

>   Expected misalignment after initialization. Maps to a command-line argument: `--expectedOffset %f`.

> expectedRotationa float

>   Expected misalignment after initialization. Maps to a command-line argument: `--expectedRotation %f`.

> expectedScalea float

>   Expected misalignment after initialization. Maps to a command-line argument: `--expectedScale %f`.

> expectedSkewa float

>   Expected misalignment after initialization. Maps to a command-line argument: `--expectedSkew %f`.

> fixedImagea pathlike object or string representing an existing file

>   Image which defines the space into which the moving image is registered. Maps to a command-line argument: `%s` (position: -2).

> fixedImageMaska pathlike object or string representing an existing file

>   Image which defines a mask for the fixed image. Maps to a command-line argument: `--fixedImageMask %s`.

> fixedLandmarksa 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. Maps to a command-line argument: `--fixedLandmarks %s...`.

> initialization‘None’ or ‘Landmarks’ or ‘ImageCenters’ or ‘CentersOfMass’ or ‘SecondMoments’

>   Method to prime the registration process. Maps to a command-line argument: `--initialization %s`.

> interpolation‘NearestNeighbor’ or ‘Linear’ or ‘BSpline’

>   Method for interpolation within the optimization process. Maps to a command-line argument: `--interpolation %s`.

> loadTransforma pathlike object or string representing an existing file

>   Load a transform that is immediately applied to the moving image. Maps to a command-line argument: `--loadTransform %s`.

> metric‘MattesMI’ or ‘NormCorr’ or ‘MeanSqrd’

>   Method to quantify image match. Maps to a command-line argument: `--metric %s`.

> minimizeMemorya boolean

>   Reduce the amount of memory required at the cost of increased computation time. Maps to a command-line argument: `--minimizeMemory`.

> movingImagea pathlike object or string representing an existing file

>   The transform goes from the fixed image’s space into the moving image’s space. Maps to a command-line argument: `%s` (position: -1).

> movingLandmarksa 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. Maps to a command-line argument: `--movingLandmarks %s...`.

> numberOfThreadsan integer

>   Number of CPU threads to use. Maps to a command-line argument: `--numberOfThreads %d`.

> randomNumberSeedan integer

>   Seed to generate a consistent random number sequence. Maps to a command-line argument: `--randomNumberSeed %d`.

> registration‘None’ or ‘Initial’ or ‘Rigid’ or ‘Affine’ or ‘BSpline’ or ‘PipelineRigid’ or ‘PipelineAffine’ or ‘PipelineBSpline’

>   Method for the registration process. Maps to a command-line argument: `--registration %s`.

> resampledImagea boolean or a pathlike object or string representing a file

>   Registration results. Maps to a command-line argument: `--resampledImage %s`.

> rigidMaxIterationsan integer

>   Maximum number of rigid optimization iterations. Maps to a command-line argument: `--rigidMaxIterations %d`.

> rigidSamplingRatioa float

>   Portion of the image to use in computing the metric during rigid registration. Maps to a command-line argument: `--rigidSamplingRatio %f`.

> sampleFromOverlapa boolean

>   Limit metric evaluation to the fixed image region overlapped by the moving image. Maps to a command-line argument: `--sampleFromOverlap`.

> saveTransforma boolean or a pathlike object or string representing a file

>   Save the transform that results from registration. Maps to a command-line argument: `--saveTransform %s`.

> verbosityLevel‘Silent’ or ‘Standard’ or ‘Verbose’

>   Level of detail of reporting progress. Maps to a command-line argument: `--verbosityLevel %s`.

> resampledImagea pathlike object or string representing an existing file

>   Registration results.

> saveTransforma pathlike object or string representing an existing file

>   Save the transform that results from registration.

## LinearRegistration

Link to code

> Bases: SEMLikeCommandLine

> Wrapped executable: `LinearRegistration`.

> title: Linear Registration

> category: Legacy.Registration

> description: Registers two images together using a rigid transform and mutual information.

> version: 0.1.0.$Revision: 19608 $(alpha)

> documentation-url: http://wiki.slicer.org/slicerWiki/index.php/Documentation/4.1/Modules/LinearRegistration

> contributor: Daniel Blezek (GE)

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

> FixedImageFileNamea pathlike object or string representing an existing file

>   Fixed image to which to register. Maps to a command-line argument: `%s` (position: -2).

> MovingImageFileNamea pathlike object or string representing an existing file

>   Moving image. Maps to a command-line argument: `%s` (position: -1).

> argsa string

>   Additional parameters to the command. Maps to a command-line argument: `%s`.

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

> fixedsmoothingfactoran integer

>   Amount of smoothing applied to fixed image prior to registration. Default is 0 (none). Range is 0-5 (unitless). Consider smoothing the input data if there is considerable amounts of noise or the noise pattern in the fixed and moving images is very different. Maps to a command-line argument: `--fixedsmoothingfactor %d`.

> histogrambinsan integer

>   Number of histogram bins to use for Mattes Mutual Information. Reduce the number of bins if a registration fails. If the number of bins is too large, the estimated PDFs will be a field of impulses and will inhibit reliable registration estimation. Maps to a command-line argument: `--histogrambins %d`.

> initialtransforma pathlike object or string representing an existing file

>   Initial transform for aligning the fixed and moving image. Maps positions in the fixed coordinate frame to positions in the moving coordinate frame. Optional. Maps to a command-line argument: `--initialtransform %s`.

> iterationsa list of items which are an integer

>   Comma separated list of iterations. Must have the same number of elements as the learning rate. Maps to a command-line argument: `--iterations %s`.

> learningratea list of items which are a float

>   Comma separated list of learning rates. Learning rate is a scale factor on the gradient of the registration objective function (gradient with respect to the parameters of the transformation) used to update the parameters of the transformation during optimization. Smaller values cause the optimizer to take smaller steps through the parameter space. Larger values are typically used early in the registration process to take large jumps in parameter space followed by smaller values to home in on the optimum value of the registration objective function. Default is: 0.01, 0.005, 0.0005, 0.0002. Must have the same number of elements as iterations. Maps to a command-line argument: `--learningrate %s`.

> movingsmoothingfactoran integer

>   Amount of smoothing applied to moving image prior to registration. Default is 0 (none). Range is 0-5 (unitless). Consider smoothing the input data if there is considerable amounts of noise or the noise pattern in the fixed and moving images is very different. Maps to a command-line argument: `--movingsmoothingfactor %d`.

> outputtransforma boolean or a pathlike object or string representing a file

>   Transform calculated that aligns the fixed and moving image. Maps positions in the fixed coordinate frame to the moving coordinate frame. Optional (specify an output transform or an output volume or both). Maps to a command-line argument: `--outputtransform %s`.

> resampledmovingfilenamea boolean or a pathlike object or string representing a file

>   Resampled moving image to the fixed image coordinate frame. Optional (specify an output transform or an output volume or both). Maps to a command-line argument: `--resampledmovingfilename %s`.

> spatialsamplesan integer

>   Number of spatial samples to use in estimating Mattes Mutual Information. Larger values yield more accurate PDFs and improved registration quality. Maps to a command-line argument: `--spatialsamples %d`.

> translationscalea float

>   Relative scale of translations to rotations, i.e. a value of 100 means 10mm = 1 degree. (Actual scale used 1/(TranslationScale^2)). This parameter is used to ‘weight’ or ‘standardized’ the transform parameters and their effect on the registration objective function. Maps to a command-line argument: `--translationscale %f`.

> outputtransforma pathlike object or string representing an existing file

>   Transform calculated that aligns the fixed and moving image. Maps positions in the fixed coordinate frame to the moving coordinate frame. Optional (specify an output transform or an output volume or both).

> resampledmovingfilenamea pathlike object or string representing an existing file

>   Resampled moving image to the fixed image coordinate frame. Optional (specify an output transform or an output volume or both).

## MultiResolutionAffineRegistration

Link to code

> Bases: SEMLikeCommandLine

> Wrapped executable: `MultiResolutionAffineRegistration`.

> title: Robust Multiresolution Affine Registration

> category: Legacy.Registration

> description: Provides affine registration using multiple resolution levels and decomposed affine transforms.

> version: 0.1.0.$Revision: 2104 $(alpha)

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

> contributor: Casey B Goodlett (Utah)

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

> argsa string

>   Additional parameters to the command. Maps to a command-line argument: `%s`.

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

> fixedImagea pathlike object or string representing an existing file

>   Image which defines the space into which the moving image is registered. Maps to a command-line argument: `%s` (position: -2).

> fixedImageMaska pathlike object or string representing an existing file

>   Label image which defines a mask of interest for the fixed image. Maps to a command-line argument: `--fixedImageMask %s`.

> fixedImageROIa list of items which are any value

>   Label image which defines a ROI of interest for the fixed image. Maps to a command-line argument: `--fixedImageROI %s`.

> metricTolerancea float

>   Maps to a command-line argument: `--metricTolerance %f`.

> movingImagea pathlike object or string representing an existing file

>   The transform goes from the fixed image’s space into the moving image’s space. Maps to a command-line argument: `%s` (position: -1).

> numIterationsan integer

>   Number of iterations to run at each resolution level. Maps to a command-line argument: `--numIterations %d`.

> numLineIterationsan integer

>   Number of iterations to run at each resolution level. Maps to a command-line argument: `--numLineIterations %d`.

> resampledImagea boolean or a pathlike object or string representing a file

>   Registration results. Maps to a command-line argument: `--resampledImage %s`.

> saveTransforma boolean or a pathlike object or string representing a file

>   Save the output transform from the registration. Maps to a command-line argument: `--saveTransform %s`.

> stepSizea float

>   The maximum step size of the optimizer in voxels. Maps to a command-line argument: `--stepSize %f`.

> stepTolerancea float

>   The maximum step size of the optimizer in voxels. Maps to a command-line argument: `--stepTolerance %f`.

> resampledImagea pathlike object or string representing an existing file

>   Registration results.

> saveTransforma pathlike object or string representing an existing file

>   Save the output transform from the registration.

## RigidRegistration

Link to code

> Bases: SEMLikeCommandLine

> Wrapped executable: `RigidRegistration`.

> title: Rigid Registration

> category: Legacy.Registration

> description: Registers two images together using a rigid transform and mutual information.

> This module was originally distributed as “Linear registration” but has been renamed to eliminate confusion with the “Affine registration” module.

> This module is often used to align images of different subjects or images of the same subject from different modalities.

> This module can smooth images prior to registration to mitigate noise and improve convergence. Many of the registration parameters require a working knowledge of the algorithm although the default parameters are sufficient for many registration tasks.

> version: 0.1.0.$Revision: 19608 $(alpha)

> documentation-url: http://wiki.slicer.org/slicerWiki/index.php/Documentation/4.1/Modules/RigidRegistration

> contributor: Daniel Blezek (GE)

> acknowledgements: This module was developed by Daniel Blezek while at GE Research with contributions from Jim Miller.

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

> FixedImageFileNamea pathlike object or string representing an existing file

>   Fixed image to which to register. Maps to a command-line argument: `%s` (position: -2).

> MovingImageFileNamea pathlike object or string representing an existing file

>   Moving image. Maps to a command-line argument: `%s` (position: -1).

> argsa string

>   Additional parameters to the command. Maps to a command-line argument: `%s`.

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

> fixedsmoothingfactoran integer

>   Amount of smoothing applied to fixed image prior to registration. Default is 0 (none). Range is 0-5 (unitless). Consider smoothing the input data if there is considerable amounts of noise or the noise pattern in the fixed and moving images is very different. Maps to a command-line argument: `--fixedsmoothingfactor %d`.

> histogrambinsan integer

>   Number of histogram bins to use for Mattes Mutual Information. Reduce the number of bins if a registration fails. If the number of bins is too large, the estimated PDFs will be a field of impulses and will inhibit reliable registration estimation. Maps to a command-line argument: `--histogrambins %d`.

> initialtransforma pathlike object or string representing an existing file

>   Initial transform for aligning the fixed and moving image. Maps positions in the fixed coordinate frame to positions in the moving coordinate frame. Optional. Maps to a command-line argument: `--initialtransform %s`.

> iterationsa list of items which are an integer

>   Comma separated list of iterations. Must have the same number of elements as the learning rate. Maps to a command-line argument: `--iterations %s`.

> learningratea list of items which are a float

>   Comma separated list of learning rates. Learning rate is a scale factor on the gradient of the registration objective function (gradient with respect to the parameters of the transformation) used to update the parameters of the transformation during optimization. Smaller values cause the optimizer to take smaller steps through the parameter space. Larger values are typically used early in the registration process to take large jumps in parameter space followed by smaller values to home in on the optimum value of the registration objective function. Default is: 0.01, 0.005, 0.0005, 0.0002. Must have the same number of elements as iterations. Maps to a command-line argument: `--learningrate %s`.

> movingsmoothingfactoran integer

>   Amount of smoothing applied to moving image prior to registration. Default is 0 (none). Range is 0-5 (unitless). Consider smoothing the input data if there is considerable amounts of noise or the noise pattern in the fixed and moving images is very different. Maps to a command-line argument: `--movingsmoothingfactor %d`.

> outputtransforma boolean or a pathlike object or string representing a file

>   Transform calculated that aligns the fixed and moving image. Maps positions in the fixed coordinate frame to the moving coordinate frame. Optional (specify an output transform or an output volume or both). Maps to a command-line argument: `--outputtransform %s`.

> resampledmovingfilenamea boolean or a pathlike object or string representing a file

>   Resampled moving image to the fixed image coordinate frame. Optional (specify an output transform or an output volume or both). Maps to a command-line argument: `--resampledmovingfilename %s`.

> spatialsamplesan integer

>   Number of spatial samples to use in estimating Mattes Mutual Information. Larger values yield more accurate PDFs and improved registration quality. Maps to a command-line argument: `--spatialsamples %d`.

> testingmodea boolean

>   Enable testing mode. Input transform will be used to construct floating image. The floating image will be ignored if passed. Maps to a command-line argument: `--testingmode`.

> translationscalea float

>   Relative scale of translations to rotations, i.e. a value of 100 means 10mm = 1 degree. (Actual scale used 1/(TranslationScale^2)). This parameter is used to ‘weight’ or ‘standardized’ the transform parameters and their effect on the registration objective function. Maps to a command-line argument: `--translationscale %f`.

> outputtransforma pathlike object or string representing an existing file

>   Transform calculated that aligns the fixed and moving image. Maps positions in the fixed coordinate frame to the moving coordinate frame. Optional (specify an output transform or an output volume or both).

> resampledmovingfilenamea pathlike object or string representing an existing file

>   Resampled moving image to the fixed image coordinate frame. Optional (specify an output transform or an output volume or both).