itk::LinearInterpolateImageFunction< TInputImage, TCoordinate > Class Template Reference

#include <itkLinearInterpolateImageFunction.h>

Detailed Description

template<typename TInputImage, typename TCoordinate = double>
class itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >

Linearly interpolate an image at specified positions.

LinearInterpolateImageFunction linearly interpolates image intensity at a non-integer pixel position. This class is templated over the input image type and the coordinate representation type (e.g. float or double).

This function works for N-dimensional images.

This function works for images with scalar and vector pixel types, and for images of type VectorImage.

See also

VectorLinearInterpolateImageFunction

ITK Sphinx Examples:

• All ITK Sphinx Examples

• Linearly Interpolate Position In Image

Examples

Examples/Filtering/ResampleImageFilter4.cxx, Examples/Filtering/ResampleImageFilter5.cxx, Examples/Filtering/ResampleImageFilter6.cxx, Examples/Filtering/ResampleImageFilter9.cxx, Examples/Filtering/ResampleVolumesToBeIsotropic.cxx, Examples/Filtering/SubsampleVolume.cxx, Examples/Filtering/WarpImageFilter1.cxx, Examples/RegistrationITKv4/BSplineWarping1.cxx, Examples/RegistrationITKv4/BSplineWarping2.cxx, Examples/RegistrationITKv4/DeformableRegistration10.cxx, Examples/RegistrationITKv4/DeformableRegistration13.cxx, Examples/RegistrationITKv4/DeformableRegistration14.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, Examples/RegistrationITKv4/DeformableRegistration16.cxx, Examples/RegistrationITKv4/DeformableRegistration17.cxx, Examples/RegistrationITKv4/DeformableRegistration3.cxx, Examples/RegistrationITKv4/DeformableRegistration5.cxx, Examples/RegistrationITKv4/DeformableRegistration9.cxx, Examples/RegistrationITKv4/ImageRegistration1.cxx, Examples/RegistrationITKv4/ImageRegistration14.cxx, Examples/RegistrationITKv4/ImageRegistration15.cxx, Examples/RegistrationITKv4/ImageRegistration16.cxx, Examples/RegistrationITKv4/ImageRegistration17.cxx, Examples/RegistrationITKv4/ImageRegistration18.cxx, Examples/RegistrationITKv4/ImageRegistration2.cxx, Examples/RegistrationITKv4/ImageRegistration20.cxx, Examples/RegistrationITKv4/ImageRegistrationHistogramPlotter.cxx, Examples/RegistrationITKv4/LandmarkWarping2.cxx, Examples/RegistrationITKv4/ModelToImageRegistration1.cxx, Examples/RegistrationITKv4/ModelToImageRegistration2.cxx, Examples/RegistrationITKv4/MultiResImageRegistration2.cxx, Examples/RegistrationITKv4/MultiResImageRegistration3.cxx, and Examples/RegistrationITKv4/ThinPlateSplineWarp.cxx.

Definition at line 51 of file itkLinearInterpolateImageFunction.h.

Inheritance diagram for itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >:

Collaboration diagram for itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >:

Classes
struct	Dispatch
struct	DispatchBase

Public Types
using	ConstPointer = SmartPointer<const Self>
typedef ContinuousIndex< TCoordinate, Self::ImageDimension >	ContinuousIndexType
typedef typename InputImageType::IndexType	IndexType
typedef TInputImage	InputImageType
using	InternalComputationType = typename ContinuousIndexType::ValueType
typedef TOutput	OutputType
using	Pointer = SmartPointer<Self>
using	RealType
using	Self = LinearInterpolateImageFunction
using	SizeType
using	Superclass = InterpolateImageFunction<TInputImage, TCoordinate>
Public Types inherited from itk::InterpolateImageFunction< TInputImage, double >
using	ConstPointer
typedef ContinuousIndex< double, Self::ImageDimension >	ContinuousIndexType
using	ContinuousIndexType
typedef typename InputImageType::IndexType	IndexType
using	IndexType
typedef typename InputImageType::IndexValueType	IndexValueType
using	IndexValueType
typedef TInputImage	InputImageType
using	InputImageType
typedef TOutput	OutputType
using	OutputType
using	Pointer
typedef Point< double, Self::ImageDimension >	PointType
using	PointType
using	RealType
using	Self
using	SizeType
using	Superclass
Public Types inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, double >
using	ConstPointer
using	ContinuousIndexType
using	CoordinateType
using	IndexType
using	IndexValueType
using	InputImageConstPointer
using	InputImageType
using	InputPixelType
using	OutputType
using	Pointer
using	PointType
using	Self
using	Superclass
Public Types inherited from itk::FunctionBase< Point< double, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
using	ConstPointer
using	InputType
using	OutputType
using	Pointer
using	Self
using	Superclass
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
const char *	GetNameOfClass () const override
SizeType	GetRadius () const override
Public Member Functions inherited from itk::InterpolateImageFunction< TInputImage, double >
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override=0
OutputType	EvaluateAtIndex (const IndexType &index) const override
OutputType	Evaluate (const PointType &point) 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
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
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
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 void	Delete ()
virtual int	GetReferenceCount () const
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 val)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::InterpolateImageFunction< TInputImage, double >
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
	LinearInterpolateImageFunction ()=default
void	PrintSelf (std::ostream &os, Indent indent) const override
	~LinearInterpolateImageFunction () override=default
Protected Member Functions inherited from itk::InterpolateImageFunction< TInputImage, double >
	InterpolateImageFunction ()=default
	~InterpolateImageFunction () override=default
Protected Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, double >
	ImageFunction ()
	~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	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
OutputType	EvaluateOptimized (const Dispatch< 0 > &, const ContinuousIndexType &) const
OutputType	EvaluateOptimized (const Dispatch< 1 > &, const ContinuousIndexType &index) const
OutputType	EvaluateOptimized (const Dispatch< 2 > &, const ContinuousIndexType &index) const
OutputType	EvaluateOptimized (const Dispatch< 3 > &, const ContinuousIndexType &index) const
OutputType	EvaluateOptimized (const DispatchBase &, const ContinuousIndexType &index) const
virtual OutputType	EvaluateUnoptimized (const ContinuousIndexType &index) const
template<typename RealTypeScalarRealType>
void	MakeZeroInitializer (const TInputImage *const inputImagePtr, RealTypeScalarRealType &tempZeros) const
template<typename RealTypeScalarRealType>
void	MakeZeroInitializer (const TInputImage *const inputImagePtr, VariableLengthVector< RealTypeScalarRealType > &tempZeros) const

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

using itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::ConstPointer = SmartPointer<const Self>

Definition at line 60 of file itkLinearInterpolateImageFunction.h.

ContinuousIndexType

template<typename TInputImage, typename TCoordinate = double>

ContinuousIndex Type.

IndexType

template<typename TInputImage, typename TCoordinate = double>

Index Type.

InputImageType

template<typename TInputImage, typename TCoordinate = double>

InputImageType type alias support

InternalComputationType

template<typename TInputImage, typename TCoordinate = double>

using itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::InternalComputationType = typename ContinuousIndexType::ValueType

Definition at line 91 of file itkLinearInterpolateImageFunction.h.

OutputType

template<typename TInputImage, typename TCoordinate = double>

OutputType type alias support

Pointer

template<typename TInputImage, typename TCoordinate = double>

using itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::Pointer = SmartPointer<Self>

Definition at line 59 of file itkLinearInterpolateImageFunction.h.

RealType

template<typename TInputImage, typename TCoordinate = double>

using itk::InterpolateImageFunction< TInputImage, TCoordinate >::RealType

RealType type alias support

Definition at line 85 of file itkInterpolateImageFunction.h.

Self

template<typename TInputImage, typename TCoordinate = double>

using itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::Self = LinearInterpolateImageFunction

Standard class type aliases.

Definition at line 57 of file itkLinearInterpolateImageFunction.h.

SizeType

template<typename TInputImage, typename TCoordinate = double>

using itk::InterpolateImageFunction< TInputImage, TCoordinate >::SizeType

Size type alias support

Definition at line 79 of file itkInterpolateImageFunction.h.

Superclass

template<typename TInputImage, typename TCoordinate = double>

using itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::Superclass = InterpolateImageFunction<TInputImage, TCoordinate>

Definition at line 58 of file itkLinearInterpolateImageFunction.h.

Constructor & Destructor Documentation

LinearInterpolateImageFunction()

template<typename TInputImage, typename TCoordinate = double>

itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::LinearInterpolateImageFunction ( )

protecteddefault

~LinearInterpolateImageFunction()

template<typename TInputImage, typename TCoordinate = double>

itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::~LinearInterpolateImageFunction ( )

overrideprotecteddefault

Member Function Documentation

CreateAnother()

template<typename TInputImage, typename TCoordinate = double>

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

EvaluateAtContinuousIndex()

template<typename TInputImage, typename TCoordinate = double>

OutputType itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::EvaluateAtContinuousIndex ( const ContinuousIndexType & index ) const

inlineoverride

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.

Definition at line 102 of file itkLinearInterpolateImageFunction.h.

EvaluateOptimized() [1/5]

template<typename TInputImage, typename TCoordinate = double>

OutputType itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::EvaluateOptimized ( const Dispatch< 0 > & , const ContinuousIndexType &  ) const

inlineprivate

Definition at line 127 of file itkLinearInterpolateImageFunction.h.

EvaluateOptimized() [2/5]

template<typename TInputImage, typename TCoordinate = double>

OutputType itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::EvaluateOptimized ( const Dispatch< 1 > & , const ContinuousIndexType & index ) const

inlineprivate

Definition at line 133 of file itkLinearInterpolateImageFunction.h.

EvaluateOptimized() [3/5]

template<typename TInputImage, typename TCoordinate = double>

OutputType itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::EvaluateOptimized ( const Dispatch< 2 > & , const ContinuousIndexType & index ) const

inlineprivate

Definition at line 158 of file itkLinearInterpolateImageFunction.h.

EvaluateOptimized() [4/5]

template<typename TInputImage, typename TCoordinate = double>

OutputType itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::EvaluateOptimized ( const Dispatch< 3 > & , const ContinuousIndexType & index ) const

inlineprivate

Definition at line 227 of file itkLinearInterpolateImageFunction.h.

EvaluateOptimized() [5/5]

template<typename TInputImage, typename TCoordinate = double>

OutputType itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::EvaluateOptimized ( const DispatchBase & , const ContinuousIndexType & index ) const

inlineprivate

Definition at line 474 of file itkLinearInterpolateImageFunction.h.

EvaluateUnoptimized()

template<typename TInputImage, typename TCoordinate = double>

virtual OutputType itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::EvaluateUnoptimized ( const ContinuousIndexType & index ) const

inlineprivatevirtual

Evaluate interpolator at image index position.

GetNameOfClass()

template<typename TInputImage, typename TCoordinate = double>

const char * itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::GetNameOfClass ( ) const

overridevirtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::InterpolateImageFunction< TInputImage, double >.

GetRadius()

template<typename TInputImage, typename TCoordinate = double>

SizeType itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::GetRadius ( ) const

inlineoverridevirtual

Get the radius required for interpolation.

This defines the number of surrounding pixels required to interpolate at a given point.

Implements itk::InterpolateImageFunction< TInputImage, double >.

Definition at line 108 of file itkLinearInterpolateImageFunction.h.

MakeZeroInitializer() [1/2]

template<typename TInputImage, typename TCoordinate = double>

template<typename RealTypeScalarRealType>

void itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::MakeZeroInitializer ( const TInputImage *const inputImagePtr, RealTypeScalarRealType & tempZeros ) const

inlineprivate

Definition at line 500 of file itkLinearInterpolateImageFunction.h.

MakeZeroInitializer() [2/2]

template<typename TInputImage, typename TCoordinate = double>

template<typename RealTypeScalarRealType>

void itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::MakeZeroInitializer ( const TInputImage *const inputImagePtr, VariableLengthVector< RealTypeScalarRealType > & tempZeros ) const

inlineprivate

A method to generically set all components to zero.

Definition at line 487 of file itkLinearInterpolateImageFunction.h.

New()

template<typename TInputImage, typename TCoordinate = double>

static Pointer itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::New ( )

static

Method for creation through the object factory.

PrintSelf()

template<typename TInputImage, typename TCoordinate = double>

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

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::InterpolateImageFunction< TInputImage, double >.

Member Data Documentation

ImageDimension

template<typename TInputImage, typename TCoordinate = double>

unsigned int itk::LinearInterpolateImageFunction< TInputImage, TCoordinate >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Dimension underlying input image.

Definition at line 81 of file itkLinearInterpolateImageFunction.h.

---

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

• itkLinearInterpolateImageFunction.h