VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkWarpTransform Class Referenceabstract

superclass for nonlinear geometric transformations More...

#include <vtkWarpTransform.h>

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

Public Types

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)
 
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 vtkAbstractTransformMakeTransform ()=0
 
virtual int CircuitCheck (vtkAbstractTransform *transform)
 
unsigned long GetMTime ()
 
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 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
 
 vtkWarpTransform ()
 
 ~vtkWarpTransform ()
 
virtual void ForwardTransformPoint (const float in[3], float out[3])=0
 
virtual void ForwardTransformPoint (const double in[3], double out[3])=0
 
virtual void ForwardTransformDerivative (const float in[3], float out[3], float derivative[3][3])=0
 
virtual void ForwardTransformDerivative (const double in[3], double out[3], double derivative[3][3])=0
 
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 ()
 
virtual void InternalUpdate ()
 
virtual void InternalDeepCopy (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

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

superclass for nonlinear geometric transformations

vtkWarpTransform provides a generic interface for nonlinear warp transformations.

See also
vtkThinPlateSplineTransform vtkGridTransform vtkGeneralTransform

Definition at line 30 of file vtkWarpTransform.h.

Member Typedef Documentation

Definition at line 34 of file vtkWarpTransform.h.

Constructor & Destructor Documentation

vtkWarpTransform::vtkWarpTransform ( )
protected
vtkWarpTransform::~vtkWarpTransform ( )
protected

Member Function Documentation

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

Reimplemented in vtkBSplineTransform, vtkThinPlateSplineTransform, vtkGridTransform, vtkSphericalTransform, and vtkCylindricalTransform.

static vtkWarpTransform* vtkWarpTransform::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkWarpTransform::NewInstanceInternal ( ) const
protectedvirtual
vtkWarpTransform* vtkWarpTransform::NewInstance ( ) const
void vtkWarpTransform::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.

Reimplemented in vtkBSplineTransform, and vtkGridTransform.

void vtkWarpTransform::Inverse ( )
virtual

Invert the transformation. Warp transformations are usually inverted using an iterative technique such as Newton's method. The inverse transform is usually around five or six times as computationally expensive as the forward transform.

Implements vtkAbstractTransform.

virtual int vtkWarpTransform::GetInverseFlag ( )
virtual

Get the inverse flag of the transformation. This flag is set to zero when the transformation is first created, and is flipped each time Inverse() is called.

virtual void vtkWarpTransform::SetInverseTolerance ( double  )
virtual

Set the tolerance for inverse transformation. The default is 0.001.

virtual double vtkWarpTransform::GetInverseTolerance ( )
virtual

Set the tolerance for inverse transformation. The default is 0.001.

virtual void vtkWarpTransform::SetInverseIterations ( int  )
virtual

Set the maximum number of iterations for the inverse transformation. The default is 500, but usually only 2 to 5 iterations are used. The inversion method is fairly robust, and it should converge for nearly all smooth transformations that do not fold back on themselves.

virtual int vtkWarpTransform::GetInverseIterations ( )
virtual

Set the maximum number of iterations for the inverse transformation. The default is 500, but usually only 2 to 5 iterations are used. The inversion method is fairly robust, and it should converge for nearly all smooth transformations that do not fold back on themselves.

void vtkWarpTransform::InternalTransformPoint ( const float  in[3],
float  out[3] 
)
virtual

This will calculate the transformation without calling Update. Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

void vtkWarpTransform::InternalTransformPoint ( const double  in[3],
double  out[3] 
)
virtual

This will calculate the transformation without calling Update. Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

void vtkWarpTransform::InternalTransformDerivative ( const float  in[3],
float  out[3],
float  derivative[3][3] 
)
virtual

This will calculate the transformation, as well as its derivative without calling Update. Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

void vtkWarpTransform::InternalTransformDerivative ( const double  in[3],
double  out[3],
double  derivative[3][3] 
)
virtual

This will calculate the transformation, as well as its derivative without calling Update. Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

void vtkWarpTransform::TemplateTransformPoint ( const float  in[3],
float  out[3] 
)
inline

Do not use these methods. They exists only as a work-around for internal templated functions (I really didn't want to make the Forward/Inverse methods public, is there a decent work around for this sort of thing?)

Definition at line 86 of file vtkWarpTransform.h.

void vtkWarpTransform::TemplateTransformPoint ( const double  in[3],
double  out[3] 
)
inline

Do not use these methods. They exists only as a work-around for internal templated functions (I really didn't want to make the Forward/Inverse methods public, is there a decent work around for this sort of thing?)

Definition at line 88 of file vtkWarpTransform.h.

void vtkWarpTransform::TemplateTransformPoint ( const float  in[3],
float  out[3],
float  derivative[3][3] 
)
inline

Do not use these methods. They exists only as a work-around for internal templated functions (I really didn't want to make the Forward/Inverse methods public, is there a decent work around for this sort of thing?)

Definition at line 90 of file vtkWarpTransform.h.

void vtkWarpTransform::TemplateTransformPoint ( const double  in[3],
double  out[3],
double  derivative[3][3] 
)
inline

Do not use these methods. They exists only as a work-around for internal templated functions (I really didn't want to make the Forward/Inverse methods public, is there a decent work around for this sort of thing?)

Definition at line 93 of file vtkWarpTransform.h.

void vtkWarpTransform::TemplateTransformInverse ( const float  in[3],
float  out[3] 
)
inline

Do not use these methods. They exists only as a work-around for internal templated functions (I really didn't want to make the Forward/Inverse methods public, is there a decent work around for this sort of thing?)

Definition at line 96 of file vtkWarpTransform.h.

void vtkWarpTransform::TemplateTransformInverse ( const double  in[3],
double  out[3] 
)
inline

Do not use these methods. They exists only as a work-around for internal templated functions (I really didn't want to make the Forward/Inverse methods public, is there a decent work around for this sort of thing?)

Definition at line 98 of file vtkWarpTransform.h.

void vtkWarpTransform::TemplateTransformInverse ( const float  in[3],
float  out[3],
float  derivative[3][3] 
)
inline

Do not use these methods. They exists only as a work-around for internal templated functions (I really didn't want to make the Forward/Inverse methods public, is there a decent work around for this sort of thing?)

Definition at line 100 of file vtkWarpTransform.h.

void vtkWarpTransform::TemplateTransformInverse ( const double  in[3],
double  out[3],
double  derivative[3][3] 
)
inline

Do not use these methods. They exists only as a work-around for internal templated functions (I really didn't want to make the Forward/Inverse methods public, is there a decent work around for this sort of thing?)

Definition at line 103 of file vtkWarpTransform.h.

virtual void vtkWarpTransform::ForwardTransformPoint ( const float  in[3],
float  out[3] 
)
protectedpure virtual

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

Implemented in vtkThinPlateSplineTransform, vtkBSplineTransform, vtkGridTransform, vtkSphericalTransform, and vtkCylindricalTransform.

virtual void vtkWarpTransform::ForwardTransformPoint ( const double  in[3],
double  out[3] 
)
protectedpure virtual

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

Implemented in vtkThinPlateSplineTransform, vtkBSplineTransform, vtkGridTransform, vtkSphericalTransform, and vtkCylindricalTransform.

virtual void vtkWarpTransform::ForwardTransformDerivative ( const float  in[3],
float  out[3],
float  derivative[3][3] 
)
protectedpure virtual

Calculate the forward transform as well as the derivative.

Implemented in vtkThinPlateSplineTransform, vtkBSplineTransform, vtkGridTransform, vtkSphericalTransform, and vtkCylindricalTransform.

virtual void vtkWarpTransform::ForwardTransformDerivative ( const double  in[3],
double  out[3],
double  derivative[3][3] 
)
protectedpure virtual

Calculate the forward transform as well as the derivative.

Implemented in vtkThinPlateSplineTransform, vtkBSplineTransform, vtkGridTransform, vtkSphericalTransform, and vtkCylindricalTransform.

virtual void vtkWarpTransform::InverseTransformPoint ( const float  in[3],
float  out[3] 
)
protectedvirtual

If the InverseFlag is set to 1, then a call to InternalTransformPoint results in a call to InverseTransformPoint. The inverse transformation is calculated from using Newton's method.

Reimplemented in vtkBSplineTransform, vtkGridTransform, vtkSphericalTransform, and vtkCylindricalTransform.

virtual void vtkWarpTransform::InverseTransformPoint ( const double  in[3],
double  out[3] 
)
protectedvirtual

If the InverseFlag is set to 1, then a call to InternalTransformPoint results in a call to InverseTransformPoint. The inverse transformation is calculated from using Newton's method.

Reimplemented in vtkBSplineTransform, vtkGridTransform, vtkSphericalTransform, and vtkCylindricalTransform.

virtual void vtkWarpTransform::InverseTransformDerivative ( const float  in[3],
float  out[3],
float  derivative[3][3] 
)
protectedvirtual

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)

Reimplemented in vtkBSplineTransform, vtkGridTransform, vtkSphericalTransform, and vtkCylindricalTransform.

virtual void vtkWarpTransform::InverseTransformDerivative ( const double  in[3],
double  out[3],
double  derivative[3][3] 
)
protectedvirtual

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)

Reimplemented in vtkBSplineTransform, vtkGridTransform, vtkSphericalTransform, and vtkCylindricalTransform.

Member Data Documentation

int vtkWarpTransform::InverseFlag
protected

Definition at line 145 of file vtkWarpTransform.h.

int vtkWarpTransform::InverseIterations
protected

Definition at line 146 of file vtkWarpTransform.h.

double vtkWarpTransform::InverseTolerance
protected

Definition at line 147 of file vtkWarpTransform.h.


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