#include <itkInterpolateImageFunction.h>

Detailed Description

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

Base class for all image interpolators.

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 45 of file itkInterpolateImageFunction.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	RealType = typename NumericTraits< typename TInputImage::PixelType >::RealType

using	Self = InterpolateImageFunction

using	SizeType = typename InputImageType::SizeType

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

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

using	ContinuousIndexType = ContinuousIndex< TCoordRep, Self::ImageDimension >

using	CoordRepType = TCoordRep

using	IndexType = typename InputImageType::IndexType

using	IndexValueType = typename InputImageType::IndexValueType

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImageType = TInputImage

using	InputPixelType = typename InputImageType::PixelType

using	OutputType = NumericTraits< TInputImage::PixelType >::RealType

using	Pointer = SmartPointer< Self >

using	PointType = Point< TCoordRep, Self::ImageDimension >

using	Self = ImageFunction

using	Superclass = FunctionBase< Point< TCoordRep, Self::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >

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

using	InputType = Point< TCoordRep, TInputImage::ImageDimension >

using	OutputType = NumericTraits< TInputImage::PixelType >::RealType

using	Pointer = SmartPointer< Self >

using	Self = FunctionBase

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override=0

OutputType	EvaluateAtIndex (const IndexType &index) const override

const char *	GetNameOfClass () const override


OutputType	Evaluate (const PointType &point) const override


virtual SizeType	GetRadius () const =0

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

virtual const ContinuousIndexType &	GetEndContinuousIndex () const

virtual const IndexType &	GetEndIndex () const

const InputImageType *	GetInputImage () const

const char *	GetNameOfClass () const override

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

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

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

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

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

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

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

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

Protected Member Functions
	InterpolateImageFunction ()=default

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

	~InterpolateImageFunction () override=default

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

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

	~ImageFunction () override=default

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

	~FunctionBase () override=default

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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

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

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
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage, typename TCoordRep = double>

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

Definition at line 57 of file itkInterpolateImageFunction.h.

◆ Pointer

template<typename TInputImage, typename TCoordRep = double>

using itk::InterpolateImageFunction< TInputImage, TCoordRep >::Pointer = SmartPointer<Self>

Definition at line 56 of file itkInterpolateImageFunction.h.

◆ RealType

template<typename TInputImage, typename TCoordRep = double>

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

RealType type alias support

Definition at line 85 of file itkInterpolateImageFunction.h.

◆ Self

template<typename TInputImage, typename TCoordRep = double>

using itk::InterpolateImageFunction< TInputImage, TCoordRep >::Self = InterpolateImageFunction

Standard class type aliases.

Definition at line 52 of file itkInterpolateImageFunction.h.

◆ SizeType

template<typename TInputImage, typename TCoordRep = double>

using itk::InterpolateImageFunction< TInputImage, TCoordRep >::SizeType = typename InputImageType::SizeType

Size type alias support

Definition at line 79 of file itkInterpolateImageFunction.h.

◆ Superclass

template<typename TInputImage, typename TCoordRep = double>

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

Definition at line 54 of file itkInterpolateImageFunction.h.

Constructor & Destructor Documentation

◆ InterpolateImageFunction()

template<typename TInputImage, typename TCoordRep = double>

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

protecteddefault

◆ ~InterpolateImageFunction()

template<typename TInputImage, typename TCoordRep = double>

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

overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TInputImage, typename TCoordRep = double>

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 96 of file itkInterpolateImageFunction.h.

◆ EvaluateAtContinuousIndex()

template<typename TInputImage, typename TCoordRep = double>

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.

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

◆ EvaluateAtIndex()

template<typename TInputImage, typename TCoordRep = double>

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.

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

Definition at line 126 of file itkInterpolateImageFunction.h.

◆ GetNameOfClass()

template<typename TInputImage, typename TCoordRep = double>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

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

◆ GetRadius()

template<typename TInputImage, typename TCoordRep = double>

virtual SizeType itk::InterpolateImageFunction< TInputImage, TCoordRep >::GetRadius ( ) const

pure virtual

Get the radius required for interpolation.

This defines the number of surrounding pixels required to interpolate at a given point.

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

◆ PrintSelf()

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 159 of file itkInterpolateImageFunction.h.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage, typename TCoordRep = double>

constexpr unsigned int itk::InterpolateImageFunction< TInputImage, TCoordRep >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Dimension underlying input image.

Definition at line 69 of file itkInterpolateImageFunction.h.

The documentation for this class was generated from the following file:

itkInterpolateImageFunction.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ RealType

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ InterpolateImageFunction()

◆ ~InterpolateImageFunction()

Member Function Documentation

◆ Evaluate()

◆ EvaluateAtContinuousIndex()

◆ EvaluateAtIndex()

◆ GetNameOfClass()

◆ GetRadius()

◆ PrintSelf()

Member Data Documentation

◆ ImageDimension

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