VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkGridTransform Class Reference

a nonlinear warp transformation More...

#include <vtkGridTransform.h>

Inheritance diagram for vtkGridTransform:
[legend]
Collaboration diagram for vtkGridTransform:
[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)
 
vtkGridTransformNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
vtkAbstractTransformMakeTransform ()
 
unsigned long GetMTime ()
 
virtual void SetDisplacementGridConnection (vtkAlgorithmOutput *)
 
virtual void SetDisplacementGridData (vtkImageData *)
 
virtual vtkImageDataGetDisplacementGrid ()
 
virtual void SetDisplacementScale (double)
 
virtual double GetDisplacementScale ()
 
virtual void SetDisplacementShift (double)
 
virtual double GetDisplacementShift ()
 
void SetInterpolationMode (int mode)
 
virtual int GetInterpolationMode ()
 
void SetInterpolationModeToNearestNeighbor ()
 
void SetInterpolationModeToLinear ()
 
void SetInterpolationModeToCubic ()
 
const char * GetInterpolationModeAsString ()
 
- Public Member Functions inherited from vtkWarpTransform
vtkWarpTransformNewInstance () const
 
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 vtkGridTransformNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGridTransformSafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkGridTransform ()
 
 ~vtkGridTransform ()
 
void InternalUpdate ()
 
void InternalDeepCopy (vtkAbstractTransform *transform)
 
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])
 
void InverseTransformPoint (const float in[3], float out[3])
 
void InverseTransformPoint (const double in[3], double out[3])
 
void InverseTransformDerivative (const float in[3], float out[3], float derivative[3][3])
 
void InverseTransformDerivative (const double in[3], double out[3], double derivative[3][3])
 
void ForwardTransformPoint (const float in[3], float out[3])
 
void ForwardTransformPoint (const double in[3], double out[3])
 
- Protected Member Functions inherited from vtkWarpTransform
 vtkWarpTransform ()
 
 ~vtkWarpTransform ()
 
- 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

void(* InterpolationFunction )(double point[3], double displacement[3], double derivatives[3][3], void *gridPtr, int gridType, int inExt[6], vtkIdType inInc[3])
 
int InterpolationMode
 
double DisplacementScale
 
double DisplacementShift
 
void * GridPointer
 
int GridScalarType
 
double GridSpacing [3]
 
double GridOrigin [3]
 
int GridExtent [6]
 
vtkIdType GridIncrements [3]
 
- 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

vtkGridTransform describes a nonlinear warp transformation as a set of displacement vectors sampled along a uniform 3D grid.

Warning
The inverse grid transform is calculated using an iterative method, and is several times more expensive than the forward transform.
See also
vtkThinPlateSplineTransform vtkGeneralTransform vtkTransformToGrid
Tests:
vtkGridTransform (Tests)

Definition at line 44 of file vtkGridTransform.h.

Member Typedef Documentation

Definition at line 48 of file vtkGridTransform.h.

Constructor & Destructor Documentation

vtkGridTransform::vtkGridTransform ( )
protected
vtkGridTransform::~vtkGridTransform ( )
protected

Member Function Documentation

static vtkGridTransform* vtkGridTransform::New ( )
static
static int vtkGridTransform::IsTypeOf ( const char *  type)
static
virtual int vtkGridTransform::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 vtkGridTransform* vtkGridTransform::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkGridTransform::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkWarpTransform.

vtkGridTransform* vtkGridTransform::NewInstance ( ) const
virtual void vtkGridTransform::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 vtkWarpTransform.

virtual void vtkGridTransform::SetDisplacementGridConnection ( vtkAlgorithmOutput )
virtual

Set/Get the grid transform (the grid transform must have three components for displacement in x, y, and z respectively). The vtkGridTransform class will never modify the data. Note that SetDisplacementGridData() does not setup a pipeline connection whereas SetDisplacementGridConnection does.

virtual void vtkGridTransform::SetDisplacementGridData ( vtkImageData )
virtual

Set/Get the grid transform (the grid transform must have three components for displacement in x, y, and z respectively). The vtkGridTransform class will never modify the data. Note that SetDisplacementGridData() does not setup a pipeline connection whereas SetDisplacementGridConnection does.

virtual vtkImageData* vtkGridTransform::GetDisplacementGrid ( )
virtual

Set/Get the grid transform (the grid transform must have three components for displacement in x, y, and z respectively). The vtkGridTransform class will never modify the data. Note that SetDisplacementGridData() does not setup a pipeline connection whereas SetDisplacementGridConnection does.

virtual void vtkGridTransform::SetDisplacementScale ( double  )
virtual

Set scale factor to be applied to the displacements. This is used primarily for grids which contain integer data types. Default: 1

virtual double vtkGridTransform::GetDisplacementScale ( )
virtual

Set scale factor to be applied to the displacements. This is used primarily for grids which contain integer data types. Default: 1

virtual void vtkGridTransform::SetDisplacementShift ( double  )
virtual

Set a shift to be applied to the displacements. The shift is applied after the scale, i.e. x = scale*y + shift. Default: 0

virtual double vtkGridTransform::GetDisplacementShift ( )
virtual

Set a shift to be applied to the displacements. The shift is applied after the scale, i.e. x = scale*y + shift. Default: 0

void vtkGridTransform::SetInterpolationMode ( int  mode)

Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.

virtual int vtkGridTransform::GetInterpolationMode ( )
virtual

Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.

void vtkGridTransform::SetInterpolationModeToNearestNeighbor ( )
inline

Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.

Definition at line 81 of file vtkGridTransform.h.

void vtkGridTransform::SetInterpolationModeToLinear ( )
inline

Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.

Definition at line 83 of file vtkGridTransform.h.

void vtkGridTransform::SetInterpolationModeToCubic ( )
inline

Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.

Definition at line 85 of file vtkGridTransform.h.

const char * vtkGridTransform::GetInterpolationModeAsString ( )
inline

Set interpolation mode for sampling the grid. Higher-order interpolation allows you to use a sparser grid. Default: Linear.

Definition at line 152 of file vtkGridTransform.h.

vtkAbstractTransform* vtkGridTransform::MakeTransform ( )
virtual

Make another transform of the same type.

Implements vtkAbstractTransform.

unsigned long vtkGridTransform::GetMTime ( )
virtual

Get the MTime.

Reimplemented from vtkAbstractTransform.

void vtkGridTransform::InternalUpdate ( )
protectedvirtual

Update the displacement grid.

Reimplemented from vtkAbstractTransform.

void vtkGridTransform::InternalDeepCopy ( vtkAbstractTransform transform)
protectedvirtual

Copy this transform from another of the same type.

Reimplemented from vtkAbstractTransform.

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

Internal functions for calculating the transformation.

Implements vtkWarpTransform.

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

Internal functions for calculating the transformation.

Implements vtkWarpTransform.

void vtkGridTransform::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 vtkGridTransform::ForwardTransformDerivative ( const double  in[3],
double  out[3],
double  derivative[3][3] 
)
protectedvirtual

Calculate the forward transform as well as the derivative.

Implements vtkWarpTransform.

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

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

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

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

Member Data Documentation

void(* vtkGridTransform::InterpolationFunction) (double point[3], double displacement[3], double derivatives[3][3], void *gridPtr, int gridType, int inExt[6], vtkIdType inInc[3])
protected

Definition at line 126 of file vtkGridTransform.h.

int vtkGridTransform::InterpolationMode
protected

Definition at line 131 of file vtkGridTransform.h.

double vtkGridTransform::DisplacementScale
protected

Definition at line 132 of file vtkGridTransform.h.

double vtkGridTransform::DisplacementShift
protected

Definition at line 133 of file vtkGridTransform.h.

void* vtkGridTransform::GridPointer
protected

Definition at line 135 of file vtkGridTransform.h.

int vtkGridTransform::GridScalarType
protected

Definition at line 136 of file vtkGridTransform.h.

double vtkGridTransform::GridSpacing[3]
protected

Definition at line 137 of file vtkGridTransform.h.

double vtkGridTransform::GridOrigin[3]
protected

Definition at line 138 of file vtkGridTransform.h.

int vtkGridTransform::GridExtent[6]
protected

Definition at line 139 of file vtkGridTransform.h.

vtkIdType vtkGridTransform::GridIncrements[3]
protected

Definition at line 140 of file vtkGridTransform.h.


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