#include <itkVectorInterpolateImageFunction.h>

Detailed Description

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

Base class for all vector image interpolators.

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

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	CoordRepType = TCoordRep

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, TCoordRep >

using	ValueType = typename PixelType::ValueType

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

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

using	CoordRepType = double

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

using	Self = ImageFunction

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

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

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

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

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

Protected Member Functions
	VectorInterpolateImageFunction ()=default

	~VectorInterpolateImageFunction () override=default

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

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

	~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	PrintSelf (std::ostream &os, Indent indent) const

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

virtual	~LightObject ()

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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

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 TCoordRep = double>

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

Definition at line 65 of file itkVectorInterpolateImageFunction.h.

◆ CoordRepType

template<typename TInputImage , typename TCoordRep = double>

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

CoordRep type alias support

Definition at line 89 of file itkVectorInterpolateImageFunction.h.

◆ PixelType

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 72 of file itkVectorInterpolateImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 64 of file itkVectorInterpolateImageFunction.h.

◆ RealType

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 74 of file itkVectorInterpolateImageFunction.h.

◆ Self

template<typename TInputImage , typename TCoordRep = double>

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

Standard class type aliases.

Definition at line 60 of file itkVectorInterpolateImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 61 of file itkVectorInterpolateImageFunction.h.

◆ ValueType

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 73 of file itkVectorInterpolateImageFunction.h.

Constructor & Destructor Documentation

◆ VectorInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double>

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

protecteddefault

◆ ~VectorInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double>

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

overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TInputImage , typename TCoordRep = double>

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

inlineoverridevirtual

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::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, double >.

Definition at line 97 of file itkVectorInterpolateImageFunction.h.

References itk::point().

◆ EvaluateAtContinuousIndex()

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.

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

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

◆ EvaluateAtIndex()

template<typename TInputImage , typename TCoordRep = double>

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

inlineoverridevirtual

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.

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

Definition at line 126 of file itkVectorInterpolateImageFunction.h.

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordRep = double>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

Member Data Documentation

◆ Dimension

template<typename TInputImage , typename TCoordRep = double>

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

staticconstexpr

Extract the vector dimension from the pixel template parameter.

Definition at line 54 of file itkVectorInterpolateImageFunction.h.

◆ ImageDimension

template<typename TInputImage , typename TCoordRep = double>

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

staticconstexpr

Dimension underlying input image.

Definition at line 57 of file itkVectorInterpolateImageFunction.h.

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

itkVectorInterpolateImageFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ CoordRepType

◆ PixelType

◆ Pointer

◆ RealType

◆ Self

◆ Superclass

◆ ValueType

Constructor & Destructor Documentation

◆ VectorInterpolateImageFunction()

◆ ~VectorInterpolateImageFunction()

Member Function Documentation

◆ Evaluate()

◆ EvaluateAtContinuousIndex()

◆ EvaluateAtIndex()

◆ GetNameOfClass()

Member Data Documentation

◆ Dimension

◆ ImageDimension