itk::InterpolateImageFunction< TInputImage, TCoordRep > Class Template Reference

#include <itkInterpolateImageFunction.h>

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >
using	ContinuousIndexType = typename Superclass::ContinuousIndexType
using	IndexType = typename Superclass::IndexType
using	IndexValueType = typename Superclass::IndexValueType
using	InputImageType = typename Superclass::InputImageType
using	OutputType = typename Superclass::OutputType
using	Pointer = SmartPointer< Self >
using	PointType = typename Superclass::PointType
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	Evaluate (const PointType &point) const override
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override=0
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 >
NumericTraits< TInputImage::PixelType >::RealType	Evaluate (const PointType &point) const override=0
virtual NumericTraits< TInputImage::PixelType >::RealType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const=0
virtual NumericTraits< TInputImage::PixelType >::RealType	EvaluateAtIndex (const IndexType &index) const=0
const InputImageType *	GetInputImage () 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
void	ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
void	ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
virtual const IndexType &	GetStartIndex () const
virtual const IndexType &	GetEndIndex () const
virtual const ContinuousIndexType &	GetStartContinuousIndex () const
virtual const ContinuousIndexType &	GetEndContinuousIndex () 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
virtual SizeType	GetRadius () const =0
	InterpolateImageFunction ()=default
	~InterpolateImageFunction () override=default
void	PrintSelf (std::ostream &os, Indent indent) const override

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 Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
	ImageFunction ()
	~ImageFunction () override=default
void	PrintSelf (std::ostream &os, Indent indent) const override
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 ()
	~Object () override
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
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 ()
Protected Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
InputImageConstPointer	m_Image
IndexType	m_StartIndex
IndexType	m_EndIndex
ContinuousIndexType	m_StartContinuousIndex
ContinuousIndexType	m_EndContinuousIndex
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

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.

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.

ContinuousIndexType

template<typename TInputImage, typename TCoordRep = double>

using itk::InterpolateImageFunction< TInputImage, TCoordRep >::ContinuousIndexType = typename Superclass::ContinuousIndexType

ContinuousIndex type alias support

Definition at line 82 of file itkInterpolateImageFunction.h.

IndexType

template<typename TInputImage, typename TCoordRep = double>

using itk::InterpolateImageFunction< TInputImage, TCoordRep >::IndexType = typename Superclass::IndexType

Index type alias support

Definition at line 75 of file itkInterpolateImageFunction.h.

IndexValueType

template<typename TInputImage, typename TCoordRep = double>

using itk::InterpolateImageFunction< TInputImage, TCoordRep >::IndexValueType = typename Superclass::IndexValueType

Definition at line 76 of file itkInterpolateImageFunction.h.

InputImageType

template<typename TInputImage, typename TCoordRep = double>

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

InputImageType type alias support

Definition at line 66 of file itkInterpolateImageFunction.h.

OutputType

template<typename TInputImage, typename TCoordRep = double>

using itk::InterpolateImageFunction< TInputImage, TCoordRep >::OutputType = typename Superclass::OutputType

OutputType type alias support

Definition at line 63 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.

PointType

template<typename TInputImage, typename TCoordRep = double>

using itk::InterpolateImageFunction< TInputImage, TCoordRep >::PointType = typename Superclass::PointType

Point type alias support

Definition at line 72 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

Get the radius required for interpolation.

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

~InterpolateImageFunction()

template<typename TInputImage, typename TCoordRep = double>

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

overrideprotecteddefault

Get the radius required for interpolation.

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

Member Function Documentation

Evaluate()

template<typename TInputImage, typename TCoordRep = double>

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

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

EvaluateAtIndex()

template<typename TInputImage, typename TCoordRep = double>

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

inlineoverride

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

GetNameOfClass()

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::LabelImageGaussianInterpolateImageFunction< TInputImage, TCoordRep, TPixelCompare >, itk::RayCastInterpolateImageFunction< TInputImage, TCoordRep >, itk::BSplineResampleImageFunction< TImageType, TCoordRep >, itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >, itk::ComplexBSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, 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

Get the radius required for interpolation.

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

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