SoImageRegistrationTransform::RegistrationEvent Struct Reference

This event describes the evolution of the registration process. More...

#include <ImageViz/Engines/GeometryAndMatching/Registration/SoImageRegistrationTransform.h>

Inheritance diagram for SoImageRegistrationTransform::RegistrationEvent:

Public Member Functions
SoImageVizEngine *	getSource () const
	Returns the source engine that raised the event.
float	getProgress () const
	Returns the progress value of processing in the range [0-1].
double	getSimilarity () const
	Returns the similarity measurement between the 2 overlapped images.
SbMatrix	getTransform () const
	Returns the current estimated transformation.
	RegistrationEvent (SoImageVizEngine *engine, float progress, double similarity, const SbMatrix &matrix)
	Default constructor.
	~RegistrationEvent ()
	Destructor.

Detailed Description

This event describes the evolution of the registration process.

The user can access to the current similarity, the current transformation, the estimated progression.

Definition at line 157 of file SoImageRegistrationTransform.h.

Constructor & Destructor Documentation

RegistrationEvent()

SoImageRegistrationTransform::RegistrationEvent::RegistrationEvent ( SoImageVizEngine *  engine, float  progress, double  similarity, const SbMatrix &  matrix  )

inline

Default constructor.

Definition at line 191 of file SoImageRegistrationTransform.h.

~RegistrationEvent()

SoImageRegistrationTransform::RegistrationEvent::~RegistrationEvent ( )

inline

Destructor.

Definition at line 199 of file SoImageRegistrationTransform.h.

Member Function Documentation

getProgress()

float SoImageRegistrationTransform::RegistrationEvent::getProgress ( ) const

inline

Returns the progress value of processing in the range [0-1].

Definition at line 166 of file SoImageRegistrationTransform.h.

getSimilarity()

double SoImageRegistrationTransform::RegistrationEvent::getSimilarity ( ) const

inline

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 Use enum MetricType.

Definition at line 179 of file SoImageRegistrationTransform.h.

getSource()

SoImageVizEngine * SoImageRegistrationTransform::RegistrationEvent::getSource ( ) const

inline

Returns the source engine that raised the event.

Definition at line 160 of file SoImageRegistrationTransform.h.

getTransform()

SbMatrix SoImageRegistrationTransform::RegistrationEvent::getTransform ( ) const

inline

Returns the current estimated transformation.

Definition at line 185 of file SoImageRegistrationTransform.h.

---

The documentation for this struct was generated from the following file:

• ImageViz/Engines/GeometryAndMatching/Registration/SoImageRegistrationTransform.h