VTK  9.0.1
vtkThinPlateSplineTransform.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkThinPlateSplineTransform.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 =========================================================================*/
40 #ifndef vtkThinPlateSplineTransform_h
41 #define vtkThinPlateSplineTransform_h
42 
43 #include "vtkCommonTransformsModule.h" // For export macro
44 #include "vtkWarpTransform.h"
45 
46 #define VTK_RBF_CUSTOM 0
47 #define VTK_RBF_R 1
48 #define VTK_RBF_R2LOGR 2
49 
50 class VTKCOMMONTRANSFORMS_EXPORT vtkThinPlateSplineTransform : public vtkWarpTransform
51 {
52 public:
54  void PrintSelf(ostream& os, vtkIndent indent) override;
56 
58 
61  vtkGetMacro(Sigma, double);
62  vtkSetMacro(Sigma, double);
64 
66 
73  void SetBasis(int basis);
74  vtkGetMacro(Basis, int);
75  void SetBasisToR() { this->SetBasis(VTK_RBF_R); }
76  void SetBasisToR2LogR() { this->SetBasis(VTK_RBF_R2LOGR); }
77  const char* GetBasisAsString();
79 
81 
85  void SetBasisFunction(double (*U)(double r))
86  {
87  if (this->BasisFunction == U)
88  {
89  return;
90  }
91  this->SetBasis(VTK_RBF_CUSTOM);
92  this->BasisFunction = U;
93  this->Modified();
94  }
95  void SetBasisDerivative(double (*dUdr)(double r, double& dU))
96  {
97  this->BasisDerivative = dUdr;
98  this->Modified();
99  }
101 
103 
108  void SetSourceLandmarks(vtkPoints* source);
109  vtkGetObjectMacro(SourceLandmarks, vtkPoints);
111 
113 
118  void SetTargetLandmarks(vtkPoints* target);
119  vtkGetObjectMacro(TargetLandmarks, vtkPoints);
121 
125  vtkMTimeType GetMTime() override;
126 
131 
133 
149  vtkGetMacro(RegularizeBulkTransform, bool);
150  vtkSetMacro(RegularizeBulkTransform, bool);
151  vtkBooleanMacro(RegularizeBulkTransform, bool);
153 
154 protected:
156  ~vtkThinPlateSplineTransform() override;
157 
161  void InternalUpdate() override;
162 
166  void InternalDeepCopy(vtkAbstractTransform* transform) override;
167 
168  void ForwardTransformPoint(const float in[3], float out[3]) override;
169  void ForwardTransformPoint(const double in[3], double out[3]) override;
170 
171  void ForwardTransformDerivative(const float in[3], float out[3], float derivative[3][3]) override;
173  const double in[3], double out[3], double derivative[3][3]) override;
174 
175  double Sigma;
178 
179  // the radial basis function to use
180  double (*BasisFunction)(double r);
181  double (*BasisDerivative)(double r, double& dUdr);
182 
183  int Basis;
184 
186  double** MatrixW;
187 
189 
190 private:
192  void operator=(const vtkThinPlateSplineTransform&) = delete;
193 };
194 
195 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:33
VTK_RBF_R2LOGR
#define VTK_RBF_R2LOGR
Definition: vtkThinPlateSplineTransform.h:48
VTK_RBF_R
#define VTK_RBF_R
Definition: vtkThinPlateSplineTransform.h:47
vtkThinPlateSplineTransform::Basis
int Basis
Definition: vtkThinPlateSplineTransform.h:183
vtkAbstractTransform
superclass for all geometric transformations
Definition: vtkAbstractTransform.h:50
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:317
vtkObject::Modified
virtual void Modified()
Update the modification time for this object.
vtkThinPlateSplineTransform::NumberOfPoints
int NumberOfPoints
Definition: vtkThinPlateSplineTransform.h:185
vtkThinPlateSplineTransform::SetBasisToR2LogR
void SetBasisToR2LogR()
Definition: vtkThinPlateSplineTransform.h:76
vtkThinPlateSplineTransform
a nonlinear warp transformation
Definition: vtkThinPlateSplineTransform.h:50
vtkWarpTransform::ForwardTransformPoint
virtual void ForwardTransformPoint(const float in[3], float out[3])=0
If the InverseFlag is set to 0, then a call to InternalTransformPoint results in a call to ForwardTra...
vtkWarpTransform::ForwardTransformDerivative
virtual void ForwardTransformDerivative(const float in[3], float out[3], float derivative[3][3])=0
Calculate the forward transform as well as the derivative.
vtkThinPlateSplineTransform::SetBasisFunction
void SetBasisFunction(double(*U)(double r))
Set the radial basis function to a custom function.
Definition: vtkThinPlateSplineTransform.h:85
target
boost::graph_traits< vtkGraph * >::vertex_descriptor target(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:965
VTK_RBF_CUSTOM
#define VTK_RBF_CUSTOM
Definition: vtkThinPlateSplineTransform.h:46
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkAbstractTransform::GetMTime
vtkMTimeType GetMTime() override
Override GetMTime necessary because of inverse transforms.
vtkThinPlateSplineTransform::SetBasisToR
void SetBasisToR()
Definition: vtkThinPlateSplineTransform.h:75
vtkThinPlateSplineTransform::SourceLandmarks
vtkPoints * SourceLandmarks
Definition: vtkThinPlateSplineTransform.h:176
vtkThinPlateSplineTransform::Sigma
double Sigma
Definition: vtkThinPlateSplineTransform.h:175
vtkThinPlateSplineTransform::TargetLandmarks
vtkPoints * TargetLandmarks
Definition: vtkThinPlateSplineTransform.h:177
vtkThinPlateSplineTransform::SetBasisDerivative
void SetBasisDerivative(double(*dUdr)(double r, double &dU))
Definition: vtkThinPlateSplineTransform.h:95
vtkThinPlateSplineTransform::MatrixW
double ** MatrixW
Definition: vtkThinPlateSplineTransform.h:186
vtkThinPlateSplineTransform::RegularizeBulkTransform
bool RegularizeBulkTransform
Definition: vtkThinPlateSplineTransform.h:188
vtkWarpTransform.h
vtkWarpTransform::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:959
vtkAbstractTransform::MakeTransform
virtual vtkAbstractTransform * MakeTransform()=0
Make another transform of the same type.
vtkWarpTransform
superclass for nonlinear geometric transformations
Definition: vtkWarpTransform.h:31
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:293
vtkAbstractTransform::InternalDeepCopy
virtual void InternalDeepCopy(vtkAbstractTransform *)
Perform any subclass-specific DeepCopy.
Definition: vtkAbstractTransform.h:322