VTK  9.1.0
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
68#ifndef vtkIterativeClosestPointTransform_h
69#define vtkIterativeClosestPointTransform_h
70
71#include "vtkCommonDataModelModule.h" // For export macro
72#include "vtkLinearTransform.h"
73
74#define VTK_ICP_MODE_RMS 0
75#define VTK_ICP_MODE_AV 1
76
77class vtkCellLocator;
79class vtkDataSet;
80
81class VTKCOMMONDATAMODEL_EXPORT vtkIterativeClosestPointTransform : public vtkLinearTransform
82{
83public:
86 void PrintSelf(ostream& os, vtkIndent indent) override;
87
89
94 vtkGetObjectMacro(Source, vtkDataSet);
95 vtkGetObjectMacro(Target, vtkDataSet);
97
99
104 vtkGetObjectMacro(Locator, vtkCellLocator);
106
108
111 vtkSetMacro(MaximumNumberOfIterations, int);
112 vtkGetMacro(MaximumNumberOfIterations, int);
114
116
119 vtkGetMacro(NumberOfIterations, int);
121
123
127 vtkSetMacro(CheckMeanDistance, vtkTypeBool);
128 vtkGetMacro(CheckMeanDistance, vtkTypeBool);
129 vtkBooleanMacro(CheckMeanDistance, vtkTypeBool);
131
133
140 vtkSetClampMacro(MeanDistanceMode, int, VTK_ICP_MODE_RMS, VTK_ICP_MODE_AV);
141 vtkGetMacro(MeanDistanceMode, int);
142 void SetMeanDistanceModeToRMS() { this->SetMeanDistanceMode(VTK_ICP_MODE_RMS); }
143 void SetMeanDistanceModeToAbsoluteValue() { this->SetMeanDistanceMode(VTK_ICP_MODE_AV); }
146
148
153 vtkSetMacro(MaximumMeanDistance, double);
154 vtkGetMacro(MaximumMeanDistance, double);
156
158
161 vtkGetMacro(MeanDistance, double);
163
165
170 vtkSetMacro(MaximumNumberOfLandmarks, int);
171 vtkGetMacro(MaximumNumberOfLandmarks, int);
173
175
179 vtkSetMacro(StartByMatchingCentroids, vtkTypeBool);
180 vtkGetMacro(StartByMatchingCentroids, vtkTypeBool);
181 vtkBooleanMacro(StartByMatchingCentroids, vtkTypeBool);
183
185
189 vtkGetObjectMacro(LandmarkTransform, vtkLandmarkTransform);
191
196 void Inverse() override;
197
202
203protected:
205
208 void ReleaseSource(void);
209 void ReleaseTarget(void);
211
215 void ReleaseLocator(void);
216
221
226
229
230 void InternalUpdate() override;
231
235 void InternalDeepCopy(vtkAbstractTransform* transform) override;
236
246
250
251private:
253 void operator=(const vtkIterativeClosestPointTransform&) = delete;
254};
255
256#endif
superclass for all geometric transformations
octree-based spatial search object to quickly locate cells
abstract class to specify dataset behavior
Definition: vtkDataSet.h:166
a simple class to control print indentation
Definition: vtkIndent.h:113
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.
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.
static vtkIterativeClosestPointTransform * New()
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