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 
77 class vtkCellLocator;
79 class vtkDataSet;
80 
81 class VTKCOMMONDATAMODEL_EXPORT vtkIterativeClosestPointTransform : public vtkLinearTransform
82 {
83 public:
86  void PrintSelf(ostream& os, vtkIndent indent) override;
87 
89 
94  vtkGetObjectMacro(Source, vtkDataSet);
95  vtkGetObjectMacro(Target, vtkDataSet);
97 
99 
103  void SetLocator(vtkCellLocator* locator);
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 
203 protected:
205 
208  void ReleaseSource(void);
209  void ReleaseTarget(void);
211 
215  void ReleaseLocator(void);
216 
221 
225  vtkMTimeType GetMTime() override;
226 
229 
230  void InternalUpdate() override;
231 
235  void InternalDeepCopy(vtkAbstractTransform* transform) override;
236 
246 
248  double MeanDistance;
250 
251 private:
253  void operator=(const vtkIterativeClosestPointTransform&) = delete;
254 };
255 
256 #endif
vtkIterativeClosestPointTransform::MeanDistanceMode
int MeanDistanceMode
Definition: vtkIterativeClosestPointTransform.h:242
vtkLinearTransform.h
vtkCellLocator
octree-based spatial search object to quickly locate cells
Definition: vtkCellLocator.h:150
vtkAbstractTransform
superclass for all geometric transformations
Definition: vtkAbstractTransform.h:52
vtkIterativeClosestPointTransform::SetMeanDistanceModeToAbsoluteValue
void SetMeanDistanceModeToAbsoluteValue()
Specify the mean distance mode.
Definition: vtkIterativeClosestPointTransform.h:143
vtkIterativeClosestPointTransform::CheckMeanDistance
vtkTypeBool CheckMeanDistance
Definition: vtkIterativeClosestPointTransform.h:241
vtkIterativeClosestPointTransform::MakeTransform
vtkAbstractTransform * MakeTransform() override
Make another transform of the same type.
vtkIterativeClosestPointTransform::ReleaseLocator
void ReleaseLocator(void)
Release locator.
vtkIterativeClosestPointTransform::Target
vtkDataSet * Target
Definition: vtkIterativeClosestPointTransform.h:238
vtkIterativeClosestPointTransform::Source
vtkDataSet * Source
Definition: vtkIterativeClosestPointTransform.h:237
vtkIterativeClosestPointTransform::ReleaseTarget
void ReleaseTarget(void)
Release source and target.
vtkIterativeClosestPointTransform::StartByMatchingCentroids
vtkTypeBool StartByMatchingCentroids
Definition: vtkIterativeClosestPointTransform.h:245
vtkIterativeClosestPointTransform::NumberOfIterations
int NumberOfIterations
Definition: vtkIterativeClosestPointTransform.h:247
vtkIterativeClosestPointTransform::SetSource
void SetSource(vtkDataSet *source)
Specify the source and target data sets.
VTK_ICP_MODE_RMS
#define VTK_ICP_MODE_RMS
Definition: vtkIterativeClosestPointTransform.h:74
vtkPolyData_detail::Target
Target
Definition: vtkPolyDataInternals.h:81
vtkIterativeClosestPointTransform::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkLinearTransform
abstract superclass for linear transformations
Definition: vtkLinearTransform.h:69
vtkIterativeClosestPointTransform::MaximumNumberOfLandmarks
int MaximumNumberOfLandmarks
Definition: vtkIterativeClosestPointTransform.h:244
vtkIterativeClosestPointTransform::~vtkIterativeClosestPointTransform
~vtkIterativeClosestPointTransform() override
target
boost::graph_traits< vtkGraph * >::vertex_descriptor target(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:1004
vtkIterativeClosestPointTransform::Locator
vtkCellLocator * Locator
Definition: vtkIterativeClosestPointTransform.h:239
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:113
vtkIterativeClosestPointTransform::ReleaseSource
void ReleaseSource(void)
Release source and target.
vtkIterativeClosestPointTransform::InternalDeepCopy
void InternalDeepCopy(vtkAbstractTransform *transform) override
This method does no type checking, use DeepCopy instead.
vtkIterativeClosestPointTransform::MaximumNumberOfIterations
int MaximumNumberOfIterations
Definition: vtkIterativeClosestPointTransform.h:240
VTK_ICP_MODE_AV
#define VTK_ICP_MODE_AV
Definition: vtkIterativeClosestPointTransform.h:75
vtkIterativeClosestPointTransform::Inverse
void Inverse() override
Invert the transformation.
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:166
vtkIterativeClosestPointTransform::vtkIterativeClosestPointTransform
vtkIterativeClosestPointTransform()
vtkIterativeClosestPointTransform::GetMTime
vtkMTimeType GetMTime() override
Get the MTime of this object also considering the locator.
vtkIterativeClosestPointTransform::SetLocator
void SetLocator(vtkCellLocator *locator)
Set/Get a spatial locator for speeding up the search process.
vtkIterativeClosestPointTransform::InternalUpdate
void InternalUpdate() override
Perform any subclass-specific Update.
vtkIterativeClosestPointTransform::MaximumMeanDistance
double MaximumMeanDistance
Definition: vtkIterativeClosestPointTransform.h:243
vtkIterativeClosestPointTransform::SetMeanDistanceModeToRMS
void SetMeanDistanceModeToRMS()
Specify the mean distance mode.
Definition: vtkIterativeClosestPointTransform.h:142
vtkIterativeClosestPointTransform::MeanDistance
double MeanDistance
Definition: vtkIterativeClosestPointTransform.h:248
vtkIterativeClosestPointTransform
Implementation of the ICP algorithm.
Definition: vtkIterativeClosestPointTransform.h:82
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:998
vtkIterativeClosestPointTransform::LandmarkTransform
vtkLandmarkTransform * LandmarkTransform
Definition: vtkIterativeClosestPointTransform.h:249
vtkIterativeClosestPointTransform::CreateDefaultLocator
void CreateDefaultLocator(void)
Create default locator.
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkIterativeClosestPointTransform::New
static vtkIterativeClosestPointTransform * New()
vtkLandmarkTransform
a linear transform specified by two corresponding point sets
Definition: vtkLandmarkTransform.h:102
vtkIterativeClosestPointTransform::GetMeanDistanceModeAsString
const char * GetMeanDistanceModeAsString()
Specify the mean distance mode.
vtkIterativeClosestPointTransform::SetTarget
void SetTarget(vtkDataSet *target)
Specify the source and target data sets.
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287