| SoImageRegistrationTransform Class |
SoImageRegistrationTransform image filter
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.EnginesSoEngine
OIV.ImageViz.EnginesSoImageVizEngine
OIV.ImageViz.Engines.GeometryAndMatching.RegistrationSoImageRegistrationTransform
Namespace: OIV.ImageViz.Engines.GeometryAndMatching.Registration
Assembly: OIV.ImageViz (in OIV.ImageViz.dll) Version: 9.9.13.0 (9.9.13.0)
SyntaxThe SoImageRegistrationTransform type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoImageRegistrationTransform | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AbortEvaluate | Abort current processing as soon as possible. |
| Copy | Creates and returns an exact copy of the engine. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetName | Returns the name of an instance. |
| GetOutput | Returns a reference to the engine output with the given name. |
| GetOutputName | Returns (in outputName) the name of the engine output (output). |
| GetOutputs | Returns a list of outputs in this engine. |
| GetOutputTransformation | return the output transform matrix that aligns the model image to the reference image. |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsEvaluating | Returns true if the engine evaluation is in progress. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Set | 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. |
| SetName | (Inherited from SoBase.) |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| StartEvaluate | Evaluate engine and dependencies in another thread without blocking the current one. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| WaitEvaluate | Wait for the end of engine evaluation. |
Properties| Name | Description | |
|---|---|---|
 | autoParameterMode | Automatic mode. |
| coarsestResampling | Voxel size at the coarsest level. |
| computeMode | Select the compute Mode (2D or 3D or AUTO) . |
| ignoreFinestLevel | Skip the finest level of the pyramid. |
| inFixedImage | The input reference image. |
| initialTransform | The initial transformation that pre-aligns the model onto the reference. |
| inMovingImage | The input model image. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| metricType | Select the metric type. |
| optimizerStep | Step size in translation at coarsest and finest scales (physical). |
| outTransform | Output structure storing registration results. |
| transformType | Select the type of transform. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
Events| Name | Description | |
|---|---|---|
 | OnBegin | Event raised when the processing begins. |
| OnEnd | Event raised when processing ends and the result is available. |
| OnProgress | Event raised while processing is running. |
| OnProgressRegistration | Specific event handler for registration. |
RemarksSoImageRegistrationTransform 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:
| 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