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

#include <itkNearestNeighborInterpolateImageFunction.h>

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >
using	ContinuousIndexType = typename Superclass::ContinuousIndexType
using	IndexType = typename Superclass::IndexType
using	InputImageType = typename Superclass::InputImageType
using	OutputType = typename Superclass::OutputType
using	Pointer = SmartPointer< Self >
using	Self = NearestNeighborInterpolateImageFunction
using	SizeType = typename Superclass::SizeType
using	Superclass = InterpolateImageFunction< TInputImage, TCoordRep >
Public Types inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
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
virtual ::itk::LightObject::Pointer	CreateAnother () const
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override
virtual const char *	GetNameOfClass () const
SizeType	GetRadius () const override
Public Member Functions inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
OutputType	Evaluate (const PointType &point) const override
OutputType	EvaluateAtIndex (const IndexType &index) const override
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
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 Member Functions
static Pointer	New ()
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 ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
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
	NearestNeighborInterpolateImageFunction ()=default
void	PrintSelf (std::ostream &os, Indent indent) const override
	~NearestNeighborInterpolateImageFunction () override=default
Protected Member Functions inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
	InterpolateImageFunction ()=default
	~InterpolateImageFunction () override=default
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 ()

Additional Inherited Members
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::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >

Nearest neighbor interpolation of a scalar image.

NearestNeighborInterpolateImageFunction interpolates image intensity at a non-integer pixel position by copying the intensity for the nearest neighbor. This class is templated over the input image type and the coordinate representation type (e.g. float or double).

Examples

Examples/Filtering/ResampleImageFilter.cxx, Examples/Filtering/ResampleImageFilter2.cxx, Examples/Filtering/ResampleImageFilter3.cxx, Examples/Filtering/ResampleImageFilter9.cxx, Examples/RegistrationITKv4/ImageRegistration10.cxx, Examples/RegistrationITKv4/ImageRegistration19.cxx, Examples/RegistrationITKv4/MeanSquaresImageMetric1.cxx, and SphinxExamples/src/Core/ImageFunction/ResampleSegmentedImage/Code.cxx.

Definition at line 39 of file itkNearestNeighborInterpolateImageFunction.h.

Member Typedef Documentation

ConstPointer

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 49 of file itkNearestNeighborInterpolateImageFunction.h.

ContinuousIndexType

template<typename TInputImage , typename TCoordRep = double>

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

ContinuousIndex type alias support

Definition at line 73 of file itkNearestNeighborInterpolateImageFunction.h.

IndexType

template<typename TInputImage , typename TCoordRep = double>

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

Index type alias support

Definition at line 67 of file itkNearestNeighborInterpolateImageFunction.h.

InputImageType

template<typename TInputImage , typename TCoordRep = double>

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

InputImageType type alias support

Definition at line 61 of file itkNearestNeighborInterpolateImageFunction.h.

OutputType

template<typename TInputImage , typename TCoordRep = double>

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

OutputType type alias support

Definition at line 58 of file itkNearestNeighborInterpolateImageFunction.h.

Pointer

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 48 of file itkNearestNeighborInterpolateImageFunction.h.

Self

template<typename TInputImage , typename TCoordRep = double>

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

Standard class type aliases.

Definition at line 46 of file itkNearestNeighborInterpolateImageFunction.h.

SizeType

template<typename TInputImage , typename TCoordRep = double>

using itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >::SizeType = typename Superclass::SizeType

Size type alias support

Definition at line 70 of file itkNearestNeighborInterpolateImageFunction.h.

Superclass

template<typename TInputImage , typename TCoordRep = double>

using itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >::Superclass = InterpolateImageFunction<TInputImage, TCoordRep>

Definition at line 47 of file itkNearestNeighborInterpolateImageFunction.h.

Constructor & Destructor Documentation

NearestNeighborInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double>

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

protecteddefault

~NearestNeighborInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double>

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

overrideprotecteddefault

Member Function Documentation

CreateAnother()

template<typename TInputImage , typename TCoordRep = double>

virtual::itk::LightObject::Pointer itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >::CreateAnother ( ) 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.

EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordRep = double>

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

inlineoverridevirtual

Evaluate the function at a ContinuousIndex 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::InterpolateImageFunction< TInputImage, TCoordRep >.

Definition at line 84 of file itkNearestNeighborInterpolateImageFunction.h.

GetNameOfClass()

template<typename TInputImage , typename TCoordRep = double>

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

virtual

Run-time type information (and related methods).

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

GetRadius()

template<typename TInputImage , typename TCoordRep = double>

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

inlineoverridevirtual

Get the radius required for interpolation.

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

Implements itk::InterpolateImageFunction< TInputImage, TCoordRep >.

Definition at line 93 of file itkNearestNeighborInterpolateImageFunction.h.

New()

template<typename TInputImage , typename TCoordRep = double>

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

static

Method for creation through the object factory.

PrintSelf()

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 102 of file itkNearestNeighborInterpolateImageFunction.h.

Member Data Documentation

ImageDimension

template<typename TInputImage , typename TCoordRep = double>

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

staticconstexpr

Dimension underlying input image.

Definition at line 64 of file itkNearestNeighborInterpolateImageFunction.h.

---

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

• itkNearestNeighborInterpolateImageFunction.h