VTK  9.2.6
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, VTK_ICP_MODE_RMS, VTK_ICP_MODE_AV);
115  vtkGetMacro(MeanDistanceMode, int);
116  void SetMeanDistanceModeToRMS() { this->SetMeanDistanceMode(VTK_ICP_MODE_RMS); }
117  void SetMeanDistanceModeToAbsoluteValue() { this->SetMeanDistanceMode(VTK_ICP_MODE_AV); }
118  const char* GetMeanDistanceModeAsString();
120 
122 
127  vtkSetMacro(MaximumMeanDistance, double);
128  vtkGetMacro(MaximumMeanDistance, double);
130 
132 
135  vtkGetMacro(MeanDistance, double);
137 
139 
144  vtkSetMacro(MaximumNumberOfLandmarks, int);
145  vtkGetMacro(MaximumNumberOfLandmarks, int);
147 
149 
153  vtkSetMacro(StartByMatchingCentroids, vtkTypeBool);
154  vtkGetMacro(StartByMatchingCentroids, vtkTypeBool);
155  vtkBooleanMacro(StartByMatchingCentroids, vtkTypeBool);
157 
159 
163  vtkGetObjectMacro(LandmarkTransform, vtkLandmarkTransform);
165 
170  void Inverse() override;
171 
176 
177 protected:
179 
182  void ReleaseSource(void);
183  void ReleaseTarget(void);
185 
189  void ReleaseLocator(void);
190 
194  void CreateDefaultLocator(void);
195 
199  vtkMTimeType GetMTime() override;
200 
203 
204  void InternalUpdate() override;
205 
209  void InternalDeepCopy(vtkAbstractTransform* transform) override;
210 
220 
222  double MeanDistance;
224 
225 private:
227  void operator=(const vtkIterativeClosestPointTransform&) = delete;
228 };
229 
230 #endif
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkMTimeType GetMTime() override
Override GetMTime necessary because of inverse transforms.
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
virtual void InternalUpdate()
Perform any subclass-specific Update.
virtual vtkAbstractTransform * MakeTransform()=0
Make another transform of the same type.
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_ICP_MODE_RMS
octree-based spatial search object to quickly locate cells
a simple class to control print indentation
Definition: vtkIndent.h:39
a linear transform specified by two corresponding point sets
boost::graph_traits< vtkGraph * >::vertex_descriptor target(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
superclass for all geometric transformations
virtual void Inverse()=0
Invert the transformation.
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
void InternalDeepCopy(vtkAbstractTransform *transform) override
Perform any subclass-specific DeepCopy.
void SetMeanDistanceModeToAbsoluteValue()
Specify the mean distance mode.
Implementation of the ICP algorithm.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
void SetMeanDistanceModeToRMS()
Specify the mean distance mode.
abstract superclass for linear transformations