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 Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkThinPlateSplineTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
unsigned long GetMTime ()
 
vtkAbstractTransformMakeTransform ()
 
virtual double GetSigma ()
 
virtual void SetSigma (double)
 
void SetBasis (int basis)
 
virtual int GetBasis ()
 
void SetBasisToR ()
 
void SetBasisToR2LogR ()
 
const char * GetBasisAsString ()
 
void SetBasisFunction (double(*U)(double r))
 
void SetBasisDerivative (double(*dUdr)(double r, double &dU))
 
void SetSourceLandmarks (vtkPoints *source)
 
virtual vtkPointsGetSourceLandmarks ()
 
void SetTargetLandmarks (vtkPoints *target)
 
virtual vtkPointsGetTargetLandmarks ()
 
- Public Member Functions inherited from vtkWarpTransform
vtkWarpTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void Inverse ()
 
virtual int GetInverseFlag ()
 
virtual void SetInverseTolerance (double)
 
virtual double GetInverseTolerance ()
 
virtual void SetInverseIterations (int)
 
virtual int GetInverseIterations ()
 
void InternalTransformPoint (const float in[3], float out[3])
 
void InternalTransformPoint (const double in[3], double out[3])
 
void InternalTransformDerivative (const float in[3], float out[3], float derivative[3][3])
 
void InternalTransformDerivative (const double in[3], double out[3], double derivative[3][3])
 
void TemplateTransformPoint (const float in[3], float out[3])
 
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
 
doubleTransformNormalAtPoint (const double point[3], const double normal[3])
 
doubleTransformVectorAtPoint (const double point[3], const double vector[3])
 
virtual void TransformPoints (vtkPoints *inPts, vtkPoints *outPts)
 
vtkAbstractTransformGetInverse ()
 
void SetInverse (vtkAbstractTransform *transform)
 
void DeepCopy (vtkAbstractTransform *)
 
void Update ()
 
virtual int CircuitCheck (vtkAbstractTransform *transform)
 
virtual void UnRegister (vtkObjectBase *O)
 
void TransformPoint (const float in[3], float out[3])
 
void TransformPoint (const double in[3], double out[3])
 
doubleTransformPoint (double x, double y, double z)
 
doubleTransformPoint (const double point[3])
 
floatTransformFloatPoint (float x, float y, float z)
 
floatTransformFloatPoint (const float point[3])
 
doubleTransformDoublePoint (double x, double y, double z)
 
doubleTransformDoublePoint (const double point[3])
 
void TransformNormalAtPoint (const float point[3], const float in[3], float out[3])
 
void TransformNormalAtPoint (const double point[3], const double in[3], double out[3])
 
doubleTransformDoubleNormalAtPoint (const double point[3], const double normal[3])
 
floatTransformFloatNormalAtPoint (const float point[3], const float normal[3])
 
void TransformVectorAtPoint (const float point[3], const float in[3], float out[3])
 
void TransformVectorAtPoint (const double point[3], const double in[3], double out[3])
 
doubleTransformDoubleVectorAtPoint (const double point[3], const double vector[3])
 
floatTransformFloatVectorAtPoint (const float point[3], const float vector[3])
 
virtual void TransformPointsNormalsVectors (vtkPoints *inPts, vtkPoints *outPts, vtkDataArray *inNms, vtkDataArray *outNms, vtkDataArray *inVrs, vtkDataArray *outVrs)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
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)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkThinPlateSplineTransformSafeDownCast (vtkObjectBase *o)
 
static vtkThinPlateSplineTransformNew ()
 
- Static Public Member Functions inherited from vtkWarpTransform
static int IsTypeOf (const char *type)
 
static vtkWarpTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractTransform
static int IsTypeOf (const char *type)
 
static vtkAbstractTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkThinPlateSplineTransform ()
 
 ~vtkThinPlateSplineTransform ()
 
void InternalUpdate ()
 
void InternalDeepCopy (vtkAbstractTransform *transform)
 
void ForwardTransformPoint (const float in[3], float out[3])
 
void ForwardTransformPoint (const double in[3], double out[3])
 
void ForwardTransformDerivative (const float in[3], float out[3], float derivative[3][3])
 
void ForwardTransformDerivative (const double in[3], double out[3], double derivative[3][3])
 
- Protected Member Functions inherited from vtkWarpTransform
 vtkWarpTransform ()
 
 ~vtkWarpTransform ()
 
virtual void InverseTransformPoint (const float in[3], float out[3])
 
virtual void InverseTransformPoint (const double in[3], double out[3])
 
virtual void InverseTransformDerivative (const float in[3], float out[3], float derivative[3][3])
 
virtual void InverseTransformDerivative (const double in[3], double out[3], double derivative[3][3])
 
- Protected Member Functions inherited from vtkAbstractTransform
 vtkAbstractTransform ()
 
 ~vtkAbstractTransform ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
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
 
- 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
vtkAtomicInt32 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.
See also
vtkGridTransform vtkGeneralTransform
Tests:
vtkThinPlateSplineTransform (Tests)

Definition at line 51 of file vtkThinPlateSplineTransform.h.

Member Typedef Documentation

Definition at line 54 of file vtkThinPlateSplineTransform.h.

Constructor & Destructor Documentation

vtkThinPlateSplineTransform::vtkThinPlateSplineTransform ( )
protected
vtkThinPlateSplineTransform::~vtkThinPlateSplineTransform ( )
protected

Member Function Documentation

static int vtkThinPlateSplineTransform::IsTypeOf ( const char *  type)
static
virtual int 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.

static vtkThinPlateSplineTransform* vtkThinPlateSplineTransform::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkThinPlateSplineTransform::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkWarpTransform.

vtkThinPlateSplineTransform* vtkThinPlateSplineTransform::NewInstance ( ) const
void vtkThinPlateSplineTransform::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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.

static vtkThinPlateSplineTransform* vtkThinPlateSplineTransform::New ( )
static
virtual double vtkThinPlateSplineTransform::GetSigma ( )
virtual

Specify the 'stiffness' of the spline. The default is 1.0.

virtual void vtkThinPlateSplineTransform::SetSigma ( double  )
virtual

Specify the 'stiffness' of the spline. The default is 1.0.

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.

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.

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

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

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.

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

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

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.

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.

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.

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.

unsigned long vtkThinPlateSplineTransform::GetMTime ( )
virtual

Get the MTime.

Reimplemented from vtkAbstractTransform.

vtkAbstractTransform* vtkThinPlateSplineTransform::MakeTransform ( )
virtual

Make another transform of the same type.

Implements vtkAbstractTransform.

void vtkThinPlateSplineTransform::InternalUpdate ( )
protectedvirtual

Prepare the transformation for application.

Reimplemented from vtkAbstractTransform.

void vtkThinPlateSplineTransform::InternalDeepCopy ( vtkAbstractTransform transform)
protectedvirtual

This method does no type checking, use DeepCopy instead.

Reimplemented from vtkAbstractTransform.

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

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

Implements vtkWarpTransform.

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

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

Implements vtkWarpTransform.

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

Calculate the forward transform as well as the derivative.

Implements vtkWarpTransform.

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

Calculate the forward transform as well as the derivative.

Implements vtkWarpTransform.

Member Data Documentation

double vtkThinPlateSplineTransform::Sigma
protected

Definition at line 131 of file vtkThinPlateSplineTransform.h.

vtkPoints* vtkThinPlateSplineTransform::SourceLandmarks
protected

Definition at line 132 of file vtkThinPlateSplineTransform.h.

vtkPoints* vtkThinPlateSplineTransform::TargetLandmarks
protected

Definition at line 133 of file vtkThinPlateSplineTransform.h.

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

Definition at line 137 of file vtkThinPlateSplineTransform.h.

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

Definition at line 138 of file vtkThinPlateSplineTransform.h.

int vtkThinPlateSplineTransform::Basis
protected

Definition at line 140 of file vtkThinPlateSplineTransform.h.

int vtkThinPlateSplineTransform::NumberOfPoints
protected

Definition at line 142 of file vtkThinPlateSplineTransform.h.

double** vtkThinPlateSplineTransform::MatrixW
protected

Definition at line 143 of file vtkThinPlateSplineTransform.h.


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