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

#include <itkLinearInterpolateImageFunction.h>

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

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

Classes
struct	Dispatch
struct	DispatchBase

Public Types
using	ConstPointer = SmartPointer< const Self >
using	ContinuousIndexType = typename Superclass::ContinuousIndexType
using	IndexType = typename Superclass::IndexType
using	InputImageType = typename Superclass::InputImageType
using	InputPixelType = typename Superclass::InputPixelType
using	InternalComputationType = typename ContinuousIndexType::ValueType
using	OutputType = typename Superclass::OutputType
using	Pointer = SmartPointer< Self >
using	RealType = typename Superclass::RealType
using	Self = LinearInterpolateImageFunction
using	SizeType = typename Superclass::SizeType
using	Superclass = InterpolateImageFunction< TInputImage, TCoordRep >
Public Types inherited from itk::InterpolateImageFunction< TInputImage, TCoordRep >
using	ConstPointer = SmartPointer< const Self >
using	ContinuousIndexType = typename Superclass::ContinuousIndexType
using	IndexType = typename Superclass::IndexType
using	IndexValueType = typename Superclass::IndexValueType
using	InputImageType = typename Superclass::InputImageType
using	OutputType = typename Superclass::OutputType
using	Pointer = SmartPointer< Self >
using	PointType = typename Superclass::PointType
using	RealType = typename NumericTraits< typename TInputImage::PixelType >::RealType
using	Self = InterpolateImageFunction
using	SizeType = typename InputImageType::SizeType
using	Superclass = ImageFunction< TInputImage, typename NumericTraits< typename TInputImage::PixelType >::RealType, TCoordRep >
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
SizeType	GetRadius () const override
Public Member Functions inherited from itk::InterpolateImageFunction< 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 >
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
const InputImageType *	GetInputImage () 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
void	ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
void	ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
virtual const IndexType &	GetStartIndex () const
virtual const IndexType &	GetEndIndex () const
virtual const ContinuousIndexType &	GetStartContinuousIndex () const
virtual const ContinuousIndexType &	GetEndContinuousIndex () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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 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, TCoordRep >
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
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, TCoordRep >
	InterpolateImageFunction ()=default
	~InterpolateImageFunction () override=default
Protected Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
	ImageFunction ()
	~ImageFunction () override=default
void	PrintSelf (std::ostream &os, Indent indent) const override
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 ()
	~Object () override
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
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, VariableLengthVector< RealTypeScalarRealType > &tempZeros) const
template<typename RealTypeScalarRealType >
void	MakeZeroInitializer (const TInputImage *const, RealTypeScalarRealType &tempZeros) const

Additional Inherited Members
Protected Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
InputImageConstPointer	m_Image
IndexType	m_StartIndex
IndexType	m_EndIndex
ContinuousIndexType	m_StartContinuousIndex
ContinuousIndexType	m_EndContinuousIndex
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

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

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, Examples/RegistrationITKv4/ThinPlateSplineWarp.cxx, SphinxExamples/src/Core/Transform/GlobalRegistrationTwoImagesAffine/Code.cxx, SphinxExamples/src/Core/Transform/GlobalRegistrationTwoImagesBSpline/Code.cxx, SphinxExamples/src/Core/Transform/MutualInformationAffine/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/ResampleAnImage/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/ResampleAVectorImage/Code.cxx, SphinxExamples/src/Filtering/ImageGrid/WarpAnImageUsingADeformationField/Code.cxx, SphinxExamples/src/IO/GDCM/ResampleDICOMSeries/Code.cxx, SphinxExamples/src/Registration/Common/ComputeMeanSquareBetweenTwoImages/Code.cxx, SphinxExamples/src/Registration/Common/GlobalRegistrationOfTwoImages/Code.cxx, SphinxExamples/src/Registration/Common/MutualInformation/Code.cxx, SphinxExamples/src/Registration/Common/PerformMultiModalityRegistrationWithMutualInformation/Code.cxx, and SphinxExamples/src/Registration/Common/WatchRegistration/Code.cxx.

Definition at line 50 of file itkLinearInterpolateImageFunction.h.

Member Typedef Documentation

ConstPointer

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 59 of file itkLinearInterpolateImageFunction.h.

ContinuousIndexType

template<typename TInputImage , typename TCoordRep = double>

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

ContinuousIndex type alias support

Definition at line 89 of file itkLinearInterpolateImageFunction.h.

IndexType

template<typename TInputImage , typename TCoordRep = double>

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

Index type alias support

Definition at line 83 of file itkLinearInterpolateImageFunction.h.

InputImageType

template<typename TInputImage , typename TCoordRep = double>

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

InputImageType type alias support

Definition at line 71 of file itkLinearInterpolateImageFunction.h.

InputPixelType

template<typename TInputImage , typename TCoordRep = double>

using itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::InputPixelType = typename Superclass::InputPixelType

InputPixelType type alias support

Definition at line 74 of file itkLinearInterpolateImageFunction.h.

InternalComputationType

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 90 of file itkLinearInterpolateImageFunction.h.

OutputType

template<typename TInputImage , typename TCoordRep = double>

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

OutputType type alias support

Definition at line 68 of file itkLinearInterpolateImageFunction.h.

Pointer

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 58 of file itkLinearInterpolateImageFunction.h.

RealType

template<typename TInputImage , typename TCoordRep = double>

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

RealType type alias support

Definition at line 77 of file itkLinearInterpolateImageFunction.h.

Self

template<typename TInputImage , typename TCoordRep = double>

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

Standard class type aliases.

Definition at line 56 of file itkLinearInterpolateImageFunction.h.

SizeType

template<typename TInputImage , typename TCoordRep = double>

using itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::SizeType = typename Superclass::SizeType

Size type alias support

Definition at line 86 of file itkLinearInterpolateImageFunction.h.

Superclass

template<typename TInputImage , typename TCoordRep = double>

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

Definition at line 57 of file itkLinearInterpolateImageFunction.h.

Constructor & Destructor Documentation

LinearInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double>

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

protecteddefault

~LinearInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double>

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

overrideprotecteddefault

Member Function Documentation

CreateAnother()

template<typename TInputImage , typename TCoordRep = double>

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

EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordRep = double>

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

inlineoverridevirtual

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

Definition at line 101 of file itkLinearInterpolateImageFunction.h.

EvaluateOptimized() [1/5]

template<typename TInputImage , typename TCoordRep = double>

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

inlineprivate

Definition at line 126 of file itkLinearInterpolateImageFunction.h.

EvaluateOptimized() [2/5]

template<typename TInputImage , typename TCoordRep = double>

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

inlineprivate

Definition at line 132 of file itkLinearInterpolateImageFunction.h.

EvaluateOptimized() [3/5]

template<typename TInputImage , typename TCoordRep = double>

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

inlineprivate

Definition at line 161 of file itkLinearInterpolateImageFunction.h.

EvaluateOptimized() [4/5]

template<typename TInputImage , typename TCoordRep = double>

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

inlineprivate

Definition at line 238 of file itkLinearInterpolateImageFunction.h.

EvaluateOptimized() [5/5]

template<typename TInputImage , typename TCoordRep = double>

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

inlineprivate

Definition at line 499 of file itkLinearInterpolateImageFunction.h.

EvaluateUnoptimized()

template<typename TInputImage , typename TCoordRep = double>

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

inlineprivatevirtual

Evaluate interpolator at image index position.

GetNameOfClass()

template<typename TInputImage , typename TCoordRep = double>

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

virtual

Run-time type information (and related methods).

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

GetRadius()

template<typename TInputImage , typename TCoordRep = double>

SizeType itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >::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, TCoordRep >.

Definition at line 107 of file itkLinearInterpolateImageFunction.h.

MakeZeroInitializer() [1/2]

template<typename TInputImage , typename TCoordRep = double>

template<typename RealTypeScalarRealType >

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

inlineprivate

A method to generically set all components to zero.

Definition at line 512 of file itkLinearInterpolateImageFunction.h.

References itk::Index< VDimension >::Fill(), itk::VariableLengthVector< TValue >::Fill(), and itk::VariableLengthVector< TValue >::SetSize().

MakeZeroInitializer() [2/2]

template<typename TInputImage , typename TCoordRep = double>

template<typename RealTypeScalarRealType >

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

inlineprivate

Definition at line 526 of file itkLinearInterpolateImageFunction.h.

References itk::NumericTraits< T >::ZeroValue().

New()

template<typename TInputImage , typename TCoordRep = double>

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

static

Method for creation through the object factory.

Examples

SphinxExamples/src/Core/ImageFunction/LinearlyInterpolatePositionInImage/Code.cxx.

PrintSelf()

template<typename TInputImage , typename TCoordRep = double>

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

overrideprotectedvirtual

Get the radius required for interpolation.

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

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

Member Data Documentation

ImageDimension

template<typename TInputImage , typename TCoordRep = double>

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

staticconstexpr

Dimension underlying input image.

Definition at line 80 of file itkLinearInterpolateImageFunction.h.

---

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

• itkLinearInterpolateImageFunction.h