VTK  9.3.20241002
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkIterativeClosestPointTransform Class Reference

Implementation of the ICP algorithm. More...

#include <vtkIterativeClosestPointTransform.h>

Inheritance diagram for vtkIterativeClosestPointTransform:
[legend]
Collaboration diagram for vtkIterativeClosestPointTransform:
[legend]

Public Types

typedef vtkLinearTransform Superclass
 
- Public Types inherited from vtkLinearTransform
typedef vtkHomogeneousTransform Superclass
 
- Public Types inherited from vtkHomogeneousTransform
typedef vtkAbstractTransform Superclass
 
- Public Types inherited from vtkAbstractTransform
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkIterativeClosestPointTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void Inverse () override
 Invert the transformation.
 
vtkAbstractTransformMakeTransform () override
 Make another transform of the same type.
 
void SetSource (vtkDataSet *source)
 Specify the source and target data sets.
 
void SetTarget (vtkDataSet *target)
 Specify the source and target data sets.
 
virtual vtkDataSetGetSource ()
 Specify the source and target data sets.
 
virtual vtkDataSetGetTarget ()
 Specify the source and target data sets.
 
void SetLocator (vtkCellLocator *locator)
 Set/Get a spatial locator for speeding up the search process.
 
virtual vtkCellLocatorGetLocator ()
 Set/Get a spatial locator for speeding up the search process.
 
virtual void SetMaximumNumberOfIterations (int)
 Set/Get the maximum number of iterations.
 
virtual int GetMaximumNumberOfIterations ()
 Set/Get the maximum number of iterations.
 
virtual int GetNumberOfIterations ()
 Get the number of iterations since the last update.
 
virtual void SetCheckMeanDistance (vtkTypeBool)
 Force the algorithm to check the mean distance between two iterations.
 
virtual vtkTypeBool GetCheckMeanDistance ()
 Force the algorithm to check the mean distance between two iterations.
 
virtual void CheckMeanDistanceOn ()
 Force the algorithm to check the mean distance between two iterations.
 
virtual void CheckMeanDistanceOff ()
 Force the algorithm to check the mean distance between two iterations.
 
virtual void SetMeanDistanceMode (int)
 Specify the mean distance mode.
 
virtual int GetMeanDistanceMode ()
 Specify the mean distance mode.
 
void SetMeanDistanceModeToRMS ()
 Specify the mean distance mode.
 
void SetMeanDistanceModeToAbsoluteValue ()
 Specify the mean distance mode.
 
const char * GetMeanDistanceModeAsString ()
 Specify the mean distance mode.
 
virtual void SetMaximumMeanDistance (double)
 Set/Get the maximum mean distance between two iteration.
 
virtual double GetMaximumMeanDistance ()
 Set/Get the maximum mean distance between two iteration.
 
virtual double GetMeanDistance ()
 Get the mean distance between the last two iterations.
 
virtual void SetMaximumNumberOfLandmarks (int)
 Set/Get the maximum number of landmarks sampled in your dataset.
 
virtual int GetMaximumNumberOfLandmarks ()
 Set/Get the maximum number of landmarks sampled in your dataset.
 
virtual void SetStartByMatchingCentroids (vtkTypeBool)
 Starts the process by translating source centroid to target centroid.
 
virtual vtkTypeBool GetStartByMatchingCentroids ()
 Starts the process by translating source centroid to target centroid.
 
virtual void StartByMatchingCentroidsOn ()
 Starts the process by translating source centroid to target centroid.
 
virtual void StartByMatchingCentroidsOff ()
 Starts the process by translating source centroid to target centroid.
 
virtual vtkLandmarkTransformGetLandmarkTransform ()
 Get the internal landmark transform.
 
- Public Member Functions inherited from vtkLinearTransform
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkLinearTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void TransformNormal (const float in[3], float out[3])
 Apply the transformation to a normal.
 
void TransformNormal (const double in[3], double out[3])
 Apply the transformation to a double-precision normal.
 
double * TransformNormal (double x, double y, double z)
 Synonymous with TransformDoubleNormal(x,y,z).
 
double * TransformNormal (const double normal[3])
 
double * TransformVector (double x, double y, double z)
 Synonymous with TransformDoubleVector(x,y,z).
 
double * TransformVector (const double normal[3])
 
void TransformVector (const float in[3], float out[3])
 Apply the transformation to a vector.
 
void TransformVector (const double in[3], double out[3])
 Apply the transformation to a double-precision vector.
 
void TransformPoints (vtkPoints *inPts, vtkPoints *outPts) override
 Apply the transformation to a series of points, and append the results to outPts.
 
virtual void TransformNormals (vtkDataArray *inNms, vtkDataArray *outNms)
 Apply the transformation to a series of normals, and append the results to outNms.
 
virtual void TransformVectors (vtkDataArray *inVrs, vtkDataArray *outVrs)
 Apply the transformation to a series of vectors, and append the results to outVrs.
 
void TransformPointsNormalsVectors (vtkPoints *inPts, vtkPoints *outPts, vtkDataArray *inNms, vtkDataArray *outNms, vtkDataArray *inVrs, vtkDataArray *outVrs, int nOptionalVectors=0, vtkDataArray **inVrsArr=nullptr, vtkDataArray **outVrsArr=nullptr) override
 Apply the transformation to a combination of points, normals and vectors.
 
vtkLinearTransformGetLinearInverse ()
 Just like GetInverse, but it includes a typecast to vtkLinearTransform.
 
float * TransformFloatNormal (float x, float y, float z)
 Apply the transformation to an (x,y,z) normal.
 
float * TransformFloatNormal (const float normal[3])
 Apply the transformation to an (x,y,z) normal.
 
double * TransformDoubleNormal (double x, double y, double z)
 Apply the transformation to a double-precision (x,y,z) normal.
 
double * TransformDoubleNormal (const double normal[3])
 Apply the transformation to a double-precision (x,y,z) normal.
 
float * TransformFloatVector (float x, float y, float z)
 Apply the transformation to an (x,y,z) vector.
 
float * TransformFloatVector (const float vec[3])
 Apply the transformation to an (x,y,z) vector.
 
double * TransformDoubleVector (double x, double y, double z)
 Apply the transformation to a double-precision (x,y,z) vector.
 
double * TransformDoubleVector (const double vec[3])
 Apply the transformation to a double-precision (x,y,z) vector.
 
void InternalTransformPoint (const float in[3], float out[3]) override
 This will calculate the transformation without calling Update.
 
void InternalTransformPoint (const double in[3], double out[3]) override
 This will calculate the transformation without calling Update.
 
virtual void InternalTransformNormal (const float in[3], float out[3])
 This will calculate the transformation without calling Update.
 
virtual void InternalTransformNormal (const double in[3], double out[3])
 This will calculate the transformation without calling Update.
 
virtual void InternalTransformVector (const float in[3], float out[3])
 This will calculate the transformation without calling Update.
 
virtual void InternalTransformVector (const double in[3], double out[3])
 This will calculate the transformation without calling Update.
 
void InternalTransformDerivative (const float in[3], float out[3], float derivative[3][3]) override
 This will calculate the transformation as well as its derivative without calling Update.
 
void InternalTransformDerivative (const double in[3], double out[3], double derivative[3][3]) override
 This will calculate the transformation as well as its derivative without calling Update.
 
- Public Member Functions inherited from vtkHomogeneousTransform
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkHomogeneousTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void TransformPoints (vtkPoints *inPts, vtkPoints *outPts) override
 Apply the transformation to a series of points, and append the results to outPts.
 
void TransformPointsNormalsVectors (vtkPoints *inPts, vtkPoints *outPts, vtkDataArray *inNms, vtkDataArray *outNms, vtkDataArray *inVrs, vtkDataArray *outVrs, int nOptionalVectors=0, vtkDataArray **inVrsArr=nullptr, vtkDataArray **outVrsArr=nullptr) override
 Apply the transformation to a combination of points, normals and vectors.
 
void GetMatrix (vtkMatrix4x4 *m)
 Get a copy of the internal transformation matrix.
 
vtkMatrix4x4GetMatrix ()
 Get a pointer to an internal vtkMatrix4x4 that represents the transformation.
 
vtkHomogeneousTransformGetHomogeneousInverse ()
 Just like GetInverse(), but includes typecast to vtkHomogeneousTransform.
 
- Public Member Functions inherited from vtkAbstractTransform
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAbstractTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void TransformPoint (const float in[3], float out[3])
 Apply the transformation to a coordinate.
 
void TransformPoint (const double in[3], double out[3])
 Apply the transformation to a double-precision coordinate.
 
double * TransformPoint (double x, double y, double z)
 Apply the transformation to a double-precision coordinate.
 
double * TransformPoint (const double point[3])
 
double * TransformNormalAtPoint (const double point[3], const double normal[3])
 
double * TransformVectorAtPoint (const double point[3], const double vector[3])
 
virtual void TransformPoints (vtkPoints *inPts, vtkPoints *outPts)
 Apply the transformation to a series of points, and append the results to outPts.
 
virtual void TransformPointsNormalsVectors (vtkPoints *inPts, vtkPoints *outPts, vtkDataArray *inNms, vtkDataArray *outNms, vtkDataArray *inVrs, vtkDataArray *outVrs, int nOptionalVectors=0, vtkDataArray **inVrsArr=nullptr, vtkDataArray **outVrsArr=nullptr)
 Apply the transformation to a combination of points, normals and vectors.
 
vtkAbstractTransformGetInverse ()
 Get the inverse of this transform.
 
void SetInverse (vtkAbstractTransform *transform)
 Set a transformation that this transform will be the inverse of.
 
virtual void Inverse ()=0
 Invert the transformation.
 
void DeepCopy (vtkAbstractTransform *)
 Copy this transform from another of the same type.
 
void Update ()
 Update the transform to account for any changes which have been made.
 
virtual vtkAbstractTransformMakeTransform ()=0
 Make another transform of the same type.
 
virtual int CircuitCheck (vtkAbstractTransform *transform)
 Check for self-reference.
 
vtkMTimeType GetMTime () override
 Override GetMTime necessary because of inverse transforms.
 
void UnRegister (vtkObjectBase *O) override
 Needs a special UnRegister() implementation to avoid circular references.
 
float * TransformFloatPoint (float x, float y, float z)
 Apply the transformation to an (x,y,z) coordinate.
 
float * TransformFloatPoint (const float point[3])
 Apply the transformation to an (x,y,z) coordinate.
 
double * TransformDoublePoint (double x, double y, double z)
 Apply the transformation to a double-precision (x,y,z) coordinate.
 
double * TransformDoublePoint (const double point[3])
 Apply the transformation to a double-precision (x,y,z) coordinate.
 
void TransformNormalAtPoint (const float point[3], const float in[3], float out[3])
 Apply the transformation to a normal at the specified vertex.
 
void TransformNormalAtPoint (const double point[3], const double in[3], double out[3])
 Apply the transformation to a normal at the specified vertex.
 
double * TransformDoubleNormalAtPoint (const double point[3], const double normal[3])
 Apply the transformation to a double-precision normal at the specified vertex.
 
float * TransformFloatNormalAtPoint (const float point[3], const float normal[3])
 Apply the transformation to a single-precision normal at the specified vertex.
 
void TransformVectorAtPoint (const float point[3], const float in[3], float out[3])
 Apply the transformation to a vector at the specified vertex.
 
void TransformVectorAtPoint (const double point[3], const double in[3], double out[3])
 Apply the transformation to a vector at the specified vertex.
 
double * TransformDoubleVectorAtPoint (const double point[3], const double vector[3])
 Apply the transformation to a double-precision vector at the specified vertex.
 
float * TransformFloatVectorAtPoint (const float point[3], const float vector[3])
 Apply the transformation to a single-precision vector at the specified vertex.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkIterativeClosestPointTransformNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkIterativeClosestPointTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkLinearTransform
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLinearTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkHomogeneousTransform
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkHomogeneousTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractTransform
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
void ReleaseLocator ()
 Release locator.
 
void CreateDefaultLocator ()
 Create default locator.
 
vtkMTimeType GetMTime () override
 Get the MTime of this object also considering the locator.
 
 vtkIterativeClosestPointTransform ()
 
 ~vtkIterativeClosestPointTransform () override
 
void InternalUpdate () override
 Perform any subclass-specific Update.
 
void InternalDeepCopy (vtkAbstractTransform *transform) override
 This method does no type checking, use DeepCopy instead.
 
void ReleaseSource ()
 Release source and target.
 
void ReleaseTarget ()
 Release source and target.
 
- Protected Member Functions inherited from vtkLinearTransform
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkLinearTransform ()=default
 
 ~vtkLinearTransform () override=default
 
- Protected Member Functions inherited from vtkHomogeneousTransform
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkHomogeneousTransform ()
 
 ~vtkHomogeneousTransform () override
 
void InternalDeepCopy (vtkAbstractTransform *transform) override
 Perform any subclass-specific DeepCopy.
 
- Protected Member Functions inherited from vtkAbstractTransform
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractTransform ()
 
 ~vtkAbstractTransform () override
 
virtual void InternalUpdate ()
 Perform any subclass-specific Update.
 
virtual void InternalDeepCopy (vtkAbstractTransform *)
 Perform any subclass-specific DeepCopy.
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkDataSetSource
 
vtkDataSetTarget
 
vtkCellLocatorLocator
 
int MaximumNumberOfIterations
 
vtkTypeBool CheckMeanDistance
 
int MeanDistanceMode
 
double MaximumMeanDistance
 
int MaximumNumberOfLandmarks
 
vtkTypeBool StartByMatchingCentroids
 
int NumberOfIterations
 
double MeanDistance
 
vtkLandmarkTransformLandmarkTransform
 
- Protected Attributes inherited from vtkHomogeneousTransform
vtkMatrix4x4Matrix
 
- Protected Attributes inherited from vtkAbstractTransform
float InternalFloatPoint [3]
 
double InternalDoublePoint [3]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Implementation of the ICP algorithm.

Match two surfaces using the iterative closest point (ICP) algorithm. The core of the algorithm is to match each vertex in one surface with the closest surface point on the other, then apply the transformation that modify one surface to best match the other (in a least square sense). This has to be iterated to get proper convergence of the surfaces.

Attention
Use vtkTransformPolyDataFilter to apply the resulting ICP transform to your data. You might also set it to your actor's user transform.
This class makes use of vtkLandmarkTransform internally to compute the best fit. Use the GetLandmarkTransform member to get a pointer to that transform and set its parameters. You might, for example, constrain the number of degrees of freedom of the solution (i.e. rigid body, similarity, etc.) by checking the vtkLandmarkTransform documentation for its SetMode member.
See also
vtkLandmarkTransform
Online Examples:

Tests:
vtkIterativeClosestPointTransform (Tests)

Definition at line 73 of file vtkIterativeClosestPointTransform.h.

Member Typedef Documentation

◆ Superclass

Definition at line 77 of file vtkIterativeClosestPointTransform.h.

Constructor & Destructor Documentation

◆ vtkIterativeClosestPointTransform()

vtkIterativeClosestPointTransform::vtkIterativeClosestPointTransform ( )
protected

◆ ~vtkIterativeClosestPointTransform()

vtkIterativeClosestPointTransform::~vtkIterativeClosestPointTransform ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkIterativeClosestPointTransform * vtkIterativeClosestPointTransform::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkIterativeClosestPointTransform::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkIterativeClosestPointTransform::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkLinearTransform.

◆ SafeDownCast()

static vtkIterativeClosestPointTransform * vtkIterativeClosestPointTransform::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkIterativeClosestPointTransform::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkLinearTransform.

◆ NewInstance()

vtkIterativeClosestPointTransform * vtkIterativeClosestPointTransform::NewInstance ( ) const

◆ PrintSelf()

void vtkIterativeClosestPointTransform::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkHomogeneousTransform.

◆ SetSource()

void vtkIterativeClosestPointTransform::SetSource ( vtkDataSet source)

Specify the source and target data sets.

◆ SetTarget()

void vtkIterativeClosestPointTransform::SetTarget ( vtkDataSet target)

Specify the source and target data sets.

◆ GetSource()

virtual vtkDataSet * vtkIterativeClosestPointTransform::GetSource ( )
virtual

Specify the source and target data sets.

◆ GetTarget()

virtual vtkDataSet * vtkIterativeClosestPointTransform::GetTarget ( )
virtual

Specify the source and target data sets.

◆ SetLocator()

void vtkIterativeClosestPointTransform::SetLocator ( vtkCellLocator locator)

Set/Get a spatial locator for speeding up the search process.

An instance of vtkCellLocator is used by default.

◆ GetLocator()

virtual vtkCellLocator * vtkIterativeClosestPointTransform::GetLocator ( )
virtual

Set/Get a spatial locator for speeding up the search process.

An instance of vtkCellLocator is used by default.

◆ SetMaximumNumberOfIterations()

virtual void vtkIterativeClosestPointTransform::SetMaximumNumberOfIterations ( int  )
virtual

Set/Get the maximum number of iterations.

Default is 50.

◆ GetMaximumNumberOfIterations()

virtual int vtkIterativeClosestPointTransform::GetMaximumNumberOfIterations ( )
virtual

Set/Get the maximum number of iterations.

Default is 50.

◆ GetNumberOfIterations()

virtual int vtkIterativeClosestPointTransform::GetNumberOfIterations ( )
virtual

Get the number of iterations since the last update.

◆ SetCheckMeanDistance()

virtual void vtkIterativeClosestPointTransform::SetCheckMeanDistance ( vtkTypeBool  )
virtual

Force the algorithm to check the mean distance between two iterations.

Default is Off.

◆ GetCheckMeanDistance()

virtual vtkTypeBool vtkIterativeClosestPointTransform::GetCheckMeanDistance ( )
virtual

Force the algorithm to check the mean distance between two iterations.

Default is Off.

◆ CheckMeanDistanceOn()

virtual void vtkIterativeClosestPointTransform::CheckMeanDistanceOn ( )
virtual

Force the algorithm to check the mean distance between two iterations.

Default is Off.

◆ CheckMeanDistanceOff()

virtual void vtkIterativeClosestPointTransform::CheckMeanDistanceOff ( )
virtual

Force the algorithm to check the mean distance between two iterations.

Default is Off.

◆ SetMeanDistanceMode()

virtual void vtkIterativeClosestPointTransform::SetMeanDistanceMode ( int  )
virtual

Specify the mean distance mode.

This mode expresses how the mean distance is computed. The RMS mode is the square root of the average of the sum of squares of the closest point distances. The Absolute Value mode is the mean of the sum of absolute values of the closest point distances. The default is VTK_ICP_MODE_RMS

◆ GetMeanDistanceMode()

virtual int vtkIterativeClosestPointTransform::GetMeanDistanceMode ( )
virtual

Specify the mean distance mode.

This mode expresses how the mean distance is computed. The RMS mode is the square root of the average of the sum of squares of the closest point distances. The Absolute Value mode is the mean of the sum of absolute values of the closest point distances. The default is VTK_ICP_MODE_RMS

◆ SetMeanDistanceModeToRMS()

void vtkIterativeClosestPointTransform::SetMeanDistanceModeToRMS ( )
inline

Specify the mean distance mode.

This mode expresses how the mean distance is computed. The RMS mode is the square root of the average of the sum of squares of the closest point distances. The Absolute Value mode is the mean of the sum of absolute values of the closest point distances. The default is VTK_ICP_MODE_RMS

Definition at line 134 of file vtkIterativeClosestPointTransform.h.

◆ SetMeanDistanceModeToAbsoluteValue()

void vtkIterativeClosestPointTransform::SetMeanDistanceModeToAbsoluteValue ( )
inline

Specify the mean distance mode.

This mode expresses how the mean distance is computed. The RMS mode is the square root of the average of the sum of squares of the closest point distances. The Absolute Value mode is the mean of the sum of absolute values of the closest point distances. The default is VTK_ICP_MODE_RMS

Definition at line 135 of file vtkIterativeClosestPointTransform.h.

◆ GetMeanDistanceModeAsString()

const char * vtkIterativeClosestPointTransform::GetMeanDistanceModeAsString ( )

Specify the mean distance mode.

This mode expresses how the mean distance is computed. The RMS mode is the square root of the average of the sum of squares of the closest point distances. The Absolute Value mode is the mean of the sum of absolute values of the closest point distances. The default is VTK_ICP_MODE_RMS

◆ SetMaximumMeanDistance()

virtual void vtkIterativeClosestPointTransform::SetMaximumMeanDistance ( double  )
virtual

Set/Get the maximum mean distance between two iteration.

If the mean distance is lower than this, the convergence stops. The default is 0.01.

◆ GetMaximumMeanDistance()

virtual double vtkIterativeClosestPointTransform::GetMaximumMeanDistance ( )
virtual

Set/Get the maximum mean distance between two iteration.

If the mean distance is lower than this, the convergence stops. The default is 0.01.

◆ GetMeanDistance()

virtual double vtkIterativeClosestPointTransform::GetMeanDistance ( )
virtual

Get the mean distance between the last two iterations.

◆ SetMaximumNumberOfLandmarks()

virtual void vtkIterativeClosestPointTransform::SetMaximumNumberOfLandmarks ( int  )
virtual

Set/Get the maximum number of landmarks sampled in your dataset.

If your dataset is dense, then you will typically not need all the points to compute the ICP transform. The default is 200.

◆ GetMaximumNumberOfLandmarks()

virtual int vtkIterativeClosestPointTransform::GetMaximumNumberOfLandmarks ( )
virtual

Set/Get the maximum number of landmarks sampled in your dataset.

If your dataset is dense, then you will typically not need all the points to compute the ICP transform. The default is 200.

◆ SetStartByMatchingCentroids()

virtual void vtkIterativeClosestPointTransform::SetStartByMatchingCentroids ( vtkTypeBool  )
virtual

Starts the process by translating source centroid to target centroid.

The default is Off.

◆ GetStartByMatchingCentroids()

virtual vtkTypeBool vtkIterativeClosestPointTransform::GetStartByMatchingCentroids ( )
virtual

Starts the process by translating source centroid to target centroid.

The default is Off.

◆ StartByMatchingCentroidsOn()

virtual void vtkIterativeClosestPointTransform::StartByMatchingCentroidsOn ( )
virtual

Starts the process by translating source centroid to target centroid.

The default is Off.

◆ StartByMatchingCentroidsOff()

virtual void vtkIterativeClosestPointTransform::StartByMatchingCentroidsOff ( )
virtual

Starts the process by translating source centroid to target centroid.

The default is Off.

◆ GetLandmarkTransform()

virtual vtkLandmarkTransform * vtkIterativeClosestPointTransform::GetLandmarkTransform ( )
virtual

Get the internal landmark transform.

Use it to constrain the number of degrees of freedom of the solution (i.e. rigid body, similarity, etc.).

◆ Inverse()

void vtkIterativeClosestPointTransform::Inverse ( )
overridevirtual

Invert the transformation.

This is done by switching the source and target.

Implements vtkAbstractTransform.

◆ MakeTransform()

vtkAbstractTransform * vtkIterativeClosestPointTransform::MakeTransform ( )
overridevirtual

Make another transform of the same type.

Implements vtkAbstractTransform.

◆ ReleaseSource()

void vtkIterativeClosestPointTransform::ReleaseSource ( )
protected

Release source and target.

◆ ReleaseTarget()

void vtkIterativeClosestPointTransform::ReleaseTarget ( )
protected

Release source and target.

◆ ReleaseLocator()

void vtkIterativeClosestPointTransform::ReleaseLocator ( )
protected

Release locator.

◆ CreateDefaultLocator()

void vtkIterativeClosestPointTransform::CreateDefaultLocator ( )
protected

Create default locator.

Used to create one when none is specified.

◆ GetMTime()

vtkMTimeType vtkIterativeClosestPointTransform::GetMTime ( )
overrideprotectedvirtual

Get the MTime of this object also considering the locator.

Reimplemented from vtkAbstractTransform.

◆ InternalUpdate()

void vtkIterativeClosestPointTransform::InternalUpdate ( )
overrideprotectedvirtual

Perform any subclass-specific Update.

Reimplemented from vtkAbstractTransform.

◆ InternalDeepCopy()

void vtkIterativeClosestPointTransform::InternalDeepCopy ( vtkAbstractTransform transform)
overrideprotectedvirtual

This method does no type checking, use DeepCopy instead.

Reimplemented from vtkHomogeneousTransform.

Member Data Documentation

◆ Source

vtkDataSet* vtkIterativeClosestPointTransform::Source
protected

Definition at line 229 of file vtkIterativeClosestPointTransform.h.

◆ Target

vtkDataSet* vtkIterativeClosestPointTransform::Target
protected

Definition at line 230 of file vtkIterativeClosestPointTransform.h.

◆ Locator

vtkCellLocator* vtkIterativeClosestPointTransform::Locator
protected

Definition at line 231 of file vtkIterativeClosestPointTransform.h.

◆ MaximumNumberOfIterations

int vtkIterativeClosestPointTransform::MaximumNumberOfIterations
protected

Definition at line 232 of file vtkIterativeClosestPointTransform.h.

◆ CheckMeanDistance

vtkTypeBool vtkIterativeClosestPointTransform::CheckMeanDistance
protected

Definition at line 233 of file vtkIterativeClosestPointTransform.h.

◆ MeanDistanceMode

int vtkIterativeClosestPointTransform::MeanDistanceMode
protected

Definition at line 234 of file vtkIterativeClosestPointTransform.h.

◆ MaximumMeanDistance

double vtkIterativeClosestPointTransform::MaximumMeanDistance
protected

Definition at line 235 of file vtkIterativeClosestPointTransform.h.

◆ MaximumNumberOfLandmarks

int vtkIterativeClosestPointTransform::MaximumNumberOfLandmarks
protected

Definition at line 236 of file vtkIterativeClosestPointTransform.h.

◆ StartByMatchingCentroids

vtkTypeBool vtkIterativeClosestPointTransform::StartByMatchingCentroids
protected

Definition at line 237 of file vtkIterativeClosestPointTransform.h.

◆ NumberOfIterations

int vtkIterativeClosestPointTransform::NumberOfIterations
protected

Definition at line 239 of file vtkIterativeClosestPointTransform.h.

◆ MeanDistance

double vtkIterativeClosestPointTransform::MeanDistance
protected

Definition at line 240 of file vtkIterativeClosestPointTransform.h.

◆ LandmarkTransform

vtkLandmarkTransform* vtkIterativeClosestPointTransform::LandmarkTransform
protected

Definition at line 241 of file vtkIterativeClosestPointTransform.h.


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