#include <itkLinearInterpolateImageFunction.h>

Inheritance diagram for itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >:

Collaboration diagram for itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >:

Detailed Description

template<class TInputImage, class TCoordRep = double>
class itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >

Linearly interpolate an image at specified positions.

LinearInterpolateImageFunction linearly interpolates image intensity at a non-integer pixel position. This class is templated over the input image type and the coordinate representation type (e.g. float or double).

This function works for N-dimensional images.

This function works for images with scalar and vector pixel types, and for images of type VectorImage.

See Also: VectorLinearInterpolateImageFunction

Wiki Examples:

All Examples

Linearly interpolate a position in an image

Definition at line 48 of file itkLinearInterpolateImageFunction.h.

Classes
struct	Dispatch

struct	DispatchBase

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::ContinuousIndexType	ContinuousIndexType

typedef Superclass::IndexType	IndexType

typedef Superclass::InputImageType	InputImageType

typedef Superclass::InputPixelType	InputPixelType

typedef Superclass::OutputType	OutputType

typedef SmartPointer< Self >	Pointer

typedef Superclass::RealType	RealType

typedef LinearInterpolateImageFunction	Self

typedef InterpolateImageFunction < TInputImage, TCoordRep >	Superclass

Public Types inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::ContinuousIndexType	ContinuousIndexType

typedef Superclass::IndexType	IndexType

typedef Superclass::IndexValueType	IndexValueType

typedef Superclass::InputImageType	InputImageType

typedef Superclass::OutputType	OutputType

typedef SmartPointer< Self >	Pointer

typedef Superclass::PointType	PointType

typedef NumericTraits < typename TInputImage::PixelType > ::RealType	RealType

typedef InterpolateImageFunction	Self

typedef ImageFunction < TInputImage, typename NumericTraits< typename TInputImage::PixelType > ::RealType, TCoordRep >	Superclass

Public Types inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
typedef SmartPointer< const Self >	ConstPointer

typedef ContinuousIndex < TCoordRep, itkGetStaticConstMacro(ImageDimension) >	ContinuousIndexType

typedef TCoordRep	CoordRepType

typedef InputImageType::IndexType	IndexType

typedef InputImageType::IndexValueType	IndexValueType

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef TInputImage	InputImageType

typedef InputImageType::PixelType	InputPixelType

typedef NumericTraits < TInputImage::PixelType > ::RealType	OutputType

typedef SmartPointer< Self >	Pointer

typedef Point< TCoordRep, itkGetStaticConstMacro(ImageDimension) >	PointType

typedef ImageFunction	Self

typedef FunctionBase< Point < TCoordRep, itkGetStaticConstMacro(ImageDimension) > , NumericTraits < TInputImage::PixelType > ::RealType >	Superclass

Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
typedef SmartPointer< const Self >	ConstPointer

typedef Point< TCoordRep, TInputImage::ImageDimension >	InputType

typedef NumericTraits < TInputImage::PixelType > ::RealType	OutputType

typedef SmartPointer< Self >	Pointer

typedef FunctionBase	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
virtual OutputType	Evaluate (const PointType &point) const

virtual OutputType	EvaluateAtIndex (const IndexType &index) const

Public Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
void	ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const

void	ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const

void	ConvertPointToNearestIndex (const PointType &point, IndexType &index) const

virtual NumericTraits < TInputImage::PixelType > ::RealType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0

virtual NumericTraits < TInputImage::PixelType > ::RealType	EvaluateAtIndex (const IndexType &index) const =0

virtual const ContinuousIndexType &	GetEndContinuousIndex ()

virtual const IndexType &	GetEndIndex ()

const InputImageType *	GetInputImage () const

virtual const ContinuousIndexType &	GetStartContinuousIndex ()

virtual const IndexType &	GetStartIndex ()

virtual void	SetInputImage (const InputImageType *ptr)

virtual bool	IsInsideBuffer (const IndexType &index) const

virtual bool	IsInsideBuffer (const ContinuousIndexType &index) const

virtual bool	IsInsideBuffer (const PointType &point) const

Public Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
virtual OutputType	Evaluate (const InputType &input) const =0

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = Superclass::ImageDimension

Static Public Attributes inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
static const unsigned int	ImageDimension = Superclass::ImageDimension

Static Public Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
static const unsigned int	ImageDimension

Protected Member Functions
	LinearInterpolateImageFunction ()

void	PrintSelf (std::ostream &os, Indent indent) const

	~LinearInterpolateImageFunction ()

Protected Member Functions inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
	InterpolateImageFunction ()

	~InterpolateImageFunction ()

Protected Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
	ImageFunction ()

void	PrintSelf (std::ostream &os, Indent indent) const

	~ImageFunction ()

Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
	FunctionBase ()

	~FunctionBase ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
OutputType	EvaluateOptimized (const Dispatch< 0 > &, const ContinuousIndexType &) const

OutputType	EvaluateOptimized (const Dispatch< 1 > &, const ContinuousIndexType &index) const

OutputType	EvaluateOptimized (const Dispatch< 2 > &, const ContinuousIndexType &index) const

OutputType	EvaluateOptimized (const Dispatch< 3 > &, const ContinuousIndexType &index) const

OutputType	EvaluateOptimized (const DispatchBase &, const ContinuousIndexType &index) const

virtual OutputType	EvaluateUnoptimized (const ContinuousIndexType &index) const

	LinearInterpolateImageFunction (const Self &)

void	operator= (const Self &)

Static Private Attributes
static const unsigned long	m_Neighbors

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Protected Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
ContinuousIndexType	m_EndContinuousIndex

IndexType	m_EndIndex

InputImageConstPointer	m_Image

ContinuousIndexType	m_StartContinuousIndex

IndexType	m_StartIndex

Member Typedef Documentation

template<class TInputImage , class TCoordRep = double>

typedef SmartPointer< const Self > itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::ConstPointer

Definition at line 56 of file itkLinearInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>

typedef Superclass::ContinuousIndexType itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::ContinuousIndexType

ContinuousIndex typedef support.

Definition at line 83 of file itkLinearInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>

typedef Superclass::IndexType itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::IndexType

Index typedef support.

Definition at line 80 of file itkLinearInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>

typedef Superclass::InputImageType itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::InputImageType

InputImageType typedef support.

Definition at line 68 of file itkLinearInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>

typedef Superclass::InputPixelType itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::InputPixelType

InputPixelType typedef support.

Definition at line 71 of file itkLinearInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>

typedef Superclass::OutputType itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::OutputType

OutputType typedef support.

Definition at line 62 of file itkLinearInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>

typedef SmartPointer< Self > itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::Pointer

Definition at line 55 of file itkLinearInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>

typedef Superclass::RealType itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::RealType

RealType typedef support.

Definition at line 74 of file itkLinearInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>

typedef LinearInterpolateImageFunction itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::Self

Standard class typedefs.

Definition at line 53 of file itkLinearInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>

typedef InterpolateImageFunction< TInputImage, TCoordRep > itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::Superclass

Definition at line 54 of file itkLinearInterpolateImageFunction.h.

Constructor & Destructor Documentation

template<class TInputImage , class TCoordRep = double>

itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::LinearInterpolateImageFunction ( )

protected

template<class TInputImage , class TCoordRep = double>

itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::~LinearInterpolateImageFunction ( )

protected

template<class TInputImage , class TCoordRep = double>

itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::LinearInterpolateImageFunction ( const Self & )

private

Member Function Documentation

template<class TInputImage , class TCoordRep = double>

virtual::itk::LightObject::Pointer itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::CreateAnother ( void ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<class TInputImage , class TCoordRep = double>

virtual OutputType itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType & index ) const

inlinevirtual

Evaluate the function at a ContinuousIndex position

Returns the linearly interpolated image intensity at a specified point position. No bounds checking is done. The point is assume to lie within the image buffer.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Implements itk::InterpolateImageFunction< TInputImage, TCoordRep >.

Definition at line 93 of file itkLinearInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>

OutputType itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateOptimized	(	const Dispatch< 0 > &	,
		const ContinuousIndexType &
	)		const

inlineprivate

Definition at line 116 of file itkLinearInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>

OutputType itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateOptimized	(	const Dispatch< 1 > &	,
		const ContinuousIndexType &	index
	)		const

inlineprivate

Definition at line 122 of file itkLinearInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>

OutputType itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateOptimized	(	const Dispatch< 2 > &	,
		const ContinuousIndexType &	index
	)		const

inlineprivate

Definition at line 152 of file itkLinearInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>

OutputType itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateOptimized	(	const Dispatch< 3 > &	,
		const ContinuousIndexType &	index
	)		const

inlineprivate

Definition at line 228 of file itkLinearInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>

OutputType itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateOptimized	(	const DispatchBase &	,
		const ContinuousIndexType &	index
	)		const

inlineprivate

Definition at line 494 of file itkLinearInterpolateImageFunction.h.

template<class TInputImage , class TCoordRep = double>

virtual OutputType itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateUnoptimized ( const ContinuousIndexType & index ) const

inlineprivatevirtual

template<class TInputImage , class TCoordRep = double>

virtual const char* itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::InterpolateImageFunction< TInputImage, TCoordRep >.

template<class TInputImage , class TCoordRep = double>

static Pointer itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::New ( )

static

Method for creation through the object factory.

template<class TInputImage , class TCoordRep = double>

void itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::operator= ( const Self & )

private

template<class TInputImage , class TCoordRep = double>

void itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

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 itk::InterpolateImageFunction< TInputImage, TCoordRep >.