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

perform b-spline interpolation on images More...

#include <vtkImageBSplineInterpolator.h>

Inheritance diagram for vtkImageBSplineInterpolator:
[legend]
Collaboration diagram for vtkImageBSplineInterpolator:
[legend]

Public Types

typedef vtkAbstractImageInterpolator Superclass
 
- Public Types inherited from vtkAbstractImageInterpolator
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...
 
vtkImageBSplineInterpolatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetSplineDegree (int degree)
 Set the degree of the spline polynomial. More...
 
int GetSplineDegree ()
 
int GetSplineDegreeMinValue ()
 
int GetSplineDegreeMaxValue ()
 
void ComputeSupportSize (const double matrix[16], int support[3]) override
 Get the support size for use in computing update extents. More...
 
bool IsSeparable () override
 Returns true if the interpolator supports weight precomputation. More...
 
void PrecomputeWeightsForExtent (const double matrix[16], const int extent[6], int newExtent[6], vtkInterpolationWeights *&weights) override
 If the data is going to be sampled on a regular grid, then the interpolation weights can be precomputed. More...
 
void PrecomputeWeightsForExtent (const float matrix[16], const int extent[6], int newExtent[6], vtkInterpolationWeights *&weights) override
 
void FreePrecomputedWeights (vtkInterpolationWeights *&weights) override
 Free the precomputed weights. More...
 
- Public Member Functions inherited from vtkAbstractImageInterpolator
vtkAbstractImageInterpolatorNewInstance () const
 
virtual void Initialize (vtkDataObject *data)
 Initialize the interpolator with the data that you wish to interpolate. More...
 
virtual void ReleaseData ()
 Release any data stored by the interpolator. More...
 
void DeepCopy (vtkAbstractImageInterpolator *obj)
 Copy the interpolator. More...
 
void Update ()
 Update the interpolator. More...
 
double Interpolate (double x, double y, double z, int component)
 Get the result of interpolating the specified component of the input data, which should be set to zero if there is only one component. More...
 
bool Interpolate (const double point[3], double *value)
 Sample the input data. More...
 
void SetOutValue (double outValue)
 The value to return when the point is out of bounds. More...
 
double GetOutValue ()
 
void SetTolerance (double tol)
 The tolerance to apply when checking whether a point is out of bounds. More...
 
double GetTolerance ()
 
void SetComponentOffset (int offset)
 This method specifies which component of the input will be interpolated, or if ComponentCount is also set, it specifies the first component. More...
 
int GetComponentOffset ()
 
void SetComponentCount (int count)
 This method specifies the number of components to extract. More...
 
int GetComponentCount ()
 
int ComputeNumberOfComponents (int inputComponents)
 Compute the number of output components based on the ComponentOffset, ComponentCount, and the number of components in the input data. More...
 
int GetNumberOfComponents ()
 Get the number of components that will be returned when Interpolate() is called. More...
 
void InterpolateIJK (const double point[3], double *value)
 A version of Interpolate that takes structured coords instead of data coords. More...
 
void InterpolateIJK (const float point[3], float *value)
 
bool CheckBoundsIJK (const double x[3])
 Check an x,y,z point to see if it is within the bounds for the structured coords of the image. More...
 
bool CheckBoundsIJK (const float x[3])
 
void SetBorderMode (int mode)
 The border mode (default: clamp). More...
 
void SetBorderModeToClamp ()
 
void SetBorderModeToRepeat ()
 
void SetBorderModeToMirror ()
 
int GetBorderMode ()
 
const char * GetBorderModeAsString ()
 
void SetSlidingWindow (bool x)
 Enable sliding window for separable kernels. More...
 
void SlidingWindowOn ()
 
void SlidingWindowOff ()
 
bool GetSlidingWindow ()
 
void InterpolateRow (vtkInterpolationWeights *&weights, int xIdx, int yIdx, int zIdx, double *value, int n)
 Get a row of samples, using the weights that were precomputed by PrecomputeWeightsForExtent. More...
 
void InterpolateRow (vtkInterpolationWeights *&weights, int xIdx, int yIdx, int zIdx, float *value, int n)
 
virtual doubleGetSpacing ()
 Get the spacing of the data being interpolated. More...
 
virtual void GetSpacing (double &, double &, double &)
 
virtual void GetSpacing (double[3])
 
virtual doubleGetOrigin ()
 Get the origin of the data being interpolated. More...
 
virtual void GetOrigin (double &, double &, double &)
 
virtual void GetOrigin (double[3])
 
virtual intGetExtent ()
 Get the extent of the data being interpolated. More...
 
virtual void GetExtent (int &, int &, int &, int &, int &, int &)
 
virtual void GetExtent (int[6])
 
intGetWholeExtent ()
 Get the whole extent of the data being interpolated, including parts of the data that are not currently in memory. More...
 
void GetWholeExtent (int extent[6])
 
- 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...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. 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...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release 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 vtkImageBSplineInterpolatorNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageBSplineInterpolatorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractImageInterpolator
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractImageInterpolatorSafeDownCast (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
 
 vtkImageBSplineInterpolator ()
 
 ~vtkImageBSplineInterpolator () override
 
void InternalUpdate () override
 Update the interpolator. More...
 
void InternalDeepCopy (vtkAbstractImageInterpolator *obj) override
 Copy the interpolator. More...
 
void GetInterpolationFunc (void(**doublefunc)(vtkInterpolationInfo *, const double[3], double *)) override
 Get the interpolation functions. More...
 
void GetInterpolationFunc (void(**floatfunc)(vtkInterpolationInfo *, const float[3], float *)) override
 
void GetRowInterpolationFunc (void(**doublefunc)(vtkInterpolationWeights *, int, int, int, double *, int)) override
 Get the row interpolation functions. More...
 
void GetRowInterpolationFunc (void(**floatfunc)(vtkInterpolationWeights *, int, int, int, float *, int)) override
 
virtual void BuildKernelLookupTable ()
 Build the lookup tables used for the interpolation. More...
 
virtual void FreeKernelLookupTable ()
 Free the kernel lookup tables. More...
 
- Protected Member Functions inherited from vtkAbstractImageInterpolator
 vtkAbstractImageInterpolator ()
 
 ~vtkAbstractImageInterpolator () override
 
virtual void GetSlidingWindowFunc (void(**doublefunc)(vtkInterpolationWeights *, int, int, int, double *, int))
 Get the sliding window interpolation functions. More...
 
virtual void GetSlidingWindowFunc (void(**floatfunc)(vtkInterpolationWeights *, int, int, int, float *, int))
 
- 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

int SplineDegree
 
floatKernelLookupTable
 
- Protected Attributes inherited from vtkAbstractImageInterpolator
vtkDataArrayScalars
 
double StructuredBoundsDouble [6]
 
float StructuredBoundsFloat [6]
 
int Extent [6]
 
double Spacing [3]
 
double Origin [3]
 
double OutValue
 
double Tolerance
 
int BorderMode
 
int ComponentOffset
 
int ComponentCount
 
bool SlidingWindow
 
vtkInterpolationInfoInterpolationInfo
 
void(* InterpolationFuncDouble )(vtkInterpolationInfo *info, const double point[3], double *outPtr)
 
void(* InterpolationFuncFloat )(vtkInterpolationInfo *info, const float point[3], float *outPtr)
 
void(* RowInterpolationFuncDouble )(vtkInterpolationWeights *weights, int idX, int idY, int idZ, double *outPtr, int n)
 
void(* RowInterpolationFuncFloat )(vtkInterpolationWeights *weights, int idX, int idY, int idZ, float *outPtr, int n)
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

perform b-spline interpolation on images

vtkImageBSplineInterpolator can be used to perform b-spline interpolation on images that have been filtered with vtkImageBSplineCoefficients. The b-spline interpolants provide the maximum possible degree of continuity for a given kernel size, but require that the image data be pre-filtered to generate b-spline coefficients before the interpolation is performed. Interpolating data that has not been pre-filtered will give incorrect results.

See also
vtkImageReslice vtkImageBSplineCoefficients vtkBSplineTransform
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
Examples:
vtkImageBSplineInterpolator (Examples)
Tests:
vtkImageBSplineInterpolator (Tests)

Definition at line 54 of file vtkImageBSplineInterpolator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 59 of file vtkImageBSplineInterpolator.h.

Constructor & Destructor Documentation

◆ vtkImageBSplineInterpolator()

vtkImageBSplineInterpolator::vtkImageBSplineInterpolator ( )
protected

◆ ~vtkImageBSplineInterpolator()

vtkImageBSplineInterpolator::~vtkImageBSplineInterpolator ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkImageBSplineInterpolator* vtkImageBSplineInterpolator::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkImageBSplineInterpolator::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 vtkAbstractImageInterpolator.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImageBSplineInterpolator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkAbstractImageInterpolator.

◆ NewInstance()

vtkImageBSplineInterpolator* vtkImageBSplineInterpolator::NewInstance ( ) const

◆ PrintSelf()

void vtkImageBSplineInterpolator::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 vtkAbstractImageInterpolator.

◆ SetSplineDegree()

void vtkImageBSplineInterpolator::SetSplineDegree ( int  degree)

Set the degree of the spline polynomial.

The default value is 3, and the maximum is 9. The data must be pre-filtered for the same degree of polynomial with vtkImageBSplineCoefficients.

◆ GetSplineDegree()

int vtkImageBSplineInterpolator::GetSplineDegree ( )
inline

Definition at line 69 of file vtkImageBSplineInterpolator.h.

◆ GetSplineDegreeMinValue()

int vtkImageBSplineInterpolator::GetSplineDegreeMinValue ( )
inline

Definition at line 70 of file vtkImageBSplineInterpolator.h.

◆ GetSplineDegreeMaxValue()

int vtkImageBSplineInterpolator::GetSplineDegreeMaxValue ( )
inline

Definition at line 71 of file vtkImageBSplineInterpolator.h.

◆ ComputeSupportSize()

void vtkImageBSplineInterpolator::ComputeSupportSize ( const double  matrix[16],
int  support[3] 
)
overridevirtual

Get the support size for use in computing update extents.

If the data will be sampled on a regular grid, then pass a matrix describing the structured coordinate transformation between the output and the input. Otherwise, pass nullptr as the matrix to retrieve the full kernel size.

Implements vtkAbstractImageInterpolator.

◆ IsSeparable()

bool vtkImageBSplineInterpolator::IsSeparable ( )
overridevirtual

Returns true if the interpolator supports weight precomputation.

This will always return true for this interpolator.

Implements vtkAbstractImageInterpolator.

◆ PrecomputeWeightsForExtent() [1/2]

void vtkImageBSplineInterpolator::PrecomputeWeightsForExtent ( const double  matrix[16],
const int  extent[6],
int  newExtent[6],
vtkInterpolationWeights *&  weights 
)
overridevirtual

If the data is going to be sampled on a regular grid, then the interpolation weights can be precomputed.

A matrix must be supplied that provides a transformation between the provided extent and the structured coordinates of the input. This matrix must perform only permutations, scales, and translation, i.e. each of the three columns must have only one non-zero value. A new extent is provided for out-of-bounds checks. THIS METHOD IS THREAD SAFE.

Reimplemented from vtkAbstractImageInterpolator.

◆ PrecomputeWeightsForExtent() [2/2]

void vtkImageBSplineInterpolator::PrecomputeWeightsForExtent ( const float  matrix[16],
const int  extent[6],
int  newExtent[6],
vtkInterpolationWeights *&  weights 
)
overridevirtual

Reimplemented from vtkAbstractImageInterpolator.

◆ FreePrecomputedWeights()

void vtkImageBSplineInterpolator::FreePrecomputedWeights ( vtkInterpolationWeights *&  weights)
overridevirtual

Free the precomputed weights.

THIS METHOD IS THREAD SAFE.

Reimplemented from vtkAbstractImageInterpolator.

◆ InternalUpdate()

void vtkImageBSplineInterpolator::InternalUpdate ( )
overrideprotectedvirtual

Update the interpolator.

Implements vtkAbstractImageInterpolator.

◆ InternalDeepCopy()

void vtkImageBSplineInterpolator::InternalDeepCopy ( vtkAbstractImageInterpolator obj)
overrideprotectedvirtual

Copy the interpolator.

Implements vtkAbstractImageInterpolator.

◆ GetInterpolationFunc() [1/2]

void vtkImageBSplineInterpolator::GetInterpolationFunc ( void(**)(vtkInterpolationInfo *, const double[3], double *)  doublefunc)
overrideprotectedvirtual

Get the interpolation functions.

Reimplemented from vtkAbstractImageInterpolator.

◆ GetInterpolationFunc() [2/2]

void vtkImageBSplineInterpolator::GetInterpolationFunc ( void(**)(vtkInterpolationInfo *, const float[3], float *)  floatfunc)
overrideprotectedvirtual

Reimplemented from vtkAbstractImageInterpolator.

◆ GetRowInterpolationFunc() [1/2]

void vtkImageBSplineInterpolator::GetRowInterpolationFunc ( void(**)(vtkInterpolationWeights *, int, int, int, double *, int doublefunc)
overrideprotectedvirtual

Get the row interpolation functions.

Reimplemented from vtkAbstractImageInterpolator.

◆ GetRowInterpolationFunc() [2/2]

void vtkImageBSplineInterpolator::GetRowInterpolationFunc ( void(**)(vtkInterpolationWeights *, int, int, int, float *, int floatfunc)
overrideprotectedvirtual

Reimplemented from vtkAbstractImageInterpolator.

◆ BuildKernelLookupTable()

virtual void vtkImageBSplineInterpolator::BuildKernelLookupTable ( )
protectedvirtual

Build the lookup tables used for the interpolation.

◆ FreeKernelLookupTable()

virtual void vtkImageBSplineInterpolator::FreeKernelLookupTable ( )
protectedvirtual

Free the kernel lookup tables.

Member Data Documentation

◆ SplineDegree

int vtkImageBSplineInterpolator::SplineDegree
protected

Definition at line 160 of file vtkImageBSplineInterpolator.h.

◆ KernelLookupTable

float* vtkImageBSplineInterpolator::KernelLookupTable
protected

Definition at line 161 of file vtkImageBSplineInterpolator.h.


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