VTK  9.2.5
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 
71 #ifndef vtkIterativeClosestPointTransform_h
72 #define vtkIterativeClosestPointTransform_h
73 
74 #include "vtkCommonDataModelModule.h" // For export macro
75 #include "vtkLinearTransform.h"
76 
77 #define VTK_ICP_MODE_RMS 0
78 #define VTK_ICP_MODE_AV 1
79 
80 class vtkCellLocator;
82 class vtkDataSet;
83 
84 class VTKCOMMONDATAMODEL_EXPORT vtkIterativeClosestPointTransform : public vtkLinearTransform
85 {
86 public:
89  void PrintSelf(ostream& os, vtkIndent indent) override;
90 
92 
97  vtkGetObjectMacro(Source, vtkDataSet);
98  vtkGetObjectMacro(Target, vtkDataSet);
100 
102 
106  void SetLocator(vtkCellLocator* locator);
107  vtkGetObjectMacro(Locator, vtkCellLocator);
109 
111 
114  vtkSetMacro(MaximumNumberOfIterations, int);
115  vtkGetMacro(MaximumNumberOfIterations, int);
117 
119 
122  vtkGetMacro(NumberOfIterations, int);
124 
126 
130  vtkSetMacro(CheckMeanDistance, vtkTypeBool);
131  vtkGetMacro(CheckMeanDistance, vtkTypeBool);
132  vtkBooleanMacro(CheckMeanDistance, vtkTypeBool);
134 
136 
143  vtkSetClampMacro(MeanDistanceMode, int, VTK_ICP_MODE_RMS, VTK_ICP_MODE_AV);
144  vtkGetMacro(MeanDistanceMode, int);
145  void SetMeanDistanceModeToRMS() { this->SetMeanDistanceMode(VTK_ICP_MODE_RMS); }
146  void SetMeanDistanceModeToAbsoluteValue() { this->SetMeanDistanceMode(VTK_ICP_MODE_AV); }
149 
151 
156  vtkSetMacro(MaximumMeanDistance, double);
157  vtkGetMacro(MaximumMeanDistance, double);
159 
161 
164  vtkGetMacro(MeanDistance, double);
166 
168 
173  vtkSetMacro(MaximumNumberOfLandmarks, int);
174  vtkGetMacro(MaximumNumberOfLandmarks, int);
176 
178 
182  vtkSetMacro(StartByMatchingCentroids, vtkTypeBool);
183  vtkGetMacro(StartByMatchingCentroids, vtkTypeBool);
184  vtkBooleanMacro(StartByMatchingCentroids, vtkTypeBool);
186 
188 
192  vtkGetObjectMacro(LandmarkTransform, vtkLandmarkTransform);
194 
199  void Inverse() override;
200 
205 
206 protected:
208 
211  void ReleaseSource(void);
212  void ReleaseTarget(void);
214 
218  void ReleaseLocator(void);
219 
224 
228  vtkMTimeType GetMTime() override;
229 
232 
233  void InternalUpdate() override;
234 
238  void InternalDeepCopy(vtkAbstractTransform* transform) override;
239 
249 
251  double MeanDistance;
253 
254 private:
256  void operator=(const vtkIterativeClosestPointTransform&) = delete;
257 };
258 
259 #endif
superclass for all geometric transformations
octree-based spatial search object to quickly locate cells
abstract class to specify dataset behavior
Definition: vtkDataSet.h:172
a simple class to control print indentation
Definition: vtkIndent.h:119
Implementation of the ICP algorithm.
void InternalUpdate() override
Perform any subclass-specific Update.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void ReleaseTarget(void)
Release source and target.
vtkAbstractTransform * MakeTransform() override
Make another transform of the same type.
void CreateDefaultLocator(void)
Create default locator.
void SetMeanDistanceModeToRMS()
Specify the mean distance mode.
void SetLocator(vtkCellLocator *locator)
Set/Get a spatial locator for speeding up the search process.
static vtkIterativeClosestPointTransform * New()
void ReleaseSource(void)
Release source and target.
void InternalDeepCopy(vtkAbstractTransform *transform) override
This method does no type checking, use DeepCopy instead.
void SetSource(vtkDataSet *source)
Specify the source and target data sets.
void ReleaseLocator(void)
Release locator.
void SetTarget(vtkDataSet *target)
Specify the source and target data sets.
void Inverse() override
Invert the transformation.
void SetMeanDistanceModeToAbsoluteValue()
Specify the mean distance mode.
const char * GetMeanDistanceModeAsString()
Specify the mean distance mode.
vtkMTimeType GetMTime() override
Get the MTime of this object also considering the locator.
a linear transform specified by two corresponding point sets
abstract superclass for linear transformations
int vtkTypeBool
Definition: vtkABI.h:69
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
boost::graph_traits< vtkGraph * >::vertex_descriptor target(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
#define VTK_ICP_MODE_RMS
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287