com.openinventor.imageviz.engines.geometryandmatching.registration

Class SoImageRegistrationTransform

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.engines.SoEngine

com.openinventor.imageviz.engines.SoImageVizEngine

com.openinventor.imageviz.engines.geometryandmatching.registration.SoImageRegistrationTransform

All Implemented Interfaces:

SafeDisposable

public class SoImageRegistrationTransform
extends SoImageVizEngine

SoImageRegistrationTransform image filter. SoImageRegistrationTransform finds the best transformation that aligns a moving image with a fixed image by optimizing a similarity criterion between the 2 images, starting from an initial guess. The estimated transformation can be rigid (translation and rotation only), rigid with scale factors or affine.

The SoImagePreAlignmentTransform3d engine can be used to compute the initial guess.

The application can register to receive progress events during the (potentially time consuming) computation.

File format/default:

ImageRegistrationTransform3d {

inMovingImage	NULL
inFixedImage	NULL
initialTransform	SbMatrix.identity()
autoParameterMode	true
optimizerStep	SbVec2f( 1.0f / 16.0f, 1.0f / 2.0f )
coarsestResampling	SbVec3i32( 8, 8, 8 )
transformType	RIGID
ignoreFinestLevel	false
metricType	CORRELATION

}

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 SbImageDataAdapterHelper.getAppropriateAdapter function maxMemory attribute of the SoFileDataAdapter class If 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:

SoImagePreAlignmentTransform3d

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoImageRegistrationTransform.MetricTypes This enum defines the different types of metric used to compute the similarity value.
static class	SoImageRegistrationTransform.RegistrationEvent This event describes the evolution of the registration process.
static class	SoImageRegistrationTransform.TransformationTypes This enum defines the types of transforms that can be computed.

Nested classes/interfaces inherited from class com.openinventor.imageviz.engines.SoImageVizEngine

SoImageVizEngine.ComputeModes, SoImageVizEngine.EventArg, SoImageVizEngine.Neighborhood3ds

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFBool	autoParameterMode Automatic mode.
SoSFVec3i32	coarsestResampling Voxel size at the coarsest level.
SoSFEnum<SoImageVizEngine.ComputeModes>	computeMode Select the compute Mode (2D or 3D or AUTO) .
SoSFBool	ignoreFinestLevel Skip the finest level of the pyramid.
SoSFImageDataAdapter	inFixedImage The input reference image.
SoSFMatrix	initialTransform The initial transformation that pre-aligns the model onto the reference.
SoSFImageDataAdapter	inMovingImage The input model image.
SoSFEnum<SoImageRegistrationTransform.MetricTypes>	metricType Select the metric type.
SbEventHandler<SoImageRegistrationTransform.RegistrationEvent>	onProgressRegistration Specific event handler for registration.
SoSFVec2f	optimizerStep Step size in translation at coarsest and finest scales (physical).
SoImageVizEngineOutput<SoSFFieldContainer,SoRegistrationResult>	outTransform Output structure storing registration results.
SoSFEnum<SoImageRegistrationTransform.TransformationTypes>	transformType Select the type of transform.

Fields inherited from class com.openinventor.imageviz.engines.SoImageVizEngine

onBegin, onEnd, onProgress

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoImageRegistrationTransform() Constructor.

Method Summary

Modifier and Type	Method and Description
SbMatrix	getOutputTransformation() return the output transform matrix that aligns the model image to the reference image.

Methods inherited from class com.openinventor.imageviz.engines.SoImageVizEngine

abortEvaluate, isEvaluating, startEvaluate, waitEvaluate

Methods inherited from class com.openinventor.inventor.engines.SoEngine

copy, getByName, getOutput, getOutputName

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getName, isDisposable, isSynchronizable, setName, setSynchronizable, touch

Methods inherited from class com.openinventor.inventor.Inventor

getNativeResourceHandle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

onProgressRegistration

public final SbEventHandler<SoImageRegistrationTransform.RegistrationEvent> onProgressRegistration

Specific event handler for registration.

computeMode

public final SoSFEnum<SoImageVizEngine.ComputeModes> computeMode

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

inMovingImage

public final SoSFImageDataAdapter inMovingImage

The input model image. Default value is NULL. Supported types include: grayscale binary label.

inFixedImage

public final SoSFImageDataAdapter inFixedImage

The input reference image. Default value is NULL. Supported types include: grayscale binary label.

initialTransform

public final SoSFMatrix initialTransform

The initial transformation that pre-aligns the model onto the reference. Default value is SbMatrix.identity(). The SoImagePreAlignmentTransform3d engine can be used to compute an initial transform.

autoParameterMode

public final SoSFBool autoParameterMode

Automatic mode. If true, optimization parameters (optimizerStep and coarsestResampling) are computed automatically. Default value is true.

optimizerStep

public final SoSFVec2f optimizerStep

Step size in translation at coarsest and finest scales (physical). This parameter is used by the optimizer. The first parameter is for the coarsest level, the second one is for the finest level. Default value is SbVec2f( 4.0f, 1.0f / 2.0f ) ). These parameters correspond to a displacement of half a voxel for the coarsest and finest level by using default parameters for coarsestResampling (assuming a voxel size of (1,1,1) ). This parameter is ignored if autoParameterMode is set to false.

coarsestResampling

public final SoSFVec3i32 coarsestResampling

Voxel size at the coarsest level. If the coarsestResampling[0] = 8, it means that one voxel at the coarsest level is equal to 8 voxels at the finest level for the first dimension. The coarsestResampling is specified for each one of the 3 dimensions of the volume. Default value is SbVec3i32(8,8,8). This parameter is ignored if autoParameterMode is set to false.

transformType

public final SoSFEnum<SoImageRegistrationTransform.TransformationTypes> transformType

Select the type of transform. . Default is RIGID

ignoreFinestLevel

public final SoSFBool ignoreFinestLevel

Skip the finest level of the pyramid. Default value is false.

metricType

public final SoSFEnum<SoImageRegistrationTransform.MetricTypes> metricType

Select the metric type. . Default is CORRELATION

outTransform

public final SoImageVizEngineOutput<SoSFFieldContainer,SoRegistrationResult> outTransform

Output structure storing registration results.

Constructor Detail

SoImageRegistrationTransform

public SoImageRegistrationTransform()

Constructor.

Method Detail

getOutputTransformation

public SbMatrix getOutputTransformation()

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