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

a cubic b-spline deformation transformation More...

#include <vtkBSplineTransform.h>

Inheritance diagram for vtkBSplineTransform:
[legend]
Collaboration diagram for vtkBSplineTransform:
[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)
 
vtkBSplineTransform * NewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
vtkAbstractTransform * MakeTransform ()
 
unsigned long GetMTime ()
 
virtual void SetCoefficientConnection (vtkAlgorithmOutput *)
 
virtual void SetCoefficientData (vtkImageData *)
 
virtual vtkImageData * GetCoefficientData ()
 
virtual void SetDisplacementScale (double)
 
virtual double GetDisplacementScale ()
 
virtual void SetBorderMode (int)
 
void SetBorderModeToEdge ()
 
void SetBorderModeToZero ()
 
void SetBorderModeToZeroAtBorder ()
 
virtual int GetBorderMode ()
 
const char * GetBorderModeAsString ()
 
- Public Member Functions inherited from vtkWarpTransform
vtkWarpTransform * NewInstance () 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
vtkAbstractTransform * NewInstance () const
 
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)
 
vtkAbstractTransform * GetInverse ()
 
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])
 
double * TransformPoint (double x, double y, double z)
 
double * TransformPoint (const double point[3])
 
float * TransformFloatPoint (float x, float y, float z)
 
float * TransformFloatPoint (const float point[3])
 
double * TransformDoublePoint (double x, double y, double z)
 
double * TransformDoublePoint (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])
 
double * TransformDoubleNormalAtPoint (const double point[3], const double normal[3])
 
float * TransformFloatNormalAtPoint (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])
 
double * TransformDoubleVectorAtPoint (const double point[3], const double vector[3])
 
float * TransformFloatVectorAtPoint (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
vtkObject * NewInstance () 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)
 
vtkCommand * GetCommand (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 vtkBSplineTransform * New ()
 
static int IsTypeOf (const char *type)
 
static vtkBSplineTransform * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWarpTransform
static int IsTypeOf (const char *type)
 
static vtkWarpTransform * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractTransform
static int IsTypeOf (const char *type)
 
static vtkAbstractTransform * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObject * SafeDownCast (vtkObjectBase *o)
 
static vtkObject * New ()
 
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 vtkObjectBase * New ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkBSplineTransform ()
 
 ~vtkBSplineTransform ()
 
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(* CalculateSpline )(const double point[3], double displacement[3], double derivatives[3][3], void *gridPtr, int inExt[6], vtkIdType inInc[3], int borderMode)
 
double DisplacementScale
 
int BorderMode
 
void * GridPointer
 
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 cubic b-spline deformation transformation

vtkBSplineTransform computes a cubic b-spline transformation from a grid of b-spline coefficients.

Warning
The inverse grid transform is calculated using an iterative method, and is several times more expensive than the forward transform.
See also
vtkGeneralTransform vtkTransformToGrid vtkImageBSplineCoefficients
Thanks:
This class was written by David Gobbi at the Seaman Family MR Research Centre, Foothills Medical Centre, Calgary, Alberta. DG Gobbi and YP Starreveld, "Uniform B-Splines for the VTK Imaging Pipeline," VTK Journal, 2011, http://hdl.handle.net/10380/3252
Tests:
vtkBSplineTransform (Tests)

Definition at line 51 of file vtkBSplineTransform.h.

Member Typedef Documentation

typedef vtkWarpTransform vtkBSplineTransform::Superclass

Definition at line 55 of file vtkBSplineTransform.h.

Constructor & Destructor Documentation

vtkBSplineTransform::vtkBSplineTransform ( )
protected
vtkBSplineTransform::~vtkBSplineTransform ( )
protected

Member Function Documentation

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

Reimplemented from vtkWarpTransform.

vtkBSplineTransform* vtkBSplineTransform::NewInstance ( ) const
virtual void vtkBSplineTransform::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 vtkBSplineTransform::SetCoefficientConnection ( vtkAlgorithmOutput *  )
virtual

Set/Get the coefficient grid for the b-spline transform. The vtkBSplineTransform class will never modify the data. Note that SetCoefficientData() does not setup a pipeline connection whereas SetCoefficientConnection does.

virtual void vtkBSplineTransform::SetCoefficientData ( vtkImageData *  )
virtual

Set/Get the coefficient grid for the b-spline transform. The vtkBSplineTransform class will never modify the data. Note that SetCoefficientData() does not setup a pipeline connection whereas SetCoefficientConnection does.

virtual vtkImageData* vtkBSplineTransform::GetCoefficientData ( )
virtual

Set/Get the coefficient grid for the b-spline transform. The vtkBSplineTransform class will never modify the data. Note that SetCoefficientData() does not setup a pipeline connection whereas SetCoefficientConnection does.

virtual void vtkBSplineTransform::SetDisplacementScale ( double  )
virtual

Set/Get a scale to apply to the transformation.

virtual double vtkBSplineTransform::GetDisplacementScale ( )
virtual

Set/Get a scale to apply to the transformation.

virtual void vtkBSplineTransform::SetBorderMode ( int  )
virtual

Set/Get the border mode, to alter behavior at the edge of the grid. The Edge mode allows the displacement to converge to the edge coefficient past the boundary, which is similar to the behavior of the vtkGridTransform. The Zero mode allows the displacement to smoothly converge to zero two node-spacings past the boundary, which is useful when you want to create a localized transform. The ZeroAtBorder mode sacrifices smoothness to further localize the transform to just one node-spacing past the boundary.

void vtkBSplineTransform::SetBorderModeToEdge ( )
inline

Set/Get the border mode, to alter behavior at the edge of the grid. The Edge mode allows the displacement to converge to the edge coefficient past the boundary, which is similar to the behavior of the vtkGridTransform. The Zero mode allows the displacement to smoothly converge to zero two node-spacings past the boundary, which is useful when you want to create a localized transform. The ZeroAtBorder mode sacrifices smoothness to further localize the transform to just one node-spacing past the boundary.

Definition at line 85 of file vtkBSplineTransform.h.

void vtkBSplineTransform::SetBorderModeToZero ( )
inline

Set/Get the border mode, to alter behavior at the edge of the grid. The Edge mode allows the displacement to converge to the edge coefficient past the boundary, which is similar to the behavior of the vtkGridTransform. The Zero mode allows the displacement to smoothly converge to zero two node-spacings past the boundary, which is useful when you want to create a localized transform. The ZeroAtBorder mode sacrifices smoothness to further localize the transform to just one node-spacing past the boundary.

Definition at line 87 of file vtkBSplineTransform.h.

void vtkBSplineTransform::SetBorderModeToZeroAtBorder ( )
inline

Set/Get the border mode, to alter behavior at the edge of the grid. The Edge mode allows the displacement to converge to the edge coefficient past the boundary, which is similar to the behavior of the vtkGridTransform. The Zero mode allows the displacement to smoothly converge to zero two node-spacings past the boundary, which is useful when you want to create a localized transform. The ZeroAtBorder mode sacrifices smoothness to further localize the transform to just one node-spacing past the boundary.

Definition at line 89 of file vtkBSplineTransform.h.

virtual int vtkBSplineTransform::GetBorderMode ( )
virtual

Set/Get the border mode, to alter behavior at the edge of the grid. The Edge mode allows the displacement to converge to the edge coefficient past the boundary, which is similar to the behavior of the vtkGridTransform. The Zero mode allows the displacement to smoothly converge to zero two node-spacings past the boundary, which is useful when you want to create a localized transform. The ZeroAtBorder mode sacrifices smoothness to further localize the transform to just one node-spacing past the boundary.

const char* vtkBSplineTransform::GetBorderModeAsString ( )

Set/Get the border mode, to alter behavior at the edge of the grid. The Edge mode allows the displacement to converge to the edge coefficient past the boundary, which is similar to the behavior of the vtkGridTransform. The Zero mode allows the displacement to smoothly converge to zero two node-spacings past the boundary, which is useful when you want to create a localized transform. The ZeroAtBorder mode sacrifices smoothness to further localize the transform to just one node-spacing past the boundary.

vtkAbstractTransform* vtkBSplineTransform::MakeTransform ( )
virtual

Make another transform of the same type.

Implements vtkAbstractTransform.

unsigned long vtkBSplineTransform::GetMTime ( )
virtual

Get the MTime.

Reimplemented from vtkAbstractTransform.

void vtkBSplineTransform::InternalUpdate ( )
protectedvirtual

Update the displacement grid.

Reimplemented from vtkAbstractTransform.

void vtkBSplineTransform::InternalDeepCopy ( vtkAbstractTransform *  transform)
protectedvirtual

Copy this transform from another of the same type.

Reimplemented from vtkAbstractTransform.

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

Internal functions for calculating the transformation.

Implements vtkWarpTransform.

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

Internal functions for calculating the transformation.

Implements vtkWarpTransform.

void vtkBSplineTransform::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 vtkBSplineTransform::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 vtkBSplineTransform::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 vtkBSplineTransform::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 vtkBSplineTransform::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 vtkBSplineTransform::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(* vtkBSplineTransform::CalculateSpline) (const double point[3], double displacement[3], double derivatives[3][3], void *gridPtr, int inExt[6], vtkIdType inInc[3], int borderMode)
protected

Definition at line 131 of file vtkBSplineTransform.h.

double vtkBSplineTransform::DisplacementScale
protected

Definition at line 137 of file vtkBSplineTransform.h.

int vtkBSplineTransform::BorderMode
protected

Definition at line 138 of file vtkBSplineTransform.h.

void* vtkBSplineTransform::GridPointer
protected

Definition at line 140 of file vtkBSplineTransform.h.

double vtkBSplineTransform::GridSpacing[3]
protected

Definition at line 141 of file vtkBSplineTransform.h.

double vtkBSplineTransform::GridOrigin[3]
protected

Definition at line 142 of file vtkBSplineTransform.h.

int vtkBSplineTransform::GridExtent[6]
protected

Definition at line 143 of file vtkBSplineTransform.h.

vtkIdType vtkBSplineTransform::GridIncrements[3]
protected

Definition at line 144 of file vtkBSplineTransform.h.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.9.1