VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkThinPlateSplineTransform Class Reference

a nonlinear warp transformation More...

#include <vtkThinPlateSplineTransform.h>

Inheritance diagram for vtkThinPlateSplineTransform:
[legend]
Collaboration diagram for vtkThinPlateSplineTransform:
[legend]

Public Types

typedef vtkWarpTransform Superclass
 
- Public Types inherited from vtkWarpTransform
typedef vtkAbstractTransform Superclass
 
- Public Types inherited from vtkAbstractTransform
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkThinPlateSplineTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual double GetSigma ()
 Specify the 'stiffness' of the spline. More...
 
virtual void SetSigma (double)
 
void SetBasis (int basis)
 Specify the radial basis function to use. More...
 
virtual int GetBasis ()
 
void SetBasisToR ()
 
void SetBasisToR2LogR ()
 
const char * GetBasisAsString ()
 
void SetBasisFunction (double(*U)(double r))
 Set the radial basis function to a custom function. More...
 
void SetBasisDerivative (double(*dUdr)(double r, double &dU))
 
void SetSourceLandmarks (vtkPoints *source)
 Set the source landmarks for the warp. More...
 
virtual vtkPointsGetSourceLandmarks ()
 
void SetTargetLandmarks (vtkPoints *target)
 Set the target landmarks for the warp. More...
 
virtual vtkPointsGetTargetLandmarks ()
 
vtkMTimeType GetMTime () override
 Get the MTime. More...
 
vtkAbstractTransformMakeTransform () override
 Make another transform of the same type. More...
 
virtual bool GetRegularizeBulkTransform ()
 Get/set whether the bulk linear transformation matrix is regularized. More...
 
virtual void SetRegularizeBulkTransform (bool)
 
virtual void RegularizeBulkTransformOn ()
 
virtual void RegularizeBulkTransformOff ()
 
- Public Member Functions inherited from vtkWarpTransform
vtkWarpTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Inverse () override
 Invert the transformation. More...
 
virtual int GetInverseFlag ()
 Get the inverse flag of the transformation. More...
 
virtual void SetInverseTolerance (double)
 Set the tolerance for inverse transformation. More...
 
virtual double GetInverseTolerance ()
 
virtual void SetInverseIterations (int)
 Set the maximum number of iterations for the inverse transformation. More...
 
virtual int GetInverseIterations ()
 
void InternalTransformPoint (const float in[3], float out[3]) override
 This will calculate the transformation without calling Update. More...
 
void InternalTransformPoint (const double in[3], double out[3]) override
 
void InternalTransformDerivative (const float in[3], float out[3], float derivative[3][3]) override
 This will calculate the transformation, as well as its derivative without calling Update. More...
 
void InternalTransformDerivative (const double in[3], double out[3], double derivative[3][3]) override
 
void TemplateTransformPoint (const float in[3], float out[3])
 Do not use these methods. More...
 
void TemplateTransformPoint (const double in[3], double out[3])
 
void TemplateTransformPoint (const float in[3], float out[3], float derivative[3][3])
 
void TemplateTransformPoint (const double in[3], double out[3], double derivative[3][3])
 
void TemplateTransformInverse (const float in[3], float out[3])
 
void TemplateTransformInverse (const double in[3], double out[3])
 
void TemplateTransformInverse (const float in[3], float out[3], float derivative[3][3])
 
void TemplateTransformInverse (const double in[3], double out[3], double derivative[3][3])
 
- Public Member Functions inherited from vtkAbstractTransform
vtkAbstractTransformNewInstance () const
 
void TransformPoint (const float in[3], float out[3])
 Apply the transformation to a coordinate. More...
 
void TransformPoint (const double in[3], double out[3])
 Apply the transformation to a double-precision coordinate. More...
 
doubleTransformPoint (double x, double y, double z)
 Apply the transformation to a double-precision coordinate. More...
 
doubleTransformPoint (const double point[3])
 
floatTransformFloatPoint (float x, float y, float z)
 Apply the transformation to an (x,y,z) coordinate. More...
 
floatTransformFloatPoint (const float point[3])
 
doubleTransformDoublePoint (double x, double y, double z)
 Apply the transformation to a double-precision (x,y,z) coordinate. More...
 
doubleTransformDoublePoint (const double point[3])
 
void TransformNormalAtPoint (const float point[3], const float in[3], float out[3])
 Apply the transformation to a normal at the specified vertex. More...
 
void TransformNormalAtPoint (const double point[3], const double in[3], double out[3])
 
doubleTransformNormalAtPoint (const double point[3], const double normal[3])
 
doubleTransformDoubleNormalAtPoint (const double point[3], const double normal[3])
 Apply the transformation to a double-precision normal at the specified vertex. More...
 
floatTransformFloatNormalAtPoint (const float point[3], const float normal[3])
 Apply the transformation to a single-precision normal at the specified vertex. More...
 
void TransformVectorAtPoint (const float point[3], const float in[3], float out[3])
 Apply the transformation to a vector at the specified vertex. More...
 
void TransformVectorAtPoint (const double point[3], const double in[3], double out[3])
 
doubleTransformVectorAtPoint (const double point[3], const double vector[3])
 
doubleTransformDoubleVectorAtPoint (const double point[3], const double vector[3])
 Apply the transformation to a double-precision vector at the specified vertex. More...
 
floatTransformFloatVectorAtPoint (const float point[3], const float vector[3])
 Apply the transformation to a single-precision vector at the specified vertex. More...
 
virtual void TransformPoints (vtkPoints *inPts, vtkPoints *outPts)
 Apply the transformation to a series of points, and append the results to outPts. More...
 
virtual void TransformPointsNormalsVectors (vtkPoints *inPts, vtkPoints *outPts, vtkDataArray *inNms, vtkDataArray *outNms, vtkDataArray *inVrs, vtkDataArray *outVrs, int nOptionalVectors=0, vtkDataArray **inVrsArr=nullptr, vtkDataArray **outVrsArr=nullptr)
 Apply the transformation to a combination of points, normals and vectors. More...
 
vtkAbstractTransformGetInverse ()
 Get the inverse of this transform. More...
 
void SetInverse (vtkAbstractTransform *transform)
 Set a transformation that this transform will be the inverse of. More...
 
void DeepCopy (vtkAbstractTransform *)
 Copy this transform from another of the same type. More...
 
void Update ()
 Update the transform to account for any changes which have been made. More...
 
virtual int CircuitCheck (vtkAbstractTransform *transform)
 Check for self-reference. More...
 
void UnRegister (vtkObjectBase *O) override
 Needs a special UnRegister() implementation to avoid circular references. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkThinPlateSplineTransformSafeDownCast (vtkObjectBase *o)
 
static vtkThinPlateSplineTransformNew ()
 
- Static Public Member Functions inherited from vtkWarpTransform
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWarpTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractTransform
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkThinPlateSplineTransform ()
 
 ~vtkThinPlateSplineTransform () override
 
void InternalUpdate () override
 Prepare the transformation for application. More...
 
void InternalDeepCopy (vtkAbstractTransform *transform) override
 This method does no type checking, use DeepCopy instead. More...
 
void ForwardTransformPoint (const float in[3], float out[3]) override
 If the InverseFlag is set to 0, then a call to InternalTransformPoint results in a call to ForwardTransformPoint. More...
 
void ForwardTransformPoint (const double in[3], double out[3]) override
 
void ForwardTransformDerivative (const float in[3], float out[3], float derivative[3][3]) override
 Calculate the forward transform as well as the derivative. More...
 
void ForwardTransformDerivative (const double in[3], double out[3], double derivative[3][3]) override
 
- Protected Member Functions inherited from vtkWarpTransform
 vtkWarpTransform ()
 
 ~vtkWarpTransform () override
 
virtual void InverseTransformPoint (const float in[3], float out[3])
 If the InverseFlag is set to 1, then a call to InternalTransformPoint results in a call to InverseTransformPoint. More...
 
virtual void InverseTransformPoint (const double in[3], double out[3])
 
virtual void InverseTransformDerivative (const float in[3], float out[3], float derivative[3][3])
 Calculate the inverse transform as well as the derivative of the forward transform (that's correct: the derivative of the forward transform, not of the inverse transform) More...
 
virtual void InverseTransformDerivative (const double in[3], double out[3], double derivative[3][3])
 
- Protected Member Functions inherited from vtkAbstractTransform
 vtkAbstractTransform ()
 
 ~vtkAbstractTransform () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double Sigma
 
vtkPointsSourceLandmarks
 
vtkPointsTargetLandmarks
 
double(* BasisFunction )(double r)
 
double(* BasisDerivative )(double r, double &dUdr)
 
int Basis
 
int NumberOfPoints
 
double ** MatrixW
 
bool RegularizeBulkTransform
 
- Protected Attributes inherited from vtkWarpTransform
int InverseFlag
 
int InverseIterations
 
double InverseTolerance
 
- Protected Attributes inherited from vtkAbstractTransform
float InternalFloatPoint [3]
 
double InternalDoublePoint [3]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

a nonlinear warp transformation

vtkThinPlateSplineTransform describes a nonlinear warp transform defined by a set of source and target landmarks. Any point on the mesh close to a source landmark will be moved to a place close to the corresponding target landmark. The points in between are interpolated smoothly using Bookstein's Thin Plate Spline algorithm.

To obtain a correct TPS warp, use the R2LogR kernel if your data is 2D, and the R kernel if your data is 3D. Or you can specify your own RBF. (Hence this class is more general than a pure TPS transform.)

Warning
1) The inverse transform is calculated using an iterative method, and is several times more expensive than the forward transform. 2) Whenever you add, subtract, or set points you must call Modified() on the vtkPoints object, or the transformation might not update. 3) Collinear point configurations (except those that lie in the XY plane) result in an unstable transformation. Forward transform can be computed for any configuration by disabling bulk transform regularization.
See also
vtkGridTransform vtkGeneralTransform
Tests:
vtkThinPlateSplineTransform (Tests)

Definition at line 53 of file vtkThinPlateSplineTransform.h.

Member Typedef Documentation

◆ Superclass

Definition at line 56 of file vtkThinPlateSplineTransform.h.

Constructor & Destructor Documentation

◆ vtkThinPlateSplineTransform()

vtkThinPlateSplineTransform::vtkThinPlateSplineTransform ( )
protected

◆ ~vtkThinPlateSplineTransform()

vtkThinPlateSplineTransform::~vtkThinPlateSplineTransform ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkThinPlateSplineTransform::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkThinPlateSplineTransform::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkWarpTransform.

◆ SafeDownCast()

static vtkThinPlateSplineTransform* vtkThinPlateSplineTransform::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkThinPlateSplineTransform::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkWarpTransform.

◆ NewInstance()

vtkThinPlateSplineTransform* vtkThinPlateSplineTransform::NewInstance ( ) const

◆ PrintSelf()

void vtkThinPlateSplineTransform::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkAbstractTransform.

◆ New()

static vtkThinPlateSplineTransform* vtkThinPlateSplineTransform::New ( )
static

◆ GetSigma()

virtual double vtkThinPlateSplineTransform::GetSigma ( )
virtual

Specify the 'stiffness' of the spline.

The default is 1.0.

◆ SetSigma()

virtual void vtkThinPlateSplineTransform::SetSigma ( double  )
virtual

◆ SetBasis()

void vtkThinPlateSplineTransform::SetBasis ( int  basis)

Specify the radial basis function to use.

The default is R2LogR which is appropriate for 2D. Use |R| (SetBasisToR) if your data is 3D. Alternatively specify your own basis function, however this will mean that the transform will no longer be a true thin-plate spline.

◆ GetBasis()

virtual int vtkThinPlateSplineTransform::GetBasis ( )
virtual

◆ SetBasisToR()

void vtkThinPlateSplineTransform::SetBasisToR ( )
inline

Definition at line 78 of file vtkThinPlateSplineTransform.h.

◆ SetBasisToR2LogR()

void vtkThinPlateSplineTransform::SetBasisToR2LogR ( )
inline

Definition at line 79 of file vtkThinPlateSplineTransform.h.

◆ GetBasisAsString()

const char* vtkThinPlateSplineTransform::GetBasisAsString ( )

◆ SetBasisFunction()

void vtkThinPlateSplineTransform::SetBasisFunction ( double(*)(double r)  U)
inline

Set the radial basis function to a custom function.

You must supply both the function and its derivative with respect to r.

Definition at line 88 of file vtkThinPlateSplineTransform.h.

◆ SetBasisDerivative()

void vtkThinPlateSplineTransform::SetBasisDerivative ( double(*)(double r, double &dU)  dUdr)
inline

Definition at line 93 of file vtkThinPlateSplineTransform.h.

◆ SetSourceLandmarks()

void vtkThinPlateSplineTransform::SetSourceLandmarks ( vtkPoints source)

Set the source landmarks for the warp.

If you add or change the vtkPoints object, you must call Modified() on it or the transformation might not update.

◆ GetSourceLandmarks()

virtual vtkPoints* vtkThinPlateSplineTransform::GetSourceLandmarks ( )
virtual

◆ SetTargetLandmarks()

void vtkThinPlateSplineTransform::SetTargetLandmarks ( vtkPoints target)

Set the target landmarks for the warp.

If you add or change the vtkPoints object, you must call Modified() on it or the transformation might not update.

◆ GetTargetLandmarks()

virtual vtkPoints* vtkThinPlateSplineTransform::GetTargetLandmarks ( )
virtual

◆ GetMTime()

vtkMTimeType vtkThinPlateSplineTransform::GetMTime ( )
overridevirtual

Get the MTime.

Reimplemented from vtkAbstractTransform.

◆ MakeTransform()

vtkAbstractTransform* vtkThinPlateSplineTransform::MakeTransform ( )
overridevirtual

Make another transform of the same type.

Implements vtkAbstractTransform.

◆ GetRegularizeBulkTransform()

virtual bool vtkThinPlateSplineTransform::GetRegularizeBulkTransform ( )
virtual

Get/set whether the bulk linear transformation matrix is regularized.

If regularization is enabled: If all landmark points are on the XY plane then forward and inverse transforms are computed correctly. For other coplanar configurations, both forward an inverse transform computation is unstable.

If regularization is disabled: Forward transform is computed correctly for all point configurations. Inverse transform computation is unstable if source and/or target points are coplanar.

If landmarks points are not coplanar then this setting has no effect.

The default is true.

◆ SetRegularizeBulkTransform()

virtual void vtkThinPlateSplineTransform::SetRegularizeBulkTransform ( bool  )
virtual

◆ RegularizeBulkTransformOn()

virtual void vtkThinPlateSplineTransform::RegularizeBulkTransformOn ( )
virtual

◆ RegularizeBulkTransformOff()

virtual void vtkThinPlateSplineTransform::RegularizeBulkTransformOff ( )
virtual

◆ InternalUpdate()

void vtkThinPlateSplineTransform::InternalUpdate ( )
overrideprotectedvirtual

Prepare the transformation for application.

Reimplemented from vtkAbstractTransform.

◆ InternalDeepCopy()

void vtkThinPlateSplineTransform::InternalDeepCopy ( vtkAbstractTransform transform)
overrideprotectedvirtual

This method does no type checking, use DeepCopy instead.

Reimplemented from vtkAbstractTransform.

◆ ForwardTransformPoint() [1/2]

void vtkThinPlateSplineTransform::ForwardTransformPoint ( const float  in[3],
float  out[3] 
)
overrideprotectedvirtual

If the InverseFlag is set to 0, then a call to InternalTransformPoint results in a call to ForwardTransformPoint.

Implements vtkWarpTransform.

◆ ForwardTransformPoint() [2/2]

void vtkThinPlateSplineTransform::ForwardTransformPoint ( const double  in[3],
double  out[3] 
)
overrideprotectedvirtual

Implements vtkWarpTransform.

◆ ForwardTransformDerivative() [1/2]

void vtkThinPlateSplineTransform::ForwardTransformDerivative ( const float  in[3],
float  out[3],
float  derivative[3][3] 
)
overrideprotectedvirtual

Calculate the forward transform as well as the derivative.

Implements vtkWarpTransform.

◆ ForwardTransformDerivative() [2/2]

void vtkThinPlateSplineTransform::ForwardTransformDerivative ( const double  in[3],
double  out[3],
double  derivative[3][3] 
)
overrideprotectedvirtual

Implements vtkWarpTransform.

Member Data Documentation

◆ Sigma

double vtkThinPlateSplineTransform::Sigma
protected

Definition at line 172 of file vtkThinPlateSplineTransform.h.

◆ SourceLandmarks

vtkPoints* vtkThinPlateSplineTransform::SourceLandmarks
protected

Definition at line 173 of file vtkThinPlateSplineTransform.h.

◆ TargetLandmarks

vtkPoints* vtkThinPlateSplineTransform::TargetLandmarks
protected

Definition at line 174 of file vtkThinPlateSplineTransform.h.

◆ BasisFunction

double(* vtkThinPlateSplineTransform::BasisFunction) (double r)
protected

Definition at line 177 of file vtkThinPlateSplineTransform.h.

◆ BasisDerivative

double(* vtkThinPlateSplineTransform::BasisDerivative) (double r, double &dUdr)
protected

Definition at line 178 of file vtkThinPlateSplineTransform.h.

◆ Basis

int vtkThinPlateSplineTransform::Basis
protected

Definition at line 180 of file vtkThinPlateSplineTransform.h.

◆ NumberOfPoints

int vtkThinPlateSplineTransform::NumberOfPoints
protected

Definition at line 182 of file vtkThinPlateSplineTransform.h.

◆ MatrixW

double** vtkThinPlateSplineTransform::MatrixW
protected

Definition at line 183 of file vtkThinPlateSplineTransform.h.

◆ RegularizeBulkTransform

bool vtkThinPlateSplineTransform::RegularizeBulkTransform
protected

Definition at line 185 of file vtkThinPlateSplineTransform.h.


The documentation for this class was generated from the following file: