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
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::ContinuousIndexType	ContinuousIndexType
typedef TCoordRep	CoordRepType
typedef Superclass::IndexType	IndexType
typedef Superclass::InputImageType	InputImageType
typedef Superclass::OutputType	OutputType
typedef InputImageType::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointType	PointType
typedef NumericTraits < ValueType >::RealType	RealType
typedef VectorInterpolateImageFunction	Self
typedef ImageFunction < TInputImage, typename NumericTraits< typename TInputImage::PixelType > ::RealType, TCoordRep >	Superclass
typedef PixelType::ValueType	ValueType
Public Types inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
typedef SmartPointer< const Self >	ConstPointer
typedef ContinuousIndex < TCoordRep, itkGetStaticConstMacro(ImageDimension) >	ContinuousIndexType
typedef TCoordRep	CoordRepType
typedef InputImageType::IndexType	IndexType
typedef InputImageType::IndexValueType	IndexValueType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef TInputImage	InputImageType
typedef InputImageType::PixelType	InputPixelType
typedef NumericTraits < TInputImage::PixelType > ::RealType	OutputType
typedef SmartPointer< Self >	Pointer
typedef Point< TCoordRep, itkGetStaticConstMacro(ImageDimension) >	PointType
typedef ImageFunction	Self
typedef FunctionBase< Point < TCoordRep, itkGetStaticConstMacro(ImageDimension) > , NumericTraits < TInputImage::PixelType > ::RealType >	Superclass
Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
typedef SmartPointer< const Self >	ConstPointer
typedef Point< TCoordRep, TInputImage::ImageDimension >	InputType
typedef NumericTraits < TInputImage::PixelType > ::RealType	OutputType
typedef SmartPointer< Self >	Pointer
typedef FunctionBase	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual OutputType	Evaluate (const PointType &point) const override
virtual 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
virtual 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::FunctionBase< Point< TCoordRep, 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 *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual 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
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
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 const unsigned int	Dimension = TInputImage::PixelType::Dimension
static const unsigned int	ImageDimension = TInputImage::ImageDimension
Static Public Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
static const unsigned int	ImageDimension
virtual OutputType	EvaluateAtIndex (const IndexType &index) const override
	VectorInterpolateImageFunction ()
	~VectorInterpolateImageFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	VectorInterpolateImageFunction (const Self &) ITK_DELETE_FUNCTION
void	operator= (const Self &) ITK_DELETE_FUNCTION

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 ()
Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
	FunctionBase ()
	~FunctionBase ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 68 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef Superclass::ContinuousIndexType itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::ContinuousIndexType

ContinuousIndex typedef support.

Definition at line 86 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef TCoordRep itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::CoordRepType

CoordRep typedef support.

Definition at line 92 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef Superclass::IndexType itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::IndexType

Index typedef support.

Definition at line 83 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef Superclass::InputImageType itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::InputImageType

InputImageType typedef support.

Definition at line 71 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef Superclass::OutputType itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::OutputType

Output type is RealType of TInputImage::PixelType.

Definition at line 89 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef InputImageType::PixelType itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::PixelType

Definition at line 75 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef SmartPointer< Self > itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::Pointer

Definition at line 67 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef Superclass::PointType itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::PointType

Point typedef support.

Definition at line 80 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef NumericTraits< ValueType >::RealType itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::RealType

Definition at line 77 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef VectorInterpolateImageFunction itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::Self

Standard class typedefs.

Definition at line 62 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 65 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

typedef PixelType::ValueType itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::ValueType

Definition at line 76 of file itkVectorInterpolateImageFunction.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TCoordRep = double>

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

inlineprotected

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

template<typename TInputImage , typename TCoordRep = double>

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

inlineprotected

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

template<typename TInputImage , typename TCoordRep = double>

itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::VectorInterpolateImageFunction ( const Self &  )

private

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>

virtual 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.

Definition at line 99 of file itkVectorInterpolateImageFunction.h.

References itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex(), and itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >::GetInputImage().

template<typename TInputImage , typename TCoordRep = double>

virtual 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 >.

Referenced by itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::Evaluate().

template<typename TInputImage , typename TCoordRep = double>

virtual 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.

Reimplemented in itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >.

Definition at line 127 of file itkVectorInterpolateImageFunction.h.

References itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >::GetInputImage().

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 >::operator= ( const Self &  )

private

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>

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.

References itk::ImageFunction< TInputImage, TOutput, TCoordRep >::PrintSelf().

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

Member Data Documentation

template<typename TInputImage , typename TCoordRep = double>

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

static

Extract the vector dimension from the pixel template parameter.

Definition at line 55 of file itkVectorInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

const 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