#include <itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h>

Detailed Description

template<typename TInputImage, typename TCoordRep = float>
class itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >

Linearly interpolate or NN extrapolate a vector image at specified positions.

VectorLinearInterpolateNearestNeighborExtrapolateImageFunction linearly interpolates (or NN extrapolates) a vector image intensity non-integer pixel position. This class is templated over the input image type and the coordinate representation type.

This class is designed to work as a VectorInterpolateImageFunction, hence the IsInsideBuffer(PointType p) is overridden to always answer true

This function works for N-dimensional images.

Author: Tom Vercauteren, INRIA & Mauna Kea Technologies

Warning: This function work only for Vector images. For scalar images use LinearInterpolateImageFunction.

This paper was contributed in the Insight Journal paper: https://doi.org/10.54294/ux2obj

Definition at line 54 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = VectorLinearInterpolateNearestNeighborExtrapolateImageFunction

using	Superclass = VectorInterpolateImageFunction< TInputImage, TCoordRep >

Public Types inherited from itk::VectorInterpolateImageFunction< TInputImage, float >
using	ConstPointer = SmartPointer< const Self >

using	CoordRepType = float

using	PixelType = typename InputImageType::PixelType

using	Pointer = SmartPointer< Self >

using	RealType = typename NumericTraits< ValueType >::RealType

using	Self = VectorInterpolateImageFunction

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

using	ValueType = typename PixelType::ValueType

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

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

using	CoordRepType = float

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< float, Self::ImageDimension >

using	Self = ImageFunction

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

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

using	InputType = Point< float, 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

OutputType	EvaluateAtIndex (const IndexType &index) const override

const char *	GetNameOfClass () const override

bool	IsInsideBuffer (const ContinuousIndexType &) const override

bool	IsInsideBuffer (const IndexType &) const override

bool	IsInsideBuffer (const PointType &) const override

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

const char *	GetNameOfClass () const override

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, float >
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 NumericTraits< TInputImage::PixelType >::RealType	EvaluateAtIndex (const IndexType &index) const=0

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)

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

virtual OutputType	Evaluate (const InputType &input) const=0

const char *	GetNameOfClass () const override

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 Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

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::VectorInterpolateImageFunction< TInputImage, float >
static constexpr unsigned int	Dimension

static constexpr unsigned int	ImageDimension

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

Protected Member Functions
	VectorLinearInterpolateNearestNeighborExtrapolateImageFunction ()=default

	~VectorLinearInterpolateNearestNeighborExtrapolateImageFunction () override=default

Protected Member Functions inherited from itk::VectorInterpolateImageFunction< TInputImage, float >
	VectorInterpolateImageFunction ()=default

	~VectorInterpolateImageFunction () override=default

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

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

	~ImageFunction () override=default

Protected Member Functions inherited from itk::FunctionBase< Point< float, 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	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Static Private Attributes
static const unsigned int	m_Neighbors

Additional Inherited Members
Protected Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, float >
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 = float>

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

Definition at line 64 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordRep = float>

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

Definition at line 63 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

◆ Self

template<typename TInputImage , typename TCoordRep = float>

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

Standard class type aliases.

Definition at line 61 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordRep = float>

using itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::Superclass = VectorInterpolateImageFunction<TInputImage, TCoordRep>

Definition at line 62 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

Constructor & Destructor Documentation

◆ VectorLinearInterpolateNearestNeighborExtrapolateImageFunction()

template<typename TInputImage , typename TCoordRep = float>

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

protecteddefault

◆ ~VectorLinearInterpolateNearestNeighborExtrapolateImageFunction()

template<typename TInputImage , typename TCoordRep = float>

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

overrideprotecteddefault

Member Function Documentation

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordRep = float>

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

overridevirtual

Evaluate the function at a ContinuousIndex position

Returns the linearly interpolated image intensity at a specified point position. If the point does not lie within the image buffer a nearest neighbor interpolation is done.

Implements itk::VectorInterpolateImageFunction< TInputImage, float >.

◆ EvaluateAtIndex()

template<typename TInputImage , typename TCoordRep = float>

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

overridevirtual

Evaluate the function at an index position

Simply returns the image value at the specified index position. If the index does not lie within the image buffer a nearest neighbor interpolation is done.

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

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordRep = float>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ IsInsideBuffer() [1/3]

template<typename TInputImage , typename TCoordRep = float>

bool itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::IsInsideBuffer ( const ContinuousIndexType & ) const