vtkGridTransform Class Reference

#include <vtkGridTransform.h>

Inheritance diagram for vtkGridTransform:

[legend]Collaboration diagram for vtkGridTransform:

[legend]List of all members.

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 41 of file vtkGridTransform.h.

Public Types

typedef vtkWarpTransform Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

vtkAbstractTransform * MakeTransform ()

unsigned long GetMTime ()

virtual void PrintSelf (ostream &os, vtkIndent indent)

virtual void SetDisplacementGrid (vtkImageData *)

virtual vtkImageData * GetDisplacementGrid ()

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 ()

Static Public Member Functions

static vtkGridTransform * New ()

static int IsTypeOf (const char *type)

static vtkGridTransform * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkGridTransform ()

~vtkGridTransform ()

void InternalUpdate ()

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 InternalDeepCopy (vtkAbstractTransform *transform)

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

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

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

vtkImageData * DisplacementGrid

double DisplacementScale

double DisplacementShift

void * GridPointer

int GridScalarType

double GridSpacing [3]

double GridOrigin [3]

int GridExtent [6]

vtkIdType GridIncrements [3]

Member Typedef Documentation

typedef vtkWarpTransform vtkGridTransform::Superclass

Reimplemented from vtkWarpTransform.
Definition at line 45 of file vtkGridTransform.h.

Constructor & Destructor Documentation

vtkGridTransform::vtkGridTransform ( ) [protected]

vtkGridTransform::~vtkGridTransform ( ) [protected]

Member Function Documentation

static vtkGridTransform* vtkGridTransform::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.

virtual const char* vtkGridTransform::GetClassName ( ) [virtual]

Reimplemented from vtkWarpTransform.

static int vtkGridTransform::IsTypeOf ( const char * type ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkWarpTransform.

virtual int vtkGridTransform::IsA ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkWarpTransform.

static vtkGridTransform* vtkGridTransform::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkWarpTransform.

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::SetDisplacementGrid ( 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.

virtual vtkImageData* vtkGridTransform::GetDisplacementGrid ( ) [virtual]

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 75 of file vtkGridTransform.h.
References VTK_GRID_NEAREST.

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 77 of file vtkGridTransform.h.
References VTK_GRID_LINEAR.

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 79 of file vtkGridTransform.h.
References VTK_GRID_CUBIC.

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 145 of file vtkGridTransform.h.
References VTK_GRID_CUBIC, VTK_GRID_LINEAR, and VTK_GRID_NEAREST.

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 ( ) [protected, virtual]

Update the displacement grid.
Reimplemented from vtkAbstractTransform.

void vtkGridTransform::InternalDeepCopy ( vtkAbstractTransform * transform ) [protected, virtual]

Copy this transform from another of the same type.
Reimplemented from vtkAbstractTransform.

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

float out[3]

) [protected, virtual]

Internal functions for calculating the transformation.
Implements vtkWarpTransform.

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

double out[3]

) [protected, virtual]

Copy this transform from another of the same type.
Implements vtkWarpTransform.

void vtkGridTransform::ForwardTransformDerivative ( const float in[3],

float out[3],

float derivative[3][3]

) [protected, virtual]

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]

) [protected, virtual]

Calculate the forward transform as well as the derivative.
Implements vtkWarpTransform.

void vtkGridTransform::InverseTransformPoint ( const float in[3],

float out[3]

) [protected, virtual]

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]

) [protected, virtual]

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]

) [protected, virtual]

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]

) [protected, virtual]

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]

int vtkGridTransform::InterpolationMode [protected]

Definition at line 125 of file vtkGridTransform.h.

vtkImageData* vtkGridTransform::DisplacementGrid [protected]

Definition at line 126 of file vtkGridTransform.h.

double vtkGridTransform::DisplacementScale [protected]

Definition at line 127 of file vtkGridTransform.h.

double vtkGridTransform::DisplacementShift [protected]

Definition at line 128 of file vtkGridTransform.h.

void* vtkGridTransform::GridPointer [protected]

Definition at line 130 of file vtkGridTransform.h.

int vtkGridTransform::GridScalarType [protected]

Definition at line 131 of file vtkGridTransform.h.

double vtkGridTransform::GridSpacing[3] [protected]

Definition at line 132 of file vtkGridTransform.h.

double vtkGridTransform::GridOrigin[3] [protected]

Definition at line 133 of file vtkGridTransform.h.

int vtkGridTransform::GridExtent[6] [protected]

Definition at line 134 of file vtkGridTransform.h.

vtkIdType vtkGridTransform::GridIncrements[3] [protected]

Definition at line 135 of file vtkGridTransform.h.

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

dox/Hybrid/vtkGridTransform.h

Generated on Mon Jan 21 23:46:54 2008 for VTK by

1.4.3-20050530


Public Types
typedef vtkWarpTransform	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
vtkAbstractTransform *	MakeTransform ()
unsigned long	GetMTime ()

virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetDisplacementGrid (vtkImageData *)
virtual vtkImageData *	GetDisplacementGrid ()

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 ()
Static Public Member Functions
static vtkGridTransform *	New ()
static int	IsTypeOf (const char *type)
static vtkGridTransform *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkGridTransform ()
	~vtkGridTransform ()
void	InternalUpdate ()
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	InternalDeepCopy (vtkAbstractTransform *transform)
void	ForwardTransformPoint (const float in[3], float out[3])
void	ForwardTransformPoint (const double in[3], double out[3])
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
vtkImageData *	DisplacementGrid
double	DisplacementScale
double	DisplacementShift
void *	GridPointer
int	GridScalarType
double	GridSpacing [3]
double	GridOrigin [3]
int	GridExtent [6]
vtkIdType	GridIncrements [3]