perform b-spline interpolation on images More...

#include <vtkImageBSplineInterpolator.h>

Inheritance diagram for vtkImageBSplineInterpolator:

Collaboration diagram for vtkImageBSplineInterpolator:

Public Types
typedef vtkAbstractImageInterpolator	Superclass

Public Types inherited from vtkAbstractImageInterpolator
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkImageBSplineInterpolator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	ComputeSupportSize (const double matrix[16], int support[3])
	Get the support size for use in computing update extents. More...

virtual bool	IsSeparable ()
	Returns true if the interpolator supports weight precomputation. More...

virtual void	FreePrecomputedWeights (vtkInterpolationWeights *&weights)
	Free the precomputed weights. More...


void	SetSplineDegree (int degree)
	Set the degree of the spline polynomial. More...

int	GetSplineDegree ()
	Set the degree of the spline polynomial. More...

int	GetSplineDegreeMinValue ()
	Set the degree of the spline polynomial. More...

int	GetSplineDegreeMaxValue ()
	Set the degree of the spline polynomial. More...


virtual void	PrecomputeWeightsForExtent (const double matrix[16], const int extent[6], int newExtent[6], vtkInterpolationWeights *&weights)
	If the data is going to be sampled on a regular grid, then the interpolation weights can be precomputed. More...

virtual void	PrecomputeWeightsForExtent (const float matrix[16], const int extent[6], int newExtent[6], vtkInterpolationWeights *&weights)
	If the data is going to be sampled on a regular grid, then the interpolation weights can be precomputed. More...

Public Member Functions inherited from vtkAbstractImageInterpolator
vtkAbstractImageInterpolator *	NewInstance () 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)
	A version of Interpolate that takes structured coords instead of data coords. More...

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])
	Check an x,y,z point to see if it is within the bounds for the structured coords of the image. More...

void	SetBorderMode (int mode)
	The border mode (default: clamp). More...

void	SetBorderModeToClamp ()
	The border mode (default: clamp). More...

void	SetBorderModeToRepeat ()
	The border mode (default: clamp). More...

void	SetBorderModeToMirror ()
	The border mode (default: clamp). More...

int	GetBorderMode ()
	The border mode (default: clamp). More...

const char *	GetBorderModeAsString ()
	The border mode (default: clamp). More...

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)
	Get a row of samples, using the weights that were precomputed by PrecomputeWeightsForExtent. More...

virtual double *	GetSpacing ()
	Get the spacing of the data being interpolated. More...

virtual void	GetSpacing (double &, double &, double &)
	Get the spacing of the data being interpolated. More...

virtual void	GetSpacing (double[3])
	Get the spacing of the data being interpolated. More...

virtual double *	GetOrigin ()
	Get the origin of the data being interpolated. More...

virtual void	GetOrigin (double &, double &, double &)
	Get the origin of the data being interpolated. More...

virtual void	GetOrigin (double[3])
	Get the origin of the data being interpolated. More...

virtual int *	GetExtent ()
	Get the extent of the data being interpolated. More...

virtual void	GetExtent (int &, int &, int &, int &, int &, int &)
	Get the extent of the data being interpolated. More...

virtual void	GetExtent (int[6])
	Get the extent of the data being interpolated. More...

int *	GetWholeExtent ()
	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])
	Get the whole extent of the data being interpolated, including parts of the data that are not currently in memory. 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...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

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

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkImageBSplineInterpolator *	New ()

static int	IsTypeOf (const char *type)

static vtkImageBSplineInterpolator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractImageInterpolator
static int	IsTypeOf (const char *type)

static vtkAbstractImageInterpolator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkImageBSplineInterpolator ()

	~vtkImageBSplineInterpolator ()

virtual void	InternalUpdate ()
	Update the interpolator. More...

virtual void	InternalDeepCopy (vtkAbstractImageInterpolator *obj)
	Copy the interpolator. More...

virtual void	BuildKernelLookupTable ()
	Build the lookup tables used for the interpolation. More...

virtual void	FreeKernelLookupTable ()
	Free the kernel lookup tables. More...


virtual void	GetInterpolationFunc (void(*doublefunc)(vtkInterpolationInfo , const double[3], double *))
	Get the interpolation functions. More...

virtual void	GetInterpolationFunc (void(*floatfunc)(vtkInterpolationInfo , const float[3], float *))
	Get the interpolation functions. More...


virtual void	GetRowInterpolationFunc (void(*doublefunc)(vtkInterpolationWeights , int, int, int, double *, int))
	Get the row interpolation functions. More...

virtual void	GetRowInterpolationFunc (void(*floatfunc)(vtkInterpolationWeights , int, int, int, float *, int))
	Get the row interpolation functions. More...

Protected Member Functions inherited from vtkAbstractImageInterpolator
	vtkAbstractImageInterpolator ()

	~vtkAbstractImageInterpolator ()

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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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

float *	KernelLookupTable

Protected Attributes inherited from vtkAbstractImageInterpolator
vtkDataArray *	Scalars

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

vtkInterpolationInfo *	InterpolationInfo

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

typedef vtkAbstractImageInterpolator vtkImageBSplineInterpolator::Superclass

Definition at line 59 of file vtkImageBSplineInterpolator.h.

Constructor & Destructor Documentation

vtkImageBSplineInterpolator::vtkImageBSplineInterpolator ( )

protected

vtkImageBSplineInterpolator::~vtkImageBSplineInterpolator ( )

protected

Member Function Documentation

static vtkImageBSplineInterpolator* vtkImageBSplineInterpolator::New ( )

static

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

static

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

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

static

virtual vtkObjectBase* vtkImageBSplineInterpolator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractImageInterpolator.

vtkImageBSplineInterpolator* vtkImageBSplineInterpolator::NewInstance ( ) const

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.

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.

int vtkImageBSplineInterpolator::GetSplineDegree ( )

inline

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.

Definition at line 69 of file vtkImageBSplineInterpolator.h.

int vtkImageBSplineInterpolator::GetSplineDegreeMinValue ( )

inline

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.

Definition at line 70 of file vtkImageBSplineInterpolator.h.

int vtkImageBSplineInterpolator::GetSplineDegreeMaxValue ( )

inline

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.

Definition at line 71 of file vtkImageBSplineInterpolator.h.

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

virtual

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 NULL as the matrix to retrieve the full kernel size.

Implements vtkAbstractImageInterpolator.

virtual bool vtkImageBSplineInterpolator::IsSeparable ( )

virtual

Returns true if the interpolator supports weight precomputation.

This will always return true for this interpolator.

Implements vtkAbstractImageInterpolator.

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

virtual

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.

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

virtual

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.

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

virtual

Free the precomputed weights.

THIS METHOD IS THREAD SAFE.

Reimplemented from vtkAbstractImageInterpolator.

virtual void vtkImageBSplineInterpolator::InternalUpdate ( )

protectedvirtual

Update the interpolator.

Implements vtkAbstractImageInterpolator.

virtual void vtkImageBSplineInterpolator::InternalDeepCopy ( vtkAbstractImageInterpolator * obj )

protectedvirtual