VTK
9.1.0
|
superclass for nonlinear geometric transformations More...
#include <vtkWarpTransform.h>
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. | |
vtkWarpTransform * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | Inverse () override |
Invert the transformation. | |
virtual int | GetInverseFlag () |
Get the inverse flag of the transformation. | |
virtual void | SetInverseTolerance (double) |
Set the tolerance for inverse transformation. | |
virtual double | GetInverseTolerance () |
Set the tolerance for inverse transformation. | |
virtual void | SetInverseIterations (int) |
Set the maximum number of iterations for the inverse transformation. | |
virtual int | GetInverseIterations () |
Set the maximum number of iterations for the inverse transformation. | |
void | InternalTransformPoint (const float in[3], float out[3]) override |
This will calculate the transformation without calling Update. | |
void | InternalTransformPoint (const double in[3], double out[3]) override |
This will calculate the transformation without calling Update. | |
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. | |
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. | |
void | TemplateTransformPoint (const float in[3], float out[3]) |
Do not use these methods. | |
void | TemplateTransformPoint (const double in[3], double out[3]) |
Do not use these methods. | |
void | TemplateTransformPoint (const float in[3], float out[3], float derivative[3][3]) |
Do not use these methods. | |
void | TemplateTransformPoint (const double in[3], double out[3], double derivative[3][3]) |
Do not use these methods. | |
void | TemplateTransformInverse (const float in[3], float out[3]) |
Do not use these methods. | |
void | TemplateTransformInverse (const double in[3], double out[3]) |
Do not use these methods. | |
void | TemplateTransformInverse (const float in[3], float out[3], float derivative[3][3]) |
Do not use these methods. | |
void | TemplateTransformInverse (const double in[3], double out[3], double derivative[3][3]) |
Do not use these methods. | |
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. | |
vtkAbstractTransform * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | TransformPoint (const float in[3], float out[3]) |
Apply the transformation to a coordinate. | |
void | TransformPoint (const double in[3], double out[3]) |
Apply the transformation to a double-precision coordinate. | |
double * | TransformPoint (double x, double y, double z) |
Apply the transformation to a double-precision coordinate. | |
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. | |
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. | |
vtkAbstractTransform * | GetInverse () |
Get the inverse of this transform. | |
void | SetInverse (vtkAbstractTransform *transform) |
Set a transformation that this transform will be the inverse of. | |
virtual void | Inverse ()=0 |
Invert the transformation. | |
void | DeepCopy (vtkAbstractTransform *) |
Copy this transform from another of the same type. | |
void | Update () |
Update the transform to account for any changes which have been made. | |
virtual vtkAbstractTransform * | MakeTransform ()=0 |
Make another transform of the same type. | |
virtual int | CircuitCheck (vtkAbstractTransform *transform) |
Check for self-reference. | |
vtkMTimeType | GetMTime () override |
Override GetMTime necessary because of inverse transforms. | |
void | UnRegister (vtkObjectBase *O) override |
Needs a special UnRegister() implementation to avoid circular references. | |
float * | TransformFloatPoint (float x, float y, float z) |
Apply the transformation to an (x,y,z) coordinate. | |
float * | TransformFloatPoint (const float point[3]) |
Apply the transformation to an (x,y,z) coordinate. | |
double * | TransformDoublePoint (double x, double y, double z) |
Apply the transformation to a double-precision (x,y,z) coordinate. | |
double * | TransformDoublePoint (const double point[3]) |
Apply the transformation to a double-precision (x,y,z) coordinate. | |
void | TransformNormalAtPoint (const float point[3], const float in[3], float out[3]) |
Apply the transformation to a normal at the specified vertex. | |
void | TransformNormalAtPoint (const double point[3], const double in[3], double out[3]) |
Apply the transformation to a normal at the specified vertex. | |
double * | TransformDoubleNormalAtPoint (const double point[3], const double normal[3]) |
Apply the transformation to a double-precision normal at the specified vertex. | |
float * | TransformFloatNormalAtPoint (const float point[3], const float normal[3]) |
Apply the transformation to a single-precision normal at the specified vertex. | |
void | TransformVectorAtPoint (const float point[3], const float in[3], float out[3]) |
Apply the transformation to a vector at the specified vertex. | |
void | TransformVectorAtPoint (const double point[3], const double in[3], double out[3]) |
Apply the transformation to a vector at the specified vertex. | |
double * | TransformDoubleVectorAtPoint (const double point[3], const double vector[3]) |
Apply the transformation to a double-precision vector at the specified vertex. | |
float * | TransformFloatVectorAtPoint (const float point[3], const float vector[3]) |
Apply the transformation to a single-precision vector at the specified vertex. | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
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. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
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. | |
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. | |
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. | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
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). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkWarpTransform * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkAbstractTransform | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkAbstractTransform * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
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. | |
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). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
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. | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () 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. | |
virtual void | ForwardTransformPoint (const double in[3], double out[3])=0 |
If the InverseFlag is set to 0, then a call to InternalTransformPoint results in a call to ForwardTransformPoint. | |
virtual void | ForwardTransformDerivative (const float in[3], float out[3], float derivative[3][3])=0 |
Calculate the forward transform as well as the derivative. | |
virtual void | ForwardTransformDerivative (const double in[3], double out[3], double derivative[3][3])=0 |
Calculate the forward transform as well as the derivative. | |
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. | |
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. | |
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) | |
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) | |
Protected Member Functions inherited from vtkAbstractTransform | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkAbstractTransform () | |
~vtkAbstractTransform () override | |
virtual void | InternalUpdate () |
Perform any subclass-specific Update. | |
virtual void | InternalDeepCopy (vtkAbstractTransform *) |
Perform any subclass-specific DeepCopy. | |
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. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
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 | |
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 () |
superclass for nonlinear geometric transformations
vtkWarpTransform provides a generic interface for nonlinear warp transformations.
Definition at line 31 of file vtkWarpTransform.h.
Definition at line 34 of file vtkWarpTransform.h.
|
protected |
|
overrideprotected |
|
static |
|
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 vtkCylindricalTransform, vtkSphericalTransform, vtkThinPlateSplineTransform, vtkBSplineTransform, and vtkGridTransform.
|
static |
|
protectedvirtual |
Reimplemented from vtkAbstractTransform.
Reimplemented in vtkCylindricalTransform, vtkSphericalTransform, vtkThinPlateSplineTransform, vtkBSplineTransform, and vtkGridTransform.
vtkWarpTransform * vtkWarpTransform::NewInstance | ( | ) | const |
|
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.
|
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.
|
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 |
Set the tolerance for inverse transformation.
The default is 0.001.
|
virtual |
Set the tolerance for inverse transformation.
The default is 0.001.
|
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 |
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.
|
overridevirtual |
This will calculate the transformation without calling Update.
Meant for use only within other VTK classes.
Implements vtkAbstractTransform.
|
overridevirtual |
This will calculate the transformation without calling Update.
Meant for use only within other VTK classes.
Implements vtkAbstractTransform.
|
overridevirtual |
This will calculate the transformation, as well as its derivative without calling Update.
Meant for use only within other VTK classes.
Implements vtkAbstractTransform.
|
overridevirtual |
This will calculate the transformation, as well as its derivative without calling Update.
Meant for use only within other VTK classes.
Implements vtkAbstractTransform.
|
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.
|
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 107 of file vtkWarpTransform.h.
|
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 111 of file vtkWarpTransform.h.
|
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 115 of file vtkWarpTransform.h.
|
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 119 of file vtkWarpTransform.h.
|
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 123 of file vtkWarpTransform.h.
|
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 127 of file vtkWarpTransform.h.
|
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 131 of file vtkWarpTransform.h.
|
protectedpure virtual |
If the InverseFlag is set to 0, then a call to InternalTransformPoint results in a call to ForwardTransformPoint.
Implemented in vtkCylindricalTransform, vtkSphericalTransform, vtkThinPlateSplineTransform, vtkBSplineTransform, and vtkGridTransform.
|
protectedpure virtual |
If the InverseFlag is set to 0, then a call to InternalTransformPoint results in a call to ForwardTransformPoint.
Implemented in vtkCylindricalTransform, vtkSphericalTransform, vtkThinPlateSplineTransform, vtkBSplineTransform, and vtkGridTransform.
|
protectedpure virtual |
Calculate the forward transform as well as the derivative.
Implemented in vtkCylindricalTransform, vtkSphericalTransform, vtkThinPlateSplineTransform, vtkBSplineTransform, and vtkGridTransform.
|
protectedpure virtual |
Calculate the forward transform as well as the derivative.
Implemented in vtkCylindricalTransform, vtkSphericalTransform, vtkThinPlateSplineTransform, vtkBSplineTransform, and vtkGridTransform.
|
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 vtkCylindricalTransform, vtkSphericalTransform, vtkBSplineTransform, and vtkGridTransform.
|
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 vtkCylindricalTransform, vtkSphericalTransform, vtkBSplineTransform, and vtkGridTransform.
|
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 vtkCylindricalTransform, vtkSphericalTransform, vtkBSplineTransform, and vtkGridTransform.
|
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 vtkCylindricalTransform, vtkSphericalTransform, vtkBSplineTransform, and vtkGridTransform.
|
protected |
Definition at line 181 of file vtkWarpTransform.h.
|
protected |
Definition at line 182 of file vtkWarpTransform.h.
|
protected |
Definition at line 183 of file vtkWarpTransform.h.