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 int	IsA (const char *type)
vtkAbstractImageInterpolator *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Initialize (vtkDataObject *data)
virtual void	ReleaseData ()
void	DeepCopy (vtkAbstractImageInterpolator *obj)
void	Update ()
double	Interpolate (double x, double y, double z, int component)
bool	Interpolate (const double point[3], double *value)
int	ComputeNumberOfComponents (int inputComponents)
int	GetNumberOfComponents ()
virtual void	ComputeSupportSize (const double matrix[16], int support[3])=0
virtual bool	IsSeparable ()=0
virtual void	FreePrecomputedWeights (vtkInterpolationWeights *&weights)

void	SetOutValue (double outValue)
double	GetOutValue ()

void	SetTolerance (double tol)
double	GetTolerance ()

void	SetComponentOffset (int offset)
int	GetComponentOffset ()

void	SetComponentCount (int count)
int	GetComponentCount ()

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

bool	CheckBoundsIJK (const double x[3])
bool	CheckBoundsIJK (const float x[3])

void	SetBorderMode (int mode)
void	SetBorderModeToClamp ()
void	SetBorderModeToRepeat ()
void	SetBorderModeToMirror ()
int	GetBorderMode ()
const char *	GetBorderModeAsString ()

virtual void	PrecomputeWeightsForExtent (const double matrix[16], const int extent[6], int checkExtent[6], vtkInterpolationWeights *&weights)
virtual void	PrecomputeWeightsForExtent (const float matrix[16], const int extent[6], int checkExtent[6], vtkInterpolationWeights *&weights)

void	InterpolateRow (vtkInterpolationWeights &weights, int xIdx, int yIdx, int zIdx, double value, int n)
void	InterpolateRow (vtkInterpolationWeights &weights, int xIdx, int yIdx, int zIdx, float value, int n)

virtual double *	GetSpacing ()
virtual void	GetSpacing (double &, double &, double &)
virtual void	GetSpacing (double[3])

virtual double *	GetOrigin ()
virtual void	GetOrigin (double &, double &, double &)
virtual void	GetOrigin (double[3])

virtual int *	GetExtent ()
virtual void	GetExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetExtent (int[6])

virtual int *	GetWholeExtent ()
virtual void	GetWholeExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetWholeExtent (int[6])
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkAbstractImageInterpolator *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAbstractImageInterpolator ()
	~vtkAbstractImageInterpolator ()
virtual void	InternalUpdate ()=0
virtual void	InternalDeepCopy (vtkAbstractImageInterpolator *obj)=0

virtual void	GetInterpolationFunc (void(*doublefunc)(vtkInterpolationInfo , const double[3], double *))
virtual void	GetInterpolationFunc (void(*floatfunc)(vtkInterpolationInfo , const float[3], float *))

virtual void	GetRowInterpolationFunc (void(*doublefunc)(vtkInterpolationWeights , int, int, int, double *, int))
virtual void	GetRowInterpolationFunc (void(*floatfunc)(vtkInterpolationWeights , int, int, int, float *, int))
Protected Attributes
vtkDataArray *	Scalars
double	StructuredBoundsDouble [6]
float	StructuredBoundsFloat [6]
int	WholeExtent [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)

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

Definition at line 45 of file vtkAbstractImageInterpolator.h.

Member Typedef Documentation

typedef vtkObject vtkAbstractImageInterpolator::Superclass

Reimplemented from vtkObject.

Reimplemented in vtkImageSincInterpolator, vtkImageBSplineInterpolator, and vtkImageInterpolator.

Definition at line 48 of file vtkAbstractImageInterpolator.h.

Constructor & Destructor Documentation

vtkAbstractImageInterpolator::vtkAbstractImageInterpolator ( ) [protected]

vtkAbstractImageInterpolator::~vtkAbstractImageInterpolator ( ) [protected]

Member Function Documentation

static int vtkAbstractImageInterpolator::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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 vtkObject.

Reimplemented in vtkImageSincInterpolator, vtkImageBSplineInterpolator, and vtkImageInterpolator.

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

Reimplemented in vtkImageSincInterpolator, vtkImageBSplineInterpolator, and vtkImageInterpolator.

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

Reimplemented from vtkObject.

Reimplemented in vtkImageSincInterpolator, vtkImageBSplineInterpolator, and vtkImageInterpolator.

virtual vtkObjectBase* vtkAbstractImageInterpolator::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

Reimplemented in vtkImageSincInterpolator, vtkImageBSplineInterpolator, and vtkImageInterpolator.

vtkAbstractImageInterpolator* vtkAbstractImageInterpolator::NewInstance ( ) const

Reimplemented from vtkObject.

Reimplemented in vtkImageSincInterpolator, vtkImageBSplineInterpolator, and vtkImageInterpolator.

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

Reimplemented in vtkImageSincInterpolator, vtkImageBSplineInterpolator, and vtkImageInterpolator.

virtual void vtkAbstractImageInterpolator::Initialize ( vtkDataObject * data ) [virtual]

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

virtual void vtkAbstractImageInterpolator::ReleaseData ( ) [virtual]

Release any data stored by the interpolator.

void vtkAbstractImageInterpolator::DeepCopy ( vtkAbstractImageInterpolator * obj )

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

void vtkAbstractImageInterpolator::Update ( )

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.

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.

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.

void vtkAbstractImageInterpolator::SetOutValue ( double outValue )

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

double vtkAbstractImageInterpolator::GetOutValue ( ) [inline]

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

Definition at line 84 of file vtkAbstractImageInterpolator.h.

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.

double vtkAbstractImageInterpolator::GetTolerance ( ) [inline]

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.

Definition at line 92 of file vtkAbstractImageInterpolator.h.

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.

int vtkAbstractImageInterpolator::GetComponentOffset ( ) [inline]

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.

Definition at line 101 of file vtkAbstractImageInterpolator.h.

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.

int vtkAbstractImageInterpolator::GetComponentCount ( ) [inline]

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.

Definition at line 110 of file vtkAbstractImageInterpolator.h.

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.

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.

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 287 of file vtkAbstractImageInterpolator.h.

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 293 of file vtkAbstractImageInterpolator.h.

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 299 of file vtkAbstractImageInterpolator.h.

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 307 of file vtkAbstractImageInterpolator.h.

void vtkAbstractImageInterpolator::SetBorderMode ( int mode )