itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordinate > Class Template Reference

#include <itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h>

Detailed Description

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

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

Collaboration diagram for itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< 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>
typedef Point< TCoordinate, Self::ImageDimension >	PointType
using	Self = VectorLinearInterpolateNearestNeighborExtrapolateImageFunction
using	Superclass = VectorInterpolateImageFunction<TInputImage, TCoordinate>
Public Types inherited from itk::VectorInterpolateImageFunction< TInputImage, float >
using	ConstPointer
typedef ContinuousIndex< float, Self::ImageDimension >	ContinuousIndexType
using	ContinuousIndexType
using	CoordinateType
typedef typename InputImageType::IndexType	IndexType
using	IndexType
typedef TInputImage	InputImageType
using	InputImageType
typedef TOutput	OutputType
using	OutputType
using	PixelType
using	Pointer
typedef Point< float, Self::ImageDimension >	PointType
using	PointType
using	RealType
using	Self
using	Superclass
using	ValueType
Public Types inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, float >
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< float, 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
OutputType	EvaluateAtIndex (const IndexType &index) const override
virtual const char *	GetNameOfClass () const
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	Evaluate (const PointType &point) const override
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override=0
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
void	ConvertPointToNearestIndex (const PointType &point, IndexType &index) 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 bool	IsInsideBuffer (const ContinuousIndexType &index) const
virtual bool	IsInsideBuffer (const PointType &point) const
virtual void	SetInputImage (const InputImageType *ptr)
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
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) 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::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	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 TCoordinate = float>

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

Definition at line 64 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

ContinuousIndexType

template<typename TInputImage, typename TCoordinate = float>

ContinuousIndex Type.

IndexType

template<typename TInputImage, typename TCoordinate = float>

Index Type.

InputImageType

template<typename TInputImage, typename TCoordinate = float>

InputImageType type alias support

OutputType

template<typename TInputImage, typename TCoordinate = float>

OutputType type alias support

Pointer

template<typename TInputImage, typename TCoordinate = float>

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

Definition at line 63 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

PointType

template<typename TInputImage, typename TCoordinate = float>

Point Type.

Self

template<typename TInputImage, typename TCoordinate = float>

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

Standard class type aliases.

Definition at line 61 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

Superclass

template<typename TInputImage, typename TCoordinate = float>

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

Definition at line 62 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

Constructor & Destructor Documentation

VectorLinearInterpolateNearestNeighborExtrapolateImageFunction()

template<typename TInputImage, typename TCoordinate = float>

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

protecteddefault

~VectorLinearInterpolateNearestNeighborExtrapolateImageFunction()

template<typename TInputImage, typename TCoordinate = float>

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

overrideprotecteddefault

Member Function Documentation

CreateAnother()

template<typename TInputImage, typename TCoordinate = float>

virtual::itk::LightObject::Pointer itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< 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::Object.

EvaluateAtContinuousIndex()

template<typename TInputImage, typename TCoordinate = float>

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

override

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.

EvaluateAtIndex()

template<typename TInputImage, typename TCoordinate = float>

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

Reimplemented from itk::VectorInterpolateImageFunction< TInputImage, float >.

GetNameOfClass()

template<typename TInputImage, typename TCoordinate = float>

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

virtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::VectorInterpolateImageFunction< TInputImage, float >.

IsInsideBuffer() [1/3]

template<typename TInputImage, typename TCoordinate = float>

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

inlineoverride

Should check if a continuous index is inside the image buffer, however we require that it answers true to use the extrapolation possibility.

Definition at line 115 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

IsInsideBuffer() [2/3]

template<typename TInputImage, typename TCoordinate = float>

bool itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordinate >::IsInsideBuffer ( const IndexType & ) const

inlineoverridevirtual

Should check if an index is inside the image buffer, however we require that it answers true to use the extrapolation possibility.

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

Definition at line 99 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

IsInsideBuffer() [3/3]

template<typename TInputImage, typename TCoordinate = float>

bool itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordinate >::IsInsideBuffer ( const PointType & ) const

inlineoverride

Should check if a point is inside the image buffer, however we require that it answers true to use the extrapolation possibility.

Definition at line 107 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

New()

template<typename TInputImage, typename TCoordinate = float>

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

static

Method for creation through the object factory.

Member Data Documentation

ImageDimension

template<typename TInputImage, typename TCoordinate = float>

unsigned int itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordinate >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Grab the vector dimension from the superclass. Dimension underlying input image.

Definition at line 84 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

m_Neighbors

template<typename TInputImage, typename TCoordinate = float>

const unsigned int itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordinate >::m_Neighbors

staticprivate

Number of neighbors used in the interpolation

Definition at line 142 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

---

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

• itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h