interpolate data values from images More...

#include <vtkAbstractImageInterpolator.h>

Inheritance diagram for vtkAbstractImageInterpolator:

Collaboration diagram for vtkAbstractImageInterpolator:

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

vtkAbstractImageInterpolator *	NewInstance () const

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

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

virtual 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	SetSlidingWindow (bool x)
	Enable sliding window for separable kernels. More...

void	SlidingWindowOn ()

void	SlidingWindowOff ()

bool	GetSlidingWindow ()

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

virtual bool	IsSeparable ()=0
	True if the interpolation is separable, which means that the weights can be precomputed in order to accelerate the interpolation. More...

virtual void	FreePrecomputedWeights (vtkInterpolationWeights *&weights)
	Free the weights that were provided by PrecomputeWeightsForExtent. 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 (vtkImageBorderMode 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...

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

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


virtual void	PrecomputeWeightsForExtent (const double matrix[16], const int extent[6], int checkExtent[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 checkExtent[6], vtkInterpolationWeights *&weights)
	If the data is going to be sampled on a regular grid, then the interpolation weights can be precomputed. 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 *	GetDirection ()
	Get the direction of the data being interpolated. More...

virtual void	GetDirection (double data[9])
	Get the direction 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...

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

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. 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)
	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...

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

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

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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...

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

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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...

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
static vtkTypeBool	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 (vtkTypeBool 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 vtkTypeBool	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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractImageInterpolator ()

	~vtkAbstractImageInterpolator () override

virtual void	InternalUpdate ()=0
	Subclass-specific updates. More...

virtual void	InternalDeepCopy (vtkAbstractImageInterpolator *obj)=0
	Subclass-specific copy. More...

void	CoordinateToIJK (const double point[3], double ijk[3])
	Convert XYZ coordinate to IJK continuous index. 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...


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))
	Get the sliding window interpolation functions. More...

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkDataArray *	Scalars

double	StructuredBoundsDouble [6]

float	StructuredBoundsFloat [6]

int	Extent [6]

double	Spacing [3]

double	Direction [9]

double	InverseDirection [9]

double	Origin [3]

double	OutValue

double	Tolerance

vtkImageBorderMode	BorderMode

int	ComponentOffset

int	ComponentCount

bool	UseDirection

bool	SlidingWindow

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

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

interpolate data values from images

vtkAbstractImageInterpolator provides an abstract interface for interpolating image data. You specify the data set you want to interpolate values from, then call Interpolate(x,y,z) to interpolate the data.

Thanks:: Thanks to David Gobbi at the Seaman Family MR Centre and Dept. of Clinical Neurosciences, Foothills Medical Centre, Calgary, for providing this class.

See also: vtkImageReslice vtkImageInterpolator vtkImageSincInterpolator

Examples:: vtkAbstractImageInterpolator (Examples)

Definition at line 41 of file vtkAbstractImageInterpolator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkAbstractImageInterpolator::Superclass

Definition at line 44 of file vtkAbstractImageInterpolator.h.

Constructor & Destructor Documentation

◆ vtkAbstractImageInterpolator()

vtkAbstractImageInterpolator::vtkAbstractImageInterpolator ( )

protected

◆ ~vtkAbstractImageInterpolator()

vtkAbstractImageInterpolator::~vtkAbstractImageInterpolator ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

Reimplemented in vtkImageSincInterpolator, vtkImageInterpolator, vtkImageBSplineInterpolator, and vtkGenericImageInterpolator.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAbstractImageInterpolator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkImageSincInterpolator, vtkImageInterpolator, vtkImageBSplineInterpolator, and vtkGenericImageInterpolator.

◆ NewInstance()

vtkAbstractImageInterpolator* vtkAbstractImageInterpolator::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkImageSincInterpolator, vtkImageInterpolator, vtkImageBSplineInterpolator, and vtkGenericImageInterpolator.

◆ Initialize()

virtual void vtkAbstractImageInterpolator::Initialize ( vtkDataObject * data )

virtual

Initialize the interpolator with the data that you wish to interpolate.

◆ ReleaseData()

virtual void vtkAbstractImageInterpolator::ReleaseData ( )

virtual

Release any data stored by the interpolator.

◆ DeepCopy()

void vtkAbstractImageInterpolator::DeepCopy ( vtkAbstractImageInterpolator * obj )

Copy the interpolator.

It is possible to duplicate an interpolator by calling NewInstance() followed by DeepCopy().

◆ Update()

virtual void vtkAbstractImageInterpolator::Update ( )

virtual

Update the interpolator.

If the interpolator has been modified by a Set method since Initialize() was called, you must call this method to update the interpolator before you can use it.

Reimplemented in vtkGenericImageInterpolator.

◆ Interpolate() [1/2]

double vtkAbstractImageInterpolator::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.

If the point is not within the bounds of the data set, then OutValue will be returned. This method is primarily meant for use by the wrapper languages.

◆ Interpolate() [2/2]

bool vtkAbstractImageInterpolator::Interpolate	(	const double	point[3],
		double *	value
	)

Sample the input data.

This is an inline method that calls the function that performs the appropriate interpolation for the data type. If the point is not within the bounds of the data set, then the return value is false, and each component will be set to the OutValue.

◆ SetOutValue()

void vtkAbstractImageInterpolator::SetOutValue ( double outValue )

The value to return when the point is out of bounds.

◆ GetOutValue()

double vtkAbstractImageInterpolator::GetOutValue ( )

inline

Definition at line 92 of file vtkAbstractImageInterpolator.h.

◆ SetTolerance()

void vtkAbstractImageInterpolator::SetTolerance ( double tol )

The tolerance to apply when checking whether a point is out of bounds.

This is a fractional distance relative to the voxel size, so a tolerance of 1 expands the bounds by one voxel.

◆ GetTolerance()

double vtkAbstractImageInterpolator::GetTolerance ( )

inline

Definition at line 100 of file vtkAbstractImageInterpolator.h.

◆ SetComponentOffset()

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

When the interpolation is performed, it will be clamped to the number of available components.

◆ GetComponentOffset()

int vtkAbstractImageInterpolator::GetComponentOffset ( )

inline

Definition at line 109 of file vtkAbstractImageInterpolator.h.

◆ SetComponentCount()

void vtkAbstractImageInterpolator::SetComponentCount ( int count )

This method specifies the number of components to extract.

The default value is -1, which extracts all available components. When the interpolation is performed, this will be clamped to the number of available components.

◆ GetComponentCount()

int vtkAbstractImageInterpolator::GetComponentCount ( )

inline

Definition at line 118 of file vtkAbstractImageInterpolator.h.

◆ ComputeNumberOfComponents()

int vtkAbstractImageInterpolator::ComputeNumberOfComponents ( int inputComponents )

Compute the number of output components based on the ComponentOffset, ComponentCount, and the number of components in the input data.

◆ GetNumberOfComponents()

int vtkAbstractImageInterpolator::GetNumberOfComponents ( )

Get the number of components that will be returned when Interpolate() is called.

This is only valid after initialization. Before then, use ComputeNumberOfComponents instead.

◆ InterpolateIJK() [1/2]

void vtkAbstractImageInterpolator::InterpolateIJK	(	const double	point[3],
		double *	value
	)

inline

A version of Interpolate that takes structured coords instead of data coords.

Structured coords are the data coords after subtracting the Origin and dividing by the Spacing.

Definition at line 343 of file vtkAbstractImageInterpolator.h.

◆ InterpolateIJK() [2/2]

void vtkAbstractImageInterpolator::InterpolateIJK	(	const float	point[3],
		float *	value
	)

inline

A version of Interpolate that takes structured coords instead of data coords.

Structured coords are the data coords after subtracting the Origin and dividing by the Spacing.

Definition at line 348 of file vtkAbstractImageInterpolator.h.

◆ CheckBoundsIJK() [1/2]

bool vtkAbstractImageInterpolator::CheckBoundsIJK ( const double x[3] )

inline

Check an x,y,z point to see if it is within the bounds for the structured coords of the image.

This is meant to be called prior to InterpolateIJK. The bounds that are checked against are the input image extent plus the tolerance.

Definition at line 353 of file vtkAbstractImageInterpolator.h.

◆ CheckBoundsIJK() [2/2]

bool vtkAbstractImageInterpolator::CheckBoundsIJK ( const float x[3] )

inline

Check an x,y,z point to see if it is within the bounds for the structured coords of the image.

This is meant to be called prior to InterpolateIJK. The bounds that are checked against are the input image extent plus the tolerance.

Definition at line 360 of file vtkAbstractImageInterpolator.h.