VTK  9.1.0
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...
 
vtkMTimeType GetMTime () override
 Get the MTime. More...
 
vtkAbstractTransformMakeTransform () override
 Make another transform of the same type. More...
 
virtual double GetSigma ()
 Specify the 'stiffness' of the spline. More...
 
virtual void SetSigma (double)
 Specify the 'stiffness' of the spline. More...
 
void SetBasis (int basis)
 Specify the radial basis function to use. More...
 
virtual int GetBasis ()
 Specify the radial basis function to use. More...
 
void SetBasisToR ()
 Specify the radial basis function to use. More...
 
void SetBasisToR2LogR ()
 Specify the radial basis function to use. More...
 
const char * GetBasisAsString ()
 Specify the radial basis function to use. More...
 
void SetBasisFunction (double(*U)(double r))
 Set the radial basis function to a custom function. More...
 
void SetBasisDerivative (double(*dUdr)(double r, double &dU))
 Set the radial basis function to a custom function. More...
 
void SetSourceLandmarks (vtkPoints *source)
 Set the source landmarks for the warp. More...
 
virtual vtkPointsGetSourceLandmarks ()
 Set the source landmarks for the warp. More...
 
void SetTargetLandmarks (vtkPoints *target)
 Set the target landmarks for the warp. More...
 
virtual vtkPointsGetTargetLandmarks ()
 Set the target landmarks for the warp. More...
 
virtual bool GetRegularizeBulkTransform ()
 Get/set whether the bulk linear transformation matrix is regularized. More...
 
virtual void SetRegularizeBulkTransform (bool)
 Get/set whether the bulk linear transformation matrix is regularized. More...
 
virtual void RegularizeBulkTransformOn ()
 Get/set whether the bulk linear transformation matrix is regularized. More...
 
virtual void RegularizeBulkTransformOff ()
 Get/set whether the bulk linear transformation matrix is regularized. More...
 
- Public Member Functions inherited from vtkWarpTransform
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
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 ()
 Set the tolerance for inverse transformation. More...
 
virtual void SetInverseIterations (int)
 Set the maximum number of iterations for the inverse transformation. More...
 
virtual int GetInverseIterations ()
 Set the maximum number of iterations for the inverse transformation. More...
 
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
 This will calculate the transformation without calling Update. More...
 
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
 This will calculate the transformation, as well as its derivative without calling Update. More...
 
void TemplateTransformPoint (const float in[3], float out[3])
 Do not use these methods. More...
 
void TemplateTransformPoint (const double in[3], double out[3])
 Do not use these methods. More...
 
void TemplateTransformPoint (const float in[3], float out[3], float derivative[3][3])
 Do not use these methods. More...
 
void TemplateTransformPoint (const double in[3], double out[3], double derivative[3][3])
 Do not use these methods. More...
 
void TemplateTransformInverse (const float in[3], float out[3])
 Do not use these methods. More...
 
void TemplateTransformInverse (const double in[3], double out[3])
 Do not use these methods. More...
 
void TemplateTransformInverse (const float in[3], float out[3], float derivative[3][3])
 Do not use these methods. More...
 
void TemplateTransformInverse (const double in[3], double out[3], double derivative[3][3])
 Do not use these methods. More...
 
- Public Member Functions inherited from vtkAbstractTransform
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkAbstractTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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...
 
double * TransformPoint (double x, double y, double z)
 Apply the transformation to a double-precision coordinate. More...
 
double * TransformPoint (const double point[3])
 
double * TransformNormalAtPoint (const double point[3], const double normal[3])
 
double * TransformVectorAtPoint (const double point[3], const double vector[3])
 
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...
 
virtual void Inverse ()=0
 Invert the transformation. 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 vtkAbstractTransformMakeTransform ()=0
 Make another transform of the same type. More...
 
virtual int CircuitCheck (vtkAbstractTransform *transform)
 Check for self-reference. More...
 
vtkMTimeType GetMTime () override
 Override GetMTime necessary because of inverse transforms. More...
 
void UnRegister (vtkObjectBase *O) override
 Needs a special UnRegister() implementation to avoid circular references. More...
 
float * TransformFloatPoint (float x, float y, float z)
 Apply the transformation to an (x,y,z) coordinate. More...
 
float * TransformFloatPoint (const float point[3])
 Apply the transformation to an (x,y,z) coordinate. More...
 
double * TransformDoublePoint (double x, double y, double z)
 Apply the transformation to a double-precision (x,y,z) coordinate. More...
 
double * TransformDoublePoint (const double point[3])
 Apply the transformation to a double-precision (x,y,z) coordinate. More...
 
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])
 Apply the transformation to a normal at the specified vertex. More...
 
double * TransformDoubleNormalAtPoint (const double point[3], const double normal[3])
 Apply the transformation to a double-precision normal at the specified vertex. More...
 
float * TransformFloatNormalAtPoint (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])
 Apply the transformation to a vector at the specified vertex. More...
 
double * TransformDoubleVectorAtPoint (const double point[3], const double vector[3])
 Apply the transformation to a double-precision vector at the specified vertex. More...
 
float * TransformFloatVectorAtPoint (const float point[3], const float vector[3])
 Apply the transformation to a single-precision vector at the specified vertex. 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...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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 Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. 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
 If the InverseFlag is set to 0, then a call to InternalTransformPoint results in a call to ForwardTransformPoint. More...
 
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
 Calculate the forward transform as well as the derivative. More...
 
- Protected Member Functions inherited from vtkWarpTransform
virtual vtkObjectBaseNewInstanceInternal () const
 
 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])
 If the InverseFlag is set to 1, then a call to InternalTransformPoint results in a call to InverseTransformPoint. More...
 
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])
 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...
 
- Protected Member Functions inherited from vtkAbstractTransform
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractTransform ()
 
 ~vtkAbstractTransform () override
 
virtual void InternalUpdate ()
 Perform any subclass-specific Update. More...
 
virtual void InternalDeepCopy (vtkAbstractTransform *)
 Perform any subclass-specific DeepCopy. More...
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
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
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

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
Online Examples:

Definition at line 69 of file vtkThinPlateSplineTransform.h.

Member Typedef Documentation

◆ Superclass

Definition at line 72 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

Specify the 'stiffness' of the spline.

The default is 1.0.

◆ 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

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.

◆ SetBasisToR()

void vtkThinPlateSplineTransform::SetBasisToR ( )
inline

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.

Definition at line 94 of file vtkThinPlateSplineTransform.h.

◆ SetBasisToR2LogR()

void vtkThinPlateSplineTransform::SetBasisToR2LogR ( )
inline

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.

Definition at line 95 of file vtkThinPlateSplineTransform.h.

◆ GetBasisAsString()

const char * vtkThinPlateSplineTransform::GetBasisAsString ( )

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.

◆ 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 104 of file vtkThinPlateSplineTransform.h.

◆ SetBasisDerivative()

void vtkThinPlateSplineTransform::SetBasisDerivative ( double(*)(double r, double &dU)  dUdr)
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 114 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

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.

◆ 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

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.

◆ 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

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.

◆ RegularizeBulkTransformOn()

virtual void vtkThinPlateSplineTransform::RegularizeBulkTransformOn ( )
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.

◆ RegularizeBulkTransformOff()

virtual void vtkThinPlateSplineTransform::RegularizeBulkTransformOff ( )
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.

◆ 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

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

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

Calculate the forward transform as well as the derivative.

Implements vtkWarpTransform.

Member Data Documentation

◆ Sigma

double vtkThinPlateSplineTransform::Sigma
protected

Definition at line 194 of file vtkThinPlateSplineTransform.h.

◆ SourceLandmarks

vtkPoints* vtkThinPlateSplineTransform::SourceLandmarks
protected

Definition at line 195 of file vtkThinPlateSplineTransform.h.

◆ TargetLandmarks

vtkPoints* vtkThinPlateSplineTransform::TargetLandmarks
protected

Definition at line 196 of file vtkThinPlateSplineTransform.h.

◆ BasisFunction

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

Definition at line 199 of file vtkThinPlateSplineTransform.h.

◆ BasisDerivative

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

Definition at line 200 of file vtkThinPlateSplineTransform.h.

◆ Basis

int vtkThinPlateSplineTransform::Basis
protected

Definition at line 202 of file vtkThinPlateSplineTransform.h.

◆ NumberOfPoints

int vtkThinPlateSplineTransform::NumberOfPoints
protected

Definition at line 204 of file vtkThinPlateSplineTransform.h.

◆ MatrixW

double** vtkThinPlateSplineTransform::MatrixW
protected

Definition at line 205 of file vtkThinPlateSplineTransform.h.

◆ RegularizeBulkTransform

bool vtkThinPlateSplineTransform::RegularizeBulkTransform
protected

Definition at line 207 of file vtkThinPlateSplineTransform.h.


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