#include <itkInterpolateImageFunction.h>

Detailed Description

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

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, TCoordinate >:

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

Public Types
using	ConstPointer = SmartPointer<const Self>

using	ContinuousIndexType

using	IndexType

using	IndexValueType

using	InputImageType

using	OutputType

using	Pointer = SmartPointer<Self>

using	PointType

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

using	Self = InterpolateImageFunction

using	SizeType = typename InputImageType::SizeType

using	Superclass

Public Types inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, double >
using	ConstPointer

using	ContinuousIndexType

using	CoordinateType

using	IndexType

using	IndexValueType

using	InputImageConstPointer

using	InputImageType

using	InputPixelType

using	OutputType

using	Pointer

using	PointType

using	Self

using	Superclass

Public Types inherited from itk::FunctionBase< Point< double, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
using	ConstPointer

using	InputType

using	OutputType

using	Pointer

using	Self

using	Superclass

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

virtual SizeType	GetRadius () const =0


OutputType	Evaluate (const PointType &point) const override

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

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

OutputType	Evaluate (const PointType &point) const override=0

virtual NumericTraits< TInputImage::PixelType >::RealType	EvaluateAtContinuousIndex (const ContinuousIndexType &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

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

Public Member Functions inherited from itk::FunctionBase< Point< double, 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 *cmd) 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

const char *	GetNameOfClass () const override

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

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, double >
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, double >
	ImageFunction ()

	~ImageFunction () override=default

Protected Member Functions inherited from itk::FunctionBase< Point< double, 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

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

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, double >
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 TCoordinate = double>

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

Definition at line 57 of file itkInterpolateImageFunction.h.

◆ ContinuousIndexType

template<typename TInputImage, typename TCoordinate = double>

using itk::ImageFunction< TInputImage, TOutput, TCoordinate >::ContinuousIndexType

ContinuousIndex Type.

Definition at line 98 of file itkImageFunction.h.

◆ IndexType

template<typename TInputImage, typename TCoordinate = double>

using itk::ImageFunction< TInputImage, TOutput, TCoordinate >::IndexType

Index Type.

Definition at line 94 of file itkImageFunction.h.

◆ IndexValueType

template<typename TInputImage, typename TCoordinate = double>

using itk::ImageFunction< TInputImage, TOutput, TCoordinate >::IndexValueType

Definition at line 95 of file itkImageFunction.h.

◆ InputImageType

template<typename TInputImage, typename TCoordinate = double>

using itk::ImageFunction< TInputImage, TOutput, TCoordinate >::InputImageType

InputImageType type alias support

Definition at line 75 of file itkImageFunction.h.

◆ OutputType

template<typename TInputImage, typename TCoordinate = double>

using itk::ImageFunction< TInputImage, TOutput, TCoordinate >::OutputType

OutputType type alias support

Definition at line 84 of file itkImageFunction.h.

◆ Pointer

template<typename TInputImage, typename TCoordinate = double>

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

Definition at line 56 of file itkInterpolateImageFunction.h.

◆ PointType

template<typename TInputImage, typename TCoordinate = double>

using itk::ImageFunction< TInputImage, TOutput, TCoordinate >::PointType

Point Type.

Definition at line 101 of file itkImageFunction.h.

◆ RealType

template<typename TInputImage, typename TCoordinate = double>

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

RealType type alias support

Definition at line 85 of file itkInterpolateImageFunction.h.

◆ Self

template<typename TInputImage, typename TCoordinate = double>

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

Standard class type aliases.

Definition at line 52 of file itkInterpolateImageFunction.h.

◆ SizeType

template<typename TInputImage, typename TCoordinate = double>

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

Size type alias support

Definition at line 79 of file itkInterpolateImageFunction.h.

◆ Superclass

template<typename TInputImage, typename TCoordinate = double>

using itk::InterpolateImageFunction< TInputImage, TCoordinate >::Superclass

Initial value:

ImageFunction<TInputImage, typename NumericTraits<typename TInputImage::PixelType>::RealType, TCoordinate>

itk::ImageFunction< TInputImage, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >, float >::ImageFunction

ImageFunction()

Definition at line 53 of file itkInterpolateImageFunction.h.

Constructor & Destructor Documentation

◆ InterpolateImageFunction()

template<typename TInputImage, typename TCoordinate = double>

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

protecteddefault

◆ ~InterpolateImageFunction()

template<typename TInputImage, typename TCoordinate = double>

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

overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TInputImage, typename TCoordinate = double>

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

inlineoverride

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.

Definition at line 96 of file itkInterpolateImageFunction.h.

◆ EvaluateAtContinuousIndex()

template<typename TInputImage, typename TCoordinate = double>

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

◆ EvaluateAtIndex()

template<typename TInputImage, typename TCoordinate = double>

OutputType itk::InterpolateImageFunction< TInputImage, TCoordinate >::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, double >.

Definition at line 126 of file itkInterpolateImageFunction.h.

◆ GetNameOfClass()

template<typename TInputImage, typename TCoordinate = double>

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

overridevirtual

See also: LightObject::GetNameOfClass()

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

◆ GetRadius()

template<typename TInputImage, typename TCoordinate = double>

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

pure virtual

Get the radius required for interpolation.

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

◆ PrintSelf()

template<typename TInputImage, typename TCoordinate = double>

void itk::InterpolateImageFunction< TInputImage, TCoordinate >::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::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, double >.

Definition at line 143 of file itkInterpolateImageFunction.h.

Referenced by itk::NearestNeighborInterpolateImageFunction< ImageType >::PrintSelf().

Member Data Documentation

◆ ImageDimension

template<typename TInputImage, typename TCoordinate = double>

unsigned int itk::InterpolateImageFunction< TInputImage, TCoordinate >::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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ ContinuousIndexType

◆ IndexType

◆ IndexValueType

◆ InputImageType

◆ OutputType

◆ Pointer

◆ PointType

◆ RealType

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ InterpolateImageFunction()

◆ ~InterpolateImageFunction()

Member Function Documentation

◆ Evaluate()

◆ EvaluateAtContinuousIndex()

◆ EvaluateAtIndex()

◆ GetNameOfClass()

◆ GetRadius()

◆ PrintSelf()

Member Data Documentation

◆ ImageDimension