SoImageRegistrationTransform3d

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

All Implemented Interfaces:: SafeDisposable

Deprecated.

As of Open Inventor 9800 See documentation for more details

public class SoImageRegistrationTransform3d
extends SoImageVizEngine

SoImageRegistrationTransform3d image filter SoImageRegistrationTransform3d 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

}

See also:

SoImagePreAlignmentTransform3d, SoRegistrationResultDeprecated since Open Inventor 9800
Replaced by SoImageRegistrationTransform

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SoImageRegistrationTransform3d.MetricTypes` Deprecated. This enum defines the different types of metric.
`static class`	`SoImageRegistrationTransform3d.RegistrationEvent` Deprecated.
`static class`	`SoImageRegistrationTransform3d.TransformationTypes` Deprecated. 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
`static int`	`AFFINE` Deprecated. Use `SoImageRegistrationTransform3d.TransformationTypes.AFFINE` instead.
`SoSFBool`	`autoParameterMode` Deprecated. Automatic mode.
`SoSFVec3i32`	`coarsestResampling` Deprecated. Voxel size at the coarsest level.
`SoSFEnum<SoImageVizEngine.ComputeModes>`	`computeMode` Deprecated. Select the compute Mode (2D or 3D or AUTO) .
`static int`	`CORRELATION` Deprecated. Use `SoImageRegistrationTransform3d.MetricTypes.CORRELATION` instead.
`static int`	`EUCLIDIAN` Deprecated. Use `SoImageRegistrationTransform3d.MetricTypes.EUCLIDIAN` instead.
`SoSFBool`	`ignoreFinestLevel` Deprecated. Skip the finest level of the pyramid.
`SoSFImageDataAdapter`	`inFixedImage` Deprecated. The input reference image.
`SoSFMatrix`	`initialTransform` Deprecated. The initial transformation that pre-aligns the model onto the reference.
`SoSFImageDataAdapter`	`inMovingImage` Deprecated. The input model image.
`SoSFEnum<SoImageRegistrationTransform3d.MetricTypes>`	`metricType` Deprecated. Select the metric type.
`static int`	`NORMALIZED_MUTUAL_INFORMATION` Deprecated. Use `SoImageRegistrationTransform3d.MetricTypes.NORMALIZED_MUTUAL_INFORMATION` instead.
`SbEventHandler<SoImageRegistrationTransform3d.RegistrationEvent>`	`onProgressRegistration` Deprecated. Specific event handler for registration.
`SoSFVec2f`	`optimizerStep` Deprecated. Step size in translation at coarsest and finest scales (physical).
`SoImageVizEngineOutput<SoSFFieldContainer,SoRegistrationResult>`	`outTransform` Deprecated. Output structure storing registration results.
`static int`	`RIGID` Deprecated. Use `SoImageRegistrationTransform3d.TransformationTypes.RIGID` instead.
`static int`	`RIGID_ANSISOTROPIC_SCALING` Deprecated. Use `SoImageRegistrationTransform3d.TransformationTypes.RIGID_ANSISOTROPIC_SCALING` instead.
`static int`	`RIGID_ISOTROPIC_SCALING` Deprecated. Use `SoImageRegistrationTransform3d.TransformationTypes.RIGID_ISOTROPIC_SCALING` instead.
`SoSFEnum<SoImageRegistrationTransform3d.TransformationTypes>`	`transformType` Deprecated. Select the type of transform.
`static int`	`TRANSLATION` Deprecated. Use `SoImageRegistrationTransform3d.TransformationTypes.TRANSLATION` instead.

Fields inherited from class com.openinventor.imageviz.engines.SoImageVizEngine
CONNECTIVITY_18, CONNECTIVITY_26, CONNECTIVITY_6, MODE_2D, MODE_3D, MODE_AUTO, onBegin, onEnd, onProgress

Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors
Constructor and Description

SoImageRegistrationTransform3d()
Deprecated.

Constructor.

Constructors
Constructor and Description
`SoImageRegistrationTransform3d()` Deprecated. Constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SbMatrix`	`getOutputTransformation()` Deprecated. 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, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable, touch

Methods inherited from class com.openinventor.inventor.Inventor
getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TRANSLATION
```
@Deprecated
public static final int TRANSLATION
```
    Deprecated. Use SoImageRegistrationTransform3d.TransformationTypes.TRANSLATION instead.
  - RIGID
```
@Deprecated
public static final int RIGID
```
    Deprecated. Use SoImageRegistrationTransform3d.TransformationTypes.RIGID instead.
  - RIGID_ISOTROPIC_SCALING
```
@Deprecated
public static final int RIGID_ISOTROPIC_SCALING
```
    Deprecated. Use SoImageRegistrationTransform3d.TransformationTypes.RIGID_ISOTROPIC_SCALING instead.
  - RIGID_ANSISOTROPIC_SCALING
```
@Deprecated
public static final int RIGID_ANSISOTROPIC_SCALING
```
    Deprecated. Use SoImageRegistrationTransform3d.TransformationTypes.RIGID_ANSISOTROPIC_SCALING instead.
  - AFFINE
```
@Deprecated
public static final int AFFINE
```
    Deprecated. Use SoImageRegistrationTransform3d.TransformationTypes.AFFINE instead.
  - EUCLIDIAN
```
@Deprecated
public static final int EUCLIDIAN
```
    Deprecated. Use SoImageRegistrationTransform3d.MetricTypes.EUCLIDIAN instead.
  - CORRELATION
```
@Deprecated
public static final int CORRELATION
```
    Deprecated. Use SoImageRegistrationTransform3d.MetricTypes.CORRELATION instead.
  - NORMALIZED_MUTUAL_INFORMATION
```
@Deprecated
public static final int NORMALIZED_MUTUAL_INFORMATION
```
    Deprecated. Use SoImageRegistrationTransform3d.MetricTypes.NORMALIZED_MUTUAL_INFORMATION instead.
  - onProgressRegistration
```
public final SbEventHandler<SoImageRegistrationTransform3d.RegistrationEvent> onProgressRegistration
```
    Deprecated.
    
    Specific event handler for registration.
  - computeMode
```
public final SoSFEnum<SoImageVizEngine.ComputeModes> computeMode
```
    Deprecated.
    
    Select the compute Mode (2D or 3D or AUTO) . Default is MODE_AUTO
  - inMovingImage
```
public final SoSFImageDataAdapter inMovingImage
```
    Deprecated.
    
    The input model image. Default value is NULL. Supported types include: grayscale binary label.
  - inFixedImage
```
public final SoSFImageDataAdapter inFixedImage
```
    Deprecated.
    
    The input reference image. Default value is NULL. Supported types include: grayscale binary label.
  - initialTransform
```
public final SoSFMatrix initialTransform
```
    Deprecated.
    
    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
```
    Deprecated.
    
    Automatic mode. If true, optimization parameters (optimizerStep and coarsestResampling) are computed automatically. Default value is true.
  - optimizerStep
```
public final SoSFVec2f optimizerStep
```
    Deprecated.
    
    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 true.
  - coarsestResampling
```
public final SoSFVec3i32 coarsestResampling
```
    Deprecated.
    
    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 true.
  - transformType
```
public final SoSFEnum<SoImageRegistrationTransform3d.TransformationTypes> transformType
```
    Deprecated.
    
    Select the type of transform. . Default is RIGID
  - ignoreFinestLevel
```
public final SoSFBool ignoreFinestLevel
```
    Deprecated.
    
    Skip the finest level of the pyramid. Default value is false.
  - metricType
```
public final SoSFEnum<SoImageRegistrationTransform3d.MetricTypes> metricType
```
    Deprecated.
    
    Select the metric type. . Default is CORRELATION
  - outTransform
```
public final SoImageVizEngineOutput<SoSFFieldContainer,SoRegistrationResult> outTransform
```
    Deprecated.
    
    Output structure storing registration results.
- Constructor Detail
  - SoImageRegistrationTransform3d
```
public SoImageRegistrationTransform3d()
```
    Deprecated.
    
    Constructor.
- Method Detail
  - getOutputTransformation
```
public SbMatrix getOutputTransformation()
```
    Deprecated.
    
    return the output transform matrix that aligns the model image to the reference image.

Class SoImageRegistrationTransform3d

Nested Class Summary

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

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

Field Summary

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

Fields inherited from class com.openinventor.inventor.Inventor

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class com.openinventor.inventor.Inventor

Methods inherited from class java.lang.Object

Field Detail

TRANSLATION

RIGID

RIGID_ISOTROPIC_SCALING

RIGID_ANSISOTROPIC_SCALING

AFFINE

EUCLIDIAN

CORRELATION

NORMALIZED_MUTUAL_INFORMATION

onProgressRegistration

computeMode

inMovingImage

inFixedImage

initialTransform

autoParameterMode

optimizerStep

coarsestResampling

transformType

ignoreFinestLevel

metricType

outTransform

Constructor Detail

SoImageRegistrationTransform3d

Method Detail

getOutputTransformation