#include <itkInterpolateImageFunction.h>

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

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

Detailed Description

template<typename TInputImage, typename TCoordRep = double>
class itk::InterpolateImageFunction< TInputImage, TCoordRep >

Base class for all image interpolaters.

InterpolateImageFunction is the base for all ImageFunctions that 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 ).

Warning: This hierarchy of functions work only for images with scalar pixel types. For images of vector pixel types use VectorInterpolateImageFunctions.

See Also: VectorInterpolateImageFunction

Definition at line 44 of file itkInterpolateImageFunction.h.

Public Types
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 OutputType	Evaluate (const PointType &point) const override

virtual OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override=0

virtual OutputType	EvaluateAtIndex (const IndexType &index) const override

virtual const char *	GetNameOfClass () 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 () const

virtual const IndexType &	GetEndIndex () const

const InputImageType *	GetInputImage () const

virtual const ContinuousIndexType &	GetStartContinuousIndex () const

virtual const IndexType &	GetStartIndex () const

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 LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () 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 override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () 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 Attributes
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
	InterpolateImageFunction ()

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

	~InterpolateImageFunction ()

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

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

	~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
	InterpolateImageFunction (const Self &)

void	operator= (const Self &)

Additional Inherited Members
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

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

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TInputImage, typename TCoordRep = double>

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

Definition at line 56 of file itkInterpolateImageFunction.h.

template<typename TInputImage, typename TCoordRep = double>

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

ContinuousIndex typedef support.

Definition at line 79 of file itkInterpolateImageFunction.h.

template<typename TInputImage, typename TCoordRep = double>

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

Index typedef support.

Definition at line 75 of file itkInterpolateImageFunction.h.

template<typename TInputImage, typename TCoordRep = double>

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

Definition at line 76 of file itkInterpolateImageFunction.h.

template<typename TInputImage, typename TCoordRep = double>

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

InputImageType typedef support.

Definition at line 65 of file itkInterpolateImageFunction.h.

template<typename TInputImage, typename TCoordRep = double>

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

OutputType typedef support.

Definition at line 59 of file itkInterpolateImageFunction.h.

template<typename TInputImage, typename TCoordRep = double>

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

Definition at line 55 of file itkInterpolateImageFunction.h.

template<typename TInputImage, typename TCoordRep = double>

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

Point typedef support.

Definition at line 72 of file itkInterpolateImageFunction.h.

template<typename TInputImage, typename TCoordRep = double>

typedef NumericTraits< typename TInputImage::PixelType >::RealType itk::InterpolateImageFunction< TInputImage, TCoordRep >::RealType

RealType typedef support.

Definition at line 82 of file itkInterpolateImageFunction.h.

template<typename TInputImage, typename TCoordRep = double>

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

Standard class typedefs.

Definition at line 50 of file itkInterpolateImageFunction.h.

template<typename TInputImage, typename TCoordRep = double>

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

Definition at line 53 of file itkInterpolateImageFunction.h.

Constructor & Destructor Documentation

template<typename TInputImage, typename TCoordRep = double>

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

inlineprotected

Definition at line 127 of file itkInterpolateImageFunction.h.

template<typename TInputImage, typename TCoordRep = double>

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

inlineprotected

Definition at line 128 of file itkInterpolateImageFunction.h.

template<typename TInputImage, typename TCoordRep = double>

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

private

Member Function Documentation

template<typename TInputImage, typename TCoordRep = double>

virtual OutputType itk::InterpolateImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType & point ) const

inlineoverridevirtual

Interpolate the image at a point position

Returns the 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::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >.

Reimplemented in itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >.

Definition at line 92 of file itkInterpolateImageFunction.h.

template<typename TInputImage, typename TCoordRep = double>

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

overridepure virtual

Interpolate the image at a continuous index position

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

Subclasses must override this method.

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

Implemented in itk::WindowedSincInterpolateImageFunction< TInputImage, VRadius, TWindowFunction, TBoundaryCondition, TCoordRep >, itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >, itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >, itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, and itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >.

Referenced by itk::InterpolateImageFunction< TImageType, TCoordRep >::Evaluate().

template<typename TInputImage, typename TCoordRep = double>

virtual OutputType itk::InterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType & index ) const

inlineoverridevirtual

Interpolate the image at an index position.

Simply returns the image value at the specified index 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.

Definition at line 121 of file itkInterpolateImageFunction.h.

template<typename TInputImage, typename TCoordRep = double>

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >.

Reimplemented in itk::WindowedSincInterpolateImageFunction< TInputImage, VRadius, TWindowFunction, TBoundaryCondition, TCoordRep >, itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >, itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >, itk::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >, itk::BSplineResampleImageFunction< TImageType, TCoordRep >, itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >, itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, and itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >.

template<typename TInputImage, typename TCoordRep = double>

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

private

template<typename TInputImage, typename TCoordRep = double>

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

inlineoverrideprotectedvirtual

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

Reimplemented in itk::WindowedSincInterpolateImageFunction< TInputImage, VRadius, TWindowFunction, TBoundaryCondition, TCoordRep >, itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, and itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >.

Definition at line 129 of file itkInterpolateImageFunction.h.

Referenced by itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >::PrintSelf().