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

#include <itkVectorLinearInterpolateImageFunction.h>

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

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

Detailed Description

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

Linearly interpolate a vector image at specified positions.

VectorLinearInterpolateImageFunction linearly interpolates a vector image intensity non-integer pixel position. This class is templated over the input image type and the coordinate representation type.

This function works for N-dimensional images.

Warning

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

Examples:

Examples/Filtering/ResampleImageFilter6.cxx, and Examples/Filtering/ResampleImageFilter9.cxx.

Definition at line 43 of file itkVectorLinearInterpolateImageFunction.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	ContinuousIndexType = typename Superclass::ContinuousIndexType
using	IndexType = typename Superclass::IndexType
using	InputImageType = typename Superclass::InputImageType
using	InternalComputationType = typename ContinuousIndexType::ValueType
using	OutputType = typename Superclass::OutputType
using	PixelType = typename Superclass::PixelType
using	Pointer = SmartPointer< Self >
using	RealType = typename Superclass::RealType
using	Self = VectorLinearInterpolateImageFunction
using	Superclass = VectorInterpolateImageFunction< TInputImage, TCoordRep >
using	ValueType = typename Superclass::ValueType
Public Types inherited from itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >
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
virtual ::itk::LightObject::Pointer	CreateAnother () const
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >
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, 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
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 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 flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	Dimension = Superclass::Dimension
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >
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

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const override
	VectorLinearInterpolateImageFunction ()=default
	~VectorLinearInterpolateImageFunction () override=default
Protected Member Functions inherited from itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >
	VectorInterpolateImageFunction ()=default
	~VectorInterpolateImageFunction () override=default
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 ()

Static Private Attributes
static const unsigned long	m_Neighbors

Additional Inherited Members
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::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >::ConstPointer = SmartPointer< const Self >

Definition at line 53 of file itkVectorLinearInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

ContinuousIndex type alias support

Definition at line 78 of file itkVectorLinearInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

Index type alias support

Definition at line 75 of file itkVectorLinearInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

InputImageType type alias support

Definition at line 63 of file itkVectorLinearInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

using itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >::InternalComputationType = typename ContinuousIndexType::ValueType

Definition at line 79 of file itkVectorLinearInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

Output type is Vector<double,Dimension>

Definition at line 82 of file itkVectorLinearInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

using itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >::PixelType = typename Superclass::PixelType

Definition at line 64 of file itkVectorLinearInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 52 of file itkVectorLinearInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

using itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >::RealType = typename Superclass::RealType

Definition at line 66 of file itkVectorLinearInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

Standard class type aliases.

Definition at line 50 of file itkVectorLinearInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 51 of file itkVectorLinearInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

using itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >::ValueType = typename Superclass::ValueType

Definition at line 65 of file itkVectorLinearInterpolateImageFunction.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TCoordRep = double>

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

protecteddefault

template<typename TInputImage , typename TCoordRep = double>

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

overrideprotecteddefault

Member Function Documentation

template<typename TInputImage , typename TCoordRep = double>

virtual::itk::LightObject::Pointer itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >::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.

template<typename TInputImage , typename TCoordRep = double>

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

template<typename TInputImage , typename TCoordRep = double>

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

virtual

Run-time type information (and related methods).

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

template<typename TInputImage , typename TCoordRep = double>

static Pointer itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >::New ( )

static

Method for creation through the object factory.

template<typename TInputImage , typename TCoordRep = double>

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

overrideprotectedvirtual

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::VectorInterpolateImageFunction< TInputImage, TCoordRep >.

Member Data Documentation

template<typename TInputImage , typename TCoordRep = double>

constexpr unsigned int itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >::Dimension = Superclass::Dimension

static

Grab the vector dimension from the superclass.

Definition at line 69 of file itkVectorLinearInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

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

static

Dimension underlying input image.

Definition at line 72 of file itkVectorLinearInterpolateImageFunction.h.

template<typename TInputImage , typename TCoordRep = double>

const unsigned long itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >::m_Neighbors

staticprivate

Number of neighbors used in the interpolation

Definition at line 102 of file itkVectorLinearInterpolateImageFunction.h.

---

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

• itkVectorLinearInterpolateImageFunction.h