#include <itkVectorLinearInterpolateImageFunction.h>

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.

Definition at line 43 of file itkVectorLinearInterpolateImageFunction.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InternalComputationType = typename ContinuousIndexType::ValueType

using	Pointer = SmartPointer< Self >

using	Self = VectorLinearInterpolateImageFunction

using	Superclass = VectorInterpolateImageFunction< TInputImage, TCoordRep >

Public Types inherited from itk::VectorInterpolateImageFunction< TInputImage, double >
using	ConstPointer = SmartPointer< const Self >

using	CoordRepType = double

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

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

const char *	GetNameOfClass () const override

Public Member Functions inherited from itk::VectorInterpolateImageFunction< TInputImage, double >
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 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	Dimension = Superclass::Dimension

static constexpr unsigned int	ImageDimension = Superclass::ImageDimension

Static Public Attributes inherited from itk::VectorInterpolateImageFunction< TInputImage, double >
static constexpr unsigned int	Dimension

static constexpr unsigned int	ImageDimension

Static Public Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, double >
static constexpr unsigned int	ImageDimension

Protected Member Functions
	VectorLinearInterpolateImageFunction ()=default

	~VectorLinearInterpolateImageFunction () override=default

Protected Member Functions inherited from itk::VectorInterpolateImageFunction< TInputImage, double >
	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 ()

Static Private Attributes
static const unsigned long	m_Neighbors

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

Definition at line 53 of file itkVectorLinearInterpolateImageFunction.h.

◆ InternalComputationType

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 78 of file itkVectorLinearInterpolateImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 52 of file itkVectorLinearInterpolateImageFunction.h.

◆ Self

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.

◆ Superclass

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 51 of file itkVectorLinearInterpolateImageFunction.h.

Constructor & Destructor Documentation

◆ VectorLinearInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double>

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

protecteddefault

◆ ~VectorLinearInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double>

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

overrideprotecteddefault

Member Function Documentation

◆ EvaluateAtContinuousIndex()

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, double >.

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordRep = double>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ New()

template<typename TInputImage , typename TCoordRep = double>

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

static

Method for creation through the object factory.

Member Data Documentation

◆ Dimension

template<typename TInputImage , typename TCoordRep = double>

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

staticconstexpr

Grab the vector dimension from the superclass.

Definition at line 68 of file itkVectorLinearInterpolateImageFunction.h.

◆ ImageDimension

template<typename TInputImage , typename TCoordRep = double>

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

staticconstexpr

Dimension underlying input image.

Definition at line 71 of file itkVectorLinearInterpolateImageFunction.h.

◆ m_Neighbors

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 100 of file itkVectorLinearInterpolateImageFunction.h.

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

itkVectorLinearInterpolateImageFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ InternalComputationType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ VectorLinearInterpolateImageFunction()

◆ ~VectorLinearInterpolateImageFunction()

Member Function Documentation

◆ EvaluateAtContinuousIndex()

◆ GetNameOfClass()

◆ New()

Member Data Documentation

◆ Dimension

◆ ImageDimension

◆ m_Neighbors