SoImageRegistrationTransform.RegistrationEvent

java.lang.Object
- com.openinventor.inventor.Inventor
- - com.openinventor.imageviz.engines.geometryandmatching.registration.SoImageRegistrationTransform.RegistrationEvent

All Implemented Interfaces:

SbEventArg

Enclosing class:

SoImageRegistrationTransform
```
public static class SoImageRegistrationTransform.RegistrationEvent
extends Inventor
implements SbEventArg
```
This event describes the evolution of the registration process. The user can access to the current similarity, the current transformation, the estimated progression.

Nested Class Summary
- Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
  Inventor.ConstructorCommand

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

Constructor Summary

Constructors
Constructor	Description
`RegistrationEvent(SoImageVizEngine engine, float progress, double similarity, SbMatrix matrix)`	Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`float`	`getProgress()`	Returns the progress value of processing in the range [0-1].
`double`	`getSimilarity()`	Returns the similarity measurement between the 2 overlapped images.
`SoImageVizEngine`	`getSource()`	Returns the source engine that raised the event.
`SbMatrix`	`getTransform()`	Returns the current estimated transformation.
`void`	`setValue(SoImageRegistrationTransform.RegistrationEvent copyFrom)`

Methods inherited from class com.openinventor.inventor.Inventor
dispose, getNativeResourceHandle

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

- Constructor Detail
  - RegistrationEvent
```
public RegistrationEvent(SoImageVizEngine engine,
                         float progress,
                         double similarity,
                         SbMatrix matrix)
```
    Default constructor.
- Method Detail
  - getSimilarity
```
public double getSimilarity()
```
    Returns the similarity measurement between the 2 overlapped images. The measurement and the range of the similarity will vary according to the metric type. Whatever the metric used, a higher similarity means a better registration. Similarity values from different metrics cannot be compared.
    The similarity value is defined in .
  - setValue
```
public void setValue(SoImageRegistrationTransform.RegistrationEvent copyFrom)
```
  - getProgress
```
public float getProgress()
```
    Returns the progress value of processing in the range [0-1].
  - getSource
```
public SoImageVizEngine getSource()
```
    Returns the source engine that raised the event.
    
    Specified by:
    
    getSource in interface SbEventArg
  - getTransform
```
public SbMatrix getTransform()
```
    Returns the current estimated transformation.