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

#include <itkVectorInterpolateImageFunction.h>

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

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

Detailed Description

template<typename TInputImage, typename TCoordRep = double>
class itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >

Base class for all vector image interpolaters.

VectorInterpolateImageFunction is the base for all ImageFunctions that interpolates image with vector pixel types. This function outputs a return value of type Vector<double,Dimension>.

This class is templated input image type and the coordinate representation type.

Warning

This hierarchy of functions work only for images with Vector-based pixel types. For scalar images use InterpolateImageFunction.

See Also

InterpolateImageFunction

Definition at line 46 of file itkVectorInterpolateImageFunction.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	ContinuousIndexType = typename Superclass::ContinuousIndexType
using	CoordRepType = TCoordRep
using	IndexType = typename Superclass::IndexType
using	InputImageType = typename Superclass::InputImageType
using	OutputType = typename Superclass::OutputType
using	PixelType = typename InputImageType::PixelType
using	Pointer = SmartPointer< Self >
using	PointType = typename Superclass::PointType
using	RealType = typename NumericTraits< ValueType >::RealType
using	Self = VectorInterpolateImageFunction
using	Superclass = ImageFunction< TInputImage, typename NumericTraits< typename TInputImage::PixelType >::RealType, TCoordRep >
using	ValueType = typename PixelType::ValueType
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
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
void	ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
void	ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
void	ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
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
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
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) 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 noexceptoverride
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
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Attributes
static constexpr unsigned int	Dimension = TInputImage::PixelType::Dimension
static constexpr unsigned int	ImageDimension = TInputImage::ImageDimension
Static Public Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
static constexpr unsigned int	ImageDimension
OutputType	EvaluateAtIndex (const IndexType &index) const override
	VectorInterpolateImageFunction ()=default
	~VectorInterpolateImageFunction () 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 flag)
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 ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~ImageFunction () override=default
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 ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~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 ()
Protected Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
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

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 68 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

ContinuousIndex type alias support

Definition at line 86 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::CoordRepType = TCoordRep

CoordRep type alias support

Definition at line 92 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

Index type alias support

Definition at line 83 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

InputImageType type alias support

Definition at line 74 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

Output type is RealType of TInputImage::PixelType.

Definition at line 89 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::PixelType = typename InputImageType::PixelType

Definition at line 75 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 67 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

Point type alias support

Definition at line 80 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::RealType = typename NumericTraits< ValueType >::RealType

Definition at line 77 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

Standard class type aliases.

Definition at line 62 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::Superclass = ImageFunction< TInputImage, typename NumericTraits< typename TInputImage::PixelType >::RealType, TCoordRep >

Definition at line 65 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::ValueType = typename PixelType::ValueType

Definition at line 76 of file itkVectorInterpolateImageFunction.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TCoordRep = double>

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

protecteddefault

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.

template<typename TInputImage , typename TCoordRep = double>

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

overrideprotecteddefault

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.

Member Function Documentation

template<typename TInputImage , typename TCoordRep = double>

OutputType itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType &  point ) const

inlineoverride

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 99 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

OutputType itk::VectorInterpolateImageFunction< 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::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >, itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >, and itk::VectorNearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >.

template<typename TInputImage , typename TCoordRep = double>

OutputType itk::VectorInterpolateImageFunction< 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 127 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

virtual const char* itk::VectorInterpolateImageFunction< 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::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >, itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >, and itk::VectorNearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >.

template<typename TInputImage , typename TCoordRep = double>

void itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

inlineoverrideprotectedvirtual

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.

Reimplemented from itk::Object.

Reimplemented in itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >, itk::VectorNearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, and itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >.

Definition at line 144 of file itkVectorInterpolateImageFunction.h.

Referenced by itk::VectorNearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >::PrintSelf().

Member Data Documentation

template<typename TInputImage , typename TCoordRep = double>

constexpr unsigned int itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::Dimension = TInputImage::PixelType::Dimension

static

Extract the vector dimension from the pixel template parameter.

Definition at line 56 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

static

Dimension underlying input image.

Definition at line 59 of file itkVectorInterpolateImageFunction.h.

---

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

• itkVectorInterpolateImageFunction.h