VTK
vtkIterativeClosestPointTransform.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkIterativeClosestPointTransform.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 
42 #ifndef vtkIterativeClosestPointTransform_h
43 #define vtkIterativeClosestPointTransform_h
44 
45 #include "vtkCommonDataModelModule.h" // For export macro
46 #include "vtkLinearTransform.h"
47 
48 #define VTK_ICP_MODE_RMS 0
49 #define VTK_ICP_MODE_AV 1
50 
51 class vtkCellLocator;
53 class vtkDataSet;
54 
55 class VTKCOMMONDATAMODEL_EXPORT vtkIterativeClosestPointTransform : public vtkLinearTransform
56 {
57 public:
60  void PrintSelf(ostream& os, vtkIndent indent) override;
61 
63 
66  void SetSource(vtkDataSet *source);
67  void SetTarget(vtkDataSet *target);
68  vtkGetObjectMacro(Source, vtkDataSet);
69  vtkGetObjectMacro(Target, vtkDataSet);
71 
73 
77  void SetLocator(vtkCellLocator *locator);
78  vtkGetObjectMacro(Locator,vtkCellLocator);
80 
82 
85  vtkSetMacro(MaximumNumberOfIterations, int);
86  vtkGetMacro(MaximumNumberOfIterations, int);
88 
90 
93  vtkGetMacro(NumberOfIterations, int);
95 
97 
101  vtkSetMacro(CheckMeanDistance, vtkTypeBool);
102  vtkGetMacro(CheckMeanDistance, vtkTypeBool);
103  vtkBooleanMacro(CheckMeanDistance, vtkTypeBool);
105 
107 
114  vtkSetClampMacro(MeanDistanceMode,int,
116  vtkGetMacro(MeanDistanceMode,int);
118  {this->SetMeanDistanceMode(VTK_ICP_MODE_RMS);}
120  {this->SetMeanDistanceMode(VTK_ICP_MODE_AV);}
121  const char *GetMeanDistanceModeAsString();
123 
125 
130  vtkSetMacro(MaximumMeanDistance, double);
131  vtkGetMacro(MaximumMeanDistance, double);
133 
135 
138  vtkGetMacro(MeanDistance, double);
140 
142 
147  vtkSetMacro(MaximumNumberOfLandmarks, int);
148  vtkGetMacro(MaximumNumberOfLandmarks, int);
150 
152 
156  vtkSetMacro(StartByMatchingCentroids, vtkTypeBool);
157  vtkGetMacro(StartByMatchingCentroids, vtkTypeBool);
158  vtkBooleanMacro(StartByMatchingCentroids, vtkTypeBool);
160 
162 
166  vtkGetObjectMacro(LandmarkTransform,vtkLandmarkTransform);
168 
173  void Inverse() override;
174 
179 
180 protected:
181 
183 
186  void ReleaseSource(void);
187  void ReleaseTarget(void);
189 
193  void ReleaseLocator(void);
194 
198  void CreateDefaultLocator(void);
199 
203  vtkMTimeType GetMTime() override;
204 
207 
208  void InternalUpdate() override;
209 
213  void InternalDeepCopy(vtkAbstractTransform *transform) override;
214 
224 
226  double MeanDistance;
228 private:
230  void operator=(const vtkIterativeClosestPointTransform&) = delete;
231 };
232 
233 #endif
vtkIterativeClosestPointTransform::MeanDistanceMode
int MeanDistanceMode
Definition: vtkIterativeClosestPointTransform.h:220
vtkLinearTransform.h
vtkHomogeneousTransform::InternalDeepCopy
void InternalDeepCopy(vtkAbstractTransform *transform) override
Perform any subclass-specific DeepCopy.
vtkCellLocator
octree-based spatial search object to quickly locate cells
Definition: vtkCellLocator.h:52
vtkAbstractTransform
superclass for all geometric transformations
Definition: vtkAbstractTransform.h:50
vtkIterativeClosestPointTransform::SetMeanDistanceModeToAbsoluteValue
void SetMeanDistanceModeToAbsoluteValue()
Definition: vtkIterativeClosestPointTransform.h:119
vtkIterativeClosestPointTransform::CheckMeanDistance
vtkTypeBool CheckMeanDistance
Definition: vtkIterativeClosestPointTransform.h:219
vtkAbstractTransform::Inverse
virtual void Inverse()=0
Invert the transformation.
vtkIterativeClosestPointTransform::Target
vtkDataSet * Target
Definition: vtkIterativeClosestPointTransform.h:216
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkAbstractTransform::InternalUpdate
virtual void InternalUpdate()
Perform any subclass-specific Update.
Definition: vtkAbstractTransform.h:337
vtkIterativeClosestPointTransform::Source
vtkDataSet * Source
Definition: vtkIterativeClosestPointTransform.h:215
vtkIterativeClosestPointTransform::StartByMatchingCentroids
vtkTypeBool StartByMatchingCentroids
Definition: vtkIterativeClosestPointTransform.h:223
vtkIterativeClosestPointTransform::NumberOfIterations
int NumberOfIterations
Definition: vtkIterativeClosestPointTransform.h:225
vtkLinearTransform::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
VTK_ICP_MODE_RMS
#define VTK_ICP_MODE_RMS
Definition: vtkIterativeClosestPointTransform.h:48
vtkLinearTransform
abstract superclass for linear transformations
Definition: vtkLinearTransform.h:34
vtkIterativeClosestPointTransform::MaximumNumberOfLandmarks
int MaximumNumberOfLandmarks
Definition: vtkIterativeClosestPointTransform.h:222
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:825
vtkIterativeClosestPointTransform::Locator
vtkCellLocator * Locator
Definition: vtkIterativeClosestPointTransform.h:217
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkAbstractTransform::GetMTime
vtkMTimeType GetMTime() override
Override GetMTime necessary because of inverse transforms.
vtkIterativeClosestPointTransform::MaximumNumberOfIterations
int MaximumNumberOfIterations
Definition: vtkIterativeClosestPointTransform.h:218
VTK_ICP_MODE_AV
#define VTK_ICP_MODE_AV
Definition: vtkIterativeClosestPointTransform.h:49
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
vtkIterativeClosestPointTransform::MaximumMeanDistance
double MaximumMeanDistance
Definition: vtkIterativeClosestPointTransform.h:221
vtkIterativeClosestPointTransform::SetMeanDistanceModeToRMS
void SetMeanDistanceModeToRMS()
Definition: vtkIterativeClosestPointTransform.h:117
vtkIterativeClosestPointTransform::MeanDistance
double MeanDistance
Definition: vtkIterativeClosestPointTransform.h:226
vtkIterativeClosestPointTransform
Implementation of the ICP algorithm.
Definition: vtkIterativeClosestPointTransform.h:55
vtkIterativeClosestPointTransform::LandmarkTransform
vtkLandmarkTransform * LandmarkTransform
Definition: vtkIterativeClosestPointTransform.h:227
target
boost::graph_traits< vtkGraph * >::vertex_descriptor target(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:832
vtkAbstractTransform::MakeTransform
virtual vtkAbstractTransform * MakeTransform()=0
Make another transform of the same type.
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkLandmarkTransform
a linear transform specified by two corresponding point sets
Definition: vtkLandmarkTransform.h:45
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:302