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 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...
 
vtkBSplineTransformNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetCoefficientConnection (vtkAlgorithmOutput *)
 Set/Get the coefficient grid for the b-spline transform. More...
 
virtual void SetCoefficientData (vtkImageData *)
 
virtual vtkImageDataGetCoefficientData ()
 
virtual void SetDisplacementScale (double)
 Set/Get a scale to apply to the transformation. More...
 
virtual double GetDisplacementScale ()
 
virtual void SetBorderMode (int)
 Set/Get the border mode, to alter behavior at the edge of the grid. More...
 
void SetBorderModeToEdge ()
 
void SetBorderModeToZero ()
 
void SetBorderModeToZeroAtBorder ()
 
virtual int GetBorderMode ()
 
const char * GetBorderModeAsString ()
 
vtkAbstractTransformMakeTransform () override
 Make another transform of the same type. More...
 
vtkMTimeType GetMTime () override
 Get the MTime. More...
 
- Public Member Functions inherited from vtkWarpTransform
vtkWarpTransformNewInstance () const
 
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 int CircuitCheck (vtkAbstractTransform *transform)
 Check for self-reference. 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 vtkBSplineTransformNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkBSplineTransformSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWarpTransform
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
 
 vtkBSplineTransform ()
 
 ~vtkBSplineTransform () override
 
void InternalUpdate () override
 Update the displacement grid. More...
 
void InternalDeepCopy (vtkAbstractTransform *transform) override
 Copy this transform from another of the same type. More...
 
void ForwardTransformPoint (const float in[3], float out[3]) override
 Internal functions for calculating the transformation. More...
 
void ForwardTransformPoint (const double in[3], double out[3]) override
 
void ForwardTransformDerivative (const float in[3], float out[3], float derivative[3][3]) override
 Calculate the forward transform as well as the derivative. More...
 
void ForwardTransformDerivative (const double in[3], double out[3], double derivative[3][3]) override
 
void InverseTransformPoint (const float in[3], float out[3]) override
 If the InverseFlag is set to 1, then a call to InternalTransformPoint results in a call to InverseTransformPoint. More...
 
void InverseTransformPoint (const double in[3], double out[3]) override
 
void InverseTransformDerivative (const float in[3], float out[3], float derivative[3][3]) override
 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...
 
void InverseTransformDerivative (const double in[3], double out[3], double derivative[3][3]) override
 
- Protected Member Functions inherited from vtkWarpTransform
 vtkWarpTransform ()
 
 ~vtkWarpTransform () override
 
- Protected Member Functions inherited from vtkAbstractTransform
 vtkAbstractTransform ()
 
 ~vtkAbstractTransform () override
 
- 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

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
std::atomic< int32_t > 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

Definition at line 49 of file vtkBSplineTransform.h.

Member Typedef Documentation

◆ Superclass

Definition at line 53 of file vtkBSplineTransform.h.

Constructor & Destructor Documentation

◆ vtkBSplineTransform()

vtkBSplineTransform::vtkBSplineTransform ( )
protected

◆ ~vtkBSplineTransform()

vtkBSplineTransform::~vtkBSplineTransform ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkBSplineTransform* vtkBSplineTransform::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBSplineTransform::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkWarpTransform.

◆ NewInstance()

vtkBSplineTransform* vtkBSplineTransform::NewInstance ( ) const

◆ PrintSelf()

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

◆ SetCoefficientConnection()

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.

◆ SetCoefficientData()

virtual void vtkBSplineTransform::SetCoefficientData ( vtkImageData )
virtual

◆ GetCoefficientData()

virtual vtkImageData* vtkBSplineTransform::GetCoefficientData ( )
virtual

◆ SetDisplacementScale()

virtual void vtkBSplineTransform::SetDisplacementScale ( double  )
virtual

Set/Get a scale to apply to the transformation.

◆ GetDisplacementScale()

virtual double vtkBSplineTransform::GetDisplacementScale ( )
virtual

◆ SetBorderMode()

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.

◆ SetBorderModeToEdge()

void vtkBSplineTransform::SetBorderModeToEdge ( )
inline

Definition at line 88 of file vtkBSplineTransform.h.

◆ SetBorderModeToZero()

void vtkBSplineTransform::SetBorderModeToZero ( )
inline

Definition at line 89 of file vtkBSplineTransform.h.

◆ SetBorderModeToZeroAtBorder()

void vtkBSplineTransform::SetBorderModeToZeroAtBorder ( )
inline

Definition at line 90 of file vtkBSplineTransform.h.

◆ GetBorderMode()

virtual int vtkBSplineTransform::GetBorderMode ( )
virtual

◆ GetBorderModeAsString()

const char* vtkBSplineTransform::GetBorderModeAsString ( )

◆ MakeTransform()

vtkAbstractTransform* vtkBSplineTransform::MakeTransform ( )
overridevirtual

Make another transform of the same type.

Implements vtkAbstractTransform.

◆ GetMTime()

vtkMTimeType vtkBSplineTransform::GetMTime ( )
overridevirtual

Get the MTime.

Reimplemented from vtkAbstractTransform.

◆ InternalUpdate()

void vtkBSplineTransform::InternalUpdate ( )
overrideprotectedvirtual

Update the displacement grid.

Reimplemented from vtkAbstractTransform.

◆ InternalDeepCopy()

void vtkBSplineTransform::InternalDeepCopy ( vtkAbstractTransform transform)
overrideprotectedvirtual

Copy this transform from another of the same type.

Reimplemented from vtkAbstractTransform.

◆ ForwardTransformPoint() [1/2]

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

Internal functions for calculating the transformation.

Implements vtkWarpTransform.

◆ ForwardTransformPoint() [2/2]

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

Implements vtkWarpTransform.

◆ ForwardTransformDerivative() [1/2]

void vtkBSplineTransform::ForwardTransformDerivative ( const float  in[3],
float  out[3],
float  derivative[3][3] 
)
overrideprotectedvirtual

Calculate the forward transform as well as the derivative.

Implements vtkWarpTransform.

◆ ForwardTransformDerivative() [2/2]

void vtkBSplineTransform::ForwardTransformDerivative ( const double  in[3],
double  out[3],
double  derivative[3][3] 
)
overrideprotectedvirtual

Implements vtkWarpTransform.

◆ InverseTransformPoint() [1/2]

void vtkBSplineTransform::InverseTransformPoint ( const float  in[3],
float  out[3] 
)
overrideprotectedvirtual

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.

◆ InverseTransformPoint() [2/2]

void vtkBSplineTransform::InverseTransformPoint ( const double  in[3],
double  out[3] 
)
overrideprotectedvirtual

Reimplemented from vtkWarpTransform.

◆ InverseTransformDerivative() [1/2]

void vtkBSplineTransform::InverseTransformDerivative ( const float  in[3],
float  out[3],
float  derivative[3][3] 
)
overrideprotectedvirtual

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.

◆ InverseTransformDerivative() [2/2]

void vtkBSplineTransform::InverseTransformDerivative ( const double  in[3],
double  out[3],
double  derivative[3][3] 
)
overrideprotectedvirtual

Reimplemented from vtkWarpTransform.

Member Data Documentation

◆ CalculateSpline

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 138 of file vtkBSplineTransform.h.

◆ DisplacementScale

double vtkBSplineTransform::DisplacementScale
protected

Definition at line 141 of file vtkBSplineTransform.h.

◆ BorderMode

int vtkBSplineTransform::BorderMode
protected

Definition at line 142 of file vtkBSplineTransform.h.

◆ GridPointer

void* vtkBSplineTransform::GridPointer
protected

Definition at line 144 of file vtkBSplineTransform.h.

◆ GridSpacing

double vtkBSplineTransform::GridSpacing[3]
protected

Definition at line 145 of file vtkBSplineTransform.h.

◆ GridOrigin

double vtkBSplineTransform::GridOrigin[3]
protected

Definition at line 146 of file vtkBSplineTransform.h.

◆ GridExtent

int vtkBSplineTransform::GridExtent[6]
protected

Definition at line 147 of file vtkBSplineTransform.h.

◆ GridIncrements

vtkIdType vtkBSplineTransform::GridIncrements[3]
protected

Definition at line 148 of file vtkBSplineTransform.h.


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