Click or drag to resize
SoImageRegistrationTransform Class

OIV.ImageViz.Engines.GeometryAndMatching.Registration.SoImageRegistrationTransform image filter.

Inheritance Hierarchy

Namespace: OIV.ImageViz.Engines.GeometryAndMatching.Registration
Assembly: OIV.ImageViz (in OIV.ImageViz.dll) Version: (
public class SoImageRegistrationTransform : SoImageVizEngine

The SoImageRegistrationTransform type exposes the following members.

Public methodSoImageRegistrationTransform


Public methodAbortEvaluate

Abort current processing as soon as possible.

(Inherited from SoImageVizEngine.)
Public methodCopy

Creates and returns an exact copy of the engine.

(Inherited from SoEngine.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetOutput

Returns a reference to the engine output with the given name.

(Inherited from SoEngine.)
Public methodGetOutputName

Returns (in outputName) the name of the engine output (output).

(Inherited from SoEngine.)
Public methodGetOutputs

Returns a list of outputs in this engine.

(Inherited from SoEngine.)
Public methodGetOutputTransformation

return the output transform matrix that aligns the model image to the reference image.

Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsEvaluating

Returns true if the engine evaluation is in progress.

(Inherited from SoImageVizEngine.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodSet

Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodStartEvaluate

Evaluate engine and dependencies in another thread without blocking the current one.

(Inherited from SoImageVizEngine.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoBase.)
Public methodWaitEvaluate

Wait for the end of engine evaluation.

(Inherited from SoImageVizEngine.)
Public propertyautoParameterMode

The way to determine the coarsestResampling and optimizerStep parameters.

Public propertycoarsestResampling

The sub-sampling factor along each axis.

Public propertycomputeMode

Select the compute Mode (2D or 3D or AUTO) .

Public propertyignoreFinestLevel

Skip the finest level of the pyramid.

Public propertyinFixedImage

The input reference image.

Public propertyinitialTransform

The initial transformation that pre-aligns the model onto the reference.

Public propertyinMovingImage

The input model image.

Public propertyintensityRangeModel

The range [a,b] of gray values for the model data set.

Public propertyintensityRangeReference

The range [a,b] of gray values for the reference data set.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertymetricType

Select the metric type.

Public propertyoptimizerStep

The step sizes, in world coordinates, used by the optimizer at coarsest and finest scales.

Public propertyoutTransform

Output structure storing registration results.

Public propertyrangeModeModel

The way to define the intensity range to be considered by the algorithm in the reference (fixed) image.

Public propertyrangeModeReference

The way to define the intensity range to be considered by the algorithm in the model (moving) image.

Public propertytransformType

Select the type of transform.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Public eventOnBegin

Event raised when the processing begins.

(Inherited from SoImageVizEngine.)
Public eventOnEnd

Event raised when processing ends and the result is available.

(Inherited from SoImageVizEngine.)
Public eventOnProgress

Event raised while processing is running.

(Inherited from SoImageVizEngine.)
Public eventOnProgressRegistration

Specific event handler for registration.


OIV.ImageViz.Engines.GeometryAndMatching.Registration.SoImageRegistrationTransform computes the best transformation for the co-registration of two images, using an iterative optimization algorithm.

The goal of registration is to find a transformation aligning a model image, which is moving while being processed, with a reference image, which remains fixed, starting from an initial transformation and by optimizing a similarity criterion between both images.

The estimated transformation can be a single translation, rigid (translation and rotation only), rigid with scale factors (isotropic or anisotropic along axis directions) or affine (including shear transformation).

A hierarchical strategy is applied, starting at a coarse resampling of the data set, and proceeding to finer resolutions later on. Different similarity measurements like Euclidean distance, mutual information, and correlation can be selected. After each iteration a similarity score is computed, and the transformation is refined according to an optimizer algorithm. If this score cannot be computed, for instance when the resampling or step parameters are not adapted, it remains at its default value -1000.

The optimizer behavior depends on the optimizerStep parameter which affects the search extent, precision and computation time. A small optimizerStep is recommended when a pre-alignment has been performed in order to be more precise and avoid sending the transformation at a wrong location.

Two different optimization strategies are used for coarsest and finest resolution levels. The Extensive Direction optimizer is used at coarse levels. This optimizer is well suited for coarse resolution levels and potentially search registration further. A Quasi Newton optimizer is used on the finest level computed excepted if there is only one level. This optimizer is more suited for finer resolution levels in order to refine the transformation.

By default, the coarsestResampling and optimizerStep parameters are automatically estimated from the reference image properties. If the model and reference have different resolution or size, for instance in multi-modality case, these settings may be inappropriate and lead the registration to fail. In this case, the autoParameterMode parameter should be set to false and both parameters should be manually set to relevant values so that the coarsest resolution level generates a representative volume (i.e., not made of too few voxels) the displacement step is precise enough to not skip the searched transformation.

The OIV.ImageViz.Engines.GeometryAndMatching.Registration.SoImagePreAlignmentTransform3d engine can be used beforehand to estimate a rough initial transformation.

If the two input images have been carefully pre-aligned, it is not recommended to perform the registration at a too low sub-resolution level. It would not only perform useless computations but could also send the transformation at a wrong location and thus miss the right transformation. Consequently, the following recommendations can be applied in this case:

  • Do not use automatic parameters, i.e., set autoParameterMode to false.

  • Set the coarsest resolution level at the half of the original resolution, i.e., set the coarsestResampling parameter to (2,2,2).

  • Set the optimizerStep parameter with half of the reference image voxel size for finest resolution and reference voxel size for coarsest resolution.

This engine can notify some information during the processing (progression, similarity) and can be interrupted. Intercepting these events slows down the algorithm execution.


The Correlation Ratio metric is explained in the following publication:

  • A. Roche, G. Malandain, X. Pennec, and N. Ayache. "The Correlation Ratio as a New Similarity Measure for Multimodal Image Registration". INRIA Sophia Antipolis, EPIDAURE project, 1998.

The Normalized Mutual Information metric is based on the following publication:

  • C. Studholme, D. L. G. Hill, D.J. Hawkes. "An Overlap Invariant Entropy Measure of 3D Medical Image Alignment". In: Pattern Recognition vol. 32, pp. 71-86, 1999.

Further references include:

  • P. A. Viola. "Alignment by Maximization of Mutual Information". Massachusetts Institute of Technology, Diss., 1995.

  • A. Collignon, F. Maes, D. Delaere, D. Vandermeulen, P. Suetens, G. Marchal. "Automated Multi-modality Image Registration Based on Information Theory". In: IPMI. Dordrecht, Niederlande: Kluwer Academics, pp. 263-274, 1995.


ImageRegistrationTransform3d {
inMovingImage NULL
inFixedImage NULL
initialTransform SbMatrix.identity()
autoParameterMode true
optimizerStep OIV.Inventor.SbVec2f( 4.0f, 1.0f / 2.0f )
intensityRangeReference OIV.Inventor.SbVec2f( 0.0f, 65535.0f )
intensityRangeModel OIV.Inventor.SbVec2f( 0.0f, 65535.0f )
rangeModeReference MIN_MAX
rangeModeModel MIN_MAX
coarsestResampling SbVec3i32( 8, 8, 8 )
transformType RIGID
ignoreFinestLevel false

  • Notice: This engine requires to preliminarily load the whole input data sets into memory to be computed. As a consequence, the maximum memory parameter must be either set to 0 or greater than the data set memory size:
    maxMemory parameter of the OIV.ImageViz.SbImageDataAdapterHelper.GetAppropriateAdapter(System.String, System.UInt64) functionmaxMemory attribute of the OIV.ImageViz.Nodes.Images.SoFileDataAdapter classIf this condition is not respected an exception will be raised when launching the execution of this engine: "engine cannot be computed because inputs are not in memory images."If the input data sets cannot fit in memory, this engine will fail during its computation.

    See Also