#include <itkNearestNeighborInterpolateImageFunction.h>

Detailed Description

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

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, and Examples/RegistrationITKv4/MeanSquaresImageMetric1.cxx.

Definition at line 39 of file itkNearestNeighborInterpolateImageFunction.h.

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

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

Public Types
using	ConstPointer = SmartPointer<const Self>

typedef ContinuousIndex< TCoordinate, Self::ImageDimension >	ContinuousIndexType

typedef typename InputImageType::IndexType	IndexType

typedef TInputImage	InputImageType

typedef TOutput	OutputType

using	Pointer = SmartPointer<Self>

using	Self = NearestNeighborInterpolateImageFunction

using	SizeType

using	Superclass = InterpolateImageFunction<TInputImage, TCoordinate>

Public Types inherited from itk::InterpolateImageFunction< TInputImage, double >
using	ConstPointer

typedef ContinuousIndex< double, Self::ImageDimension >	ContinuousIndexType

using	ContinuousIndexType

typedef typename InputImageType::IndexType	IndexType

using	IndexType

typedef typename InputImageType::IndexValueType	IndexValueType

using	IndexValueType

typedef TInputImage	InputImageType

using	InputImageType

typedef TOutput	OutputType

using	OutputType

using	Pointer

typedef Point< double, Self::ImageDimension >	PointType

using	PointType

using	RealType

using	Self

using	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
virtual::itk::LightObject::Pointer	CreateAnother () const

OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override

const char *	GetNameOfClass () const override

SizeType	GetRadius () const override

Public Member Functions inherited from itk::InterpolateImageFunction< TInputImage, double >
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override=0

OutputType	EvaluateAtIndex (const IndexType &index) const override

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

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 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, double >
static constexpr unsigned int	ImageDimension

Static Public Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, double >
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, double >
	InterpolateImageFunction ()=default

	~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
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::NearestNeighborInterpolateImageFunction< TInputImage, TCoordinate >::ConstPointer = SmartPointer<const Self>

Definition at line 49 of file itkNearestNeighborInterpolateImageFunction.h.

◆ ContinuousIndexType

template<typename TInputImage, typename TCoordinate = double>

ContinuousIndex Type.

◆ IndexType

template<typename TInputImage, typename TCoordinate = double>

Index Type.

◆ InputImageType

template<typename TInputImage, typename TCoordinate = double>

InputImageType type alias support

◆ OutputType

template<typename TInputImage, typename TCoordinate = double>

OutputType type alias support

◆ Pointer

template<typename TInputImage, typename TCoordinate = double>

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

Definition at line 48 of file itkNearestNeighborInterpolateImageFunction.h.

◆ Self

template<typename TInputImage, typename TCoordinate = double>

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

Standard class type aliases.

Definition at line 46 of file itkNearestNeighborInterpolateImageFunction.h.

◆ SizeType

template<typename TInputImage, typename TCoordinate = double>

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

Size type alias support

Definition at line 79 of file itkInterpolateImageFunction.h.

◆ Superclass

template<typename TInputImage, typename TCoordinate = double>

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

Definition at line 47 of file itkNearestNeighborInterpolateImageFunction.h.

Constructor & Destructor Documentation

◆ NearestNeighborInterpolateImageFunction()

template<typename TInputImage, typename TCoordinate = double>

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

protecteddefault

◆ ~NearestNeighborInterpolateImageFunction()

template<typename TInputImage, typename TCoordinate = double>

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

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage, typename TCoordinate = double>

virtual::itk::LightObject::Pointer itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordinate >::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::LightObject.

◆ EvaluateAtContinuousIndex()

template<typename TInputImage, typename TCoordinate = double>

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

inlineoverride

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.

Definition at line 84 of file itkNearestNeighborInterpolateImageFunction.h.

◆ GetNameOfClass()

template<typename TInputImage, typename TCoordinate = double>

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

overridevirtual

See also: LightObject::GetNameOfClass()

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

◆ GetRadius()

template<typename TInputImage, typename TCoordinate = double>

SizeType itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordinate >::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, double >.

Definition at line 93 of file itkNearestNeighborInterpolateImageFunction.h.

◆ New()

template<typename TInputImage, typename TCoordinate = double>

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

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage, typename TCoordinate = double>

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

Definition at line 102 of file itkNearestNeighborInterpolateImageFunction.h.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage, typename TCoordinate = double>

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

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ ContinuousIndexType

◆ IndexType

◆ InputImageType

◆ OutputType

◆ Pointer

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ NearestNeighborInterpolateImageFunction()

◆ ~NearestNeighborInterpolateImageFunction()

Member Function Documentation

◆ CreateAnother()

◆ EvaluateAtContinuousIndex()

◆ GetNameOfClass()

◆ GetRadius()

◆ New()

◆ PrintSelf()

Member Data Documentation

◆ ImageDimension