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 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...
 
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...
 
double * TransformPoint (double x, double y, double z)
 Apply the transformation to a double-precision coordinate. More...
 
double * TransformPoint (const double point[3])
 
float * TransformFloatPoint (float x, float y, float z)
 Apply the transformation to an (x,y,z) coordinate. More...
 
float * TransformFloatPoint (const float point[3])
 
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])
 
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])
 
double * TransformNormalAtPoint (const double point[3], const double normal[3])
 
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])
 
double * TransformVectorAtPoint (const double point[3], const double vector[3])
 
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...
 
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 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...
 
- 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 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
 
 vtkWarpTransform ()
 
 ~vtkWarpTransform () override
 
virtual void ForwardTransformPoint (const float in[3], float out[3])=0
 If the InverseFlag is set to 0, then a call to InternalTransformPoint results in a call to ForwardTransformPoint. More...
 
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
 Calculate the forward transform as well as the derivative. More...
 
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])
 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
 
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 ()
 
- 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
std::atomic< int32_t > 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 31 of file vtkWarpTransform.h.

Member Typedef Documentation

◆ Superclass

Definition at line 34 of file vtkWarpTransform.h.

Constructor & Destructor Documentation

◆ vtkWarpTransform()

vtkWarpTransform::vtkWarpTransform ( )
protected

◆ ~vtkWarpTransform()

vtkWarpTransform::~vtkWarpTransform ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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 vtkThinPlateSplineTransform, vtkBSplineTransform, vtkGridTransform, vtkSphericalTransform, and vtkCylindricalTransform.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkWarpTransform::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkWarpTransform* vtkWarpTransform::NewInstance ( ) const

◆ PrintSelf()

void vtkWarpTransform::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.

Reimplemented in vtkBSplineTransform, and vtkGridTransform.

◆ Inverse()

void vtkWarpTransform::Inverse ( )
overridevirtual

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.

◆ GetInverseFlag()

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.

◆ SetInverseTolerance()

virtual void vtkWarpTransform::SetInverseTolerance ( double  )
virtual

Set the tolerance for inverse transformation.

The default is 0.001.

◆ GetInverseTolerance()

virtual double vtkWarpTransform::GetInverseTolerance ( )
virtual

◆ SetInverseIterations()

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.

◆ GetInverseIterations()

virtual int vtkWarpTransform::GetInverseIterations ( )
virtual

◆ InternalTransformPoint() [1/2]

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

This will calculate the transformation without calling Update.

Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

◆ InternalTransformPoint() [2/2]

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

Implements vtkAbstractTransform.

◆ InternalTransformDerivative() [1/2]

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

This will calculate the transformation, as well as its derivative without calling Update.

Meant for use only within other VTK classes.

Implements vtkAbstractTransform.

◆ InternalTransformDerivative() [2/2]

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

Implements vtkAbstractTransform.

◆ TemplateTransformPoint() [1/4]

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 103 of file vtkWarpTransform.h.

◆ TemplateTransformPoint() [2/4]

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

Definition at line 107 of file vtkWarpTransform.h.

◆ TemplateTransformPoint() [3/4]

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

Definition at line 111 of file vtkWarpTransform.h.

◆ TemplateTransformPoint() [4/4]

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

Definition at line 115 of file vtkWarpTransform.h.

◆ TemplateTransformInverse() [1/4]

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

Definition at line 119 of file vtkWarpTransform.h.

◆ TemplateTransformInverse() [2/4]

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

Definition at line 123 of file vtkWarpTransform.h.

◆ TemplateTransformInverse() [3/4]

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

Definition at line 127 of file vtkWarpTransform.h.

◆ TemplateTransformInverse() [4/4]

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

Definition at line 131 of file vtkWarpTransform.h.

◆ ForwardTransformPoint() [1/2]

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, vtkGridTransform, vtkBSplineTransform, vtkSphericalTransform, and vtkCylindricalTransform.

◆ ForwardTransformPoint() [2/2]

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

◆ ForwardTransformDerivative() [1/2]

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, vtkGridTransform, vtkBSplineTransform, vtkSphericalTransform, and vtkCylindricalTransform.

◆ ForwardTransformDerivative() [2/2]

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

◆ InverseTransformPoint() [1/2]

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 vtkGridTransform, vtkBSplineTransform, vtkSphericalTransform, and vtkCylindricalTransform.

◆ InverseTransformPoint() [2/2]

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

◆ InverseTransformDerivative() [1/2]

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 vtkGridTransform, vtkBSplineTransform, vtkSphericalTransform, and vtkCylindricalTransform.

◆ InverseTransformDerivative() [2/2]

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

Member Data Documentation

◆ InverseFlag

int vtkWarpTransform::InverseFlag
protected

Definition at line 181 of file vtkWarpTransform.h.

◆ InverseIterations

int vtkWarpTransform::InverseIterations
protected

Definition at line 182 of file vtkWarpTransform.h.

◆ InverseTolerance

double vtkWarpTransform::InverseTolerance
protected

Definition at line 183 of file vtkWarpTransform.h.


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