itk::InterpolateImageFunction< TInputImage, TCoordRep > Class Template Reference
[Image Functions]

Base class for all image interpolaters. More...

#include <itkInterpolateImageFunction.h>

Inheritance diagram for itk::InterpolateImageFunction:

[legend]Collaboration diagram for itk::InterpolateImageFunction< TInputImage, TCoordRep >:

[legend]List of all members.

Public Types
typedef InterpolateImageFunction	Self
typedef ImageFunction< TInputImage, double, TCoordRep >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::OutputType	OutputType
typedef Superclass::InputImageType	InputImageType
typedef Superclass::PointType	PointType
typedef Superclass::IndexType	IndexType
typedef Superclass::ContinuousIndexType	ContinuousIndexType
typedef NumericTraits< typename TInputImage::PixelType >::RealType	RealType
Public Methods
virtual const char *	GetClassName () const
	itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
virtual OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const=0
virtual OutputType	EvaluateAtIndex (const IndexType &index) const
virtual OutputType	Evaluate (const PointType &point) const
Protected Methods
	InterpolateImageFunction ()
	~InterpolateImageFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<class TInputImage, class TCoordRep = float>
class itk::InterpolateImageFunction< TInputImage, TCoordRep >

Base class for all image interpolaters.

InterpolateImageFunction is the base for all ImageFunctions that 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 ).

Warning:

This heirarchy of functions work only for images with scalar pixel types. For images of vector pixel types use VectorInterpolateImageFunctions.

See also:

VectorInterpolateImageFunction

Definition at line 42 of file itkInterpolateImageFunction.h.

---

Member Typedef Documentation

template<class TInputImage, class TCoordRep = float> typedef SmartPointer<const Self> itk::InterpolateImageFunction< TInputImage, TCoordRep >::ConstPointer

Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >. Reimplemented in itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::BSplineResampleImageFunction< TImageType, TCoordRep >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, and itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >. Definition at line 51 of file itkInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = float> typedef Superclass::ContinuousIndexType itk::InterpolateImageFunction< TInputImage, TCoordRep >::ContinuousIndexType

ContinuousIndex typedef support. Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >. Reimplemented in itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, and itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >. Definition at line 73 of file itkInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = float> typedef Superclass::IndexType itk::InterpolateImageFunction< TInputImage, TCoordRep >::IndexType

Index typedef support. Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >. Reimplemented in itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, and itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >. Definition at line 70 of file itkInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = float> typedef Superclass::InputImageType itk::InterpolateImageFunction< TInputImage, TCoordRep >::InputImageType

InputImageType typedef support. Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >. Reimplemented in itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, and itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >. Definition at line 60 of file itkInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = float> typedef Superclass::OutputType itk::InterpolateImageFunction< TInputImage, TCoordRep >::OutputType

OutputType typedef support. Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >. Reimplemented in itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, and itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >. Definition at line 57 of file itkInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = float> typedef SmartPointer<Self> itk::InterpolateImageFunction< TInputImage, TCoordRep >::Pointer

Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >. Reimplemented in itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::BSplineResampleImageFunction< TImageType, TCoordRep >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, and itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >. Definition at line 50 of file itkInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = float> typedef Superclass::PointType itk::InterpolateImageFunction< TInputImage, TCoordRep >::PointType

Point typedef support. Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >. Reimplemented in itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, and itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >. Definition at line 67 of file itkInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = float> typedef NumericTraits<typename TInputImage::PixelType>::RealType itk::InterpolateImageFunction< TInputImage, TCoordRep >::RealType

RealType typedef support. Reimplemented in itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >. Definition at line 76 of file itkInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = float> typedef InterpolateImageFunction itk::InterpolateImageFunction< TInputImage, TCoordRep >::Self

Standard class typedefs. Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >. Reimplemented in itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::BSplineResampleImageFunction< TImageType, TCoordRep >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, and itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >. Definition at line 48 of file itkInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = float> typedef ImageFunction<TInputImage,double,TCoordRep> itk::InterpolateImageFunction< TInputImage, TCoordRep >::Superclass

Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >. Reimplemented in itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::BSplineResampleImageFunction< TImageType, TCoordRep >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, and itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >. Definition at line 49 of file itkInterpolateImageFunction.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TCoordRep = float> itk::InterpolateImageFunction< TInputImage, TCoordRep >::InterpolateImageFunction (    )  [inline, protected]

Definition at line 121 of file itkInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = float> itk::InterpolateImageFunction< TInputImage, TCoordRep >::~InterpolateImageFunction (    )  [inline, protected]

Definition at line 122 of file itkInterpolateImageFunction.h.

---

Member Function Documentation

template<class TInputImage, class TCoordRep = float> virtual OutputType itk::InterpolateImageFunction< TInputImage, TCoordRep >::Evaluate (  const PointType &    point )  const [inline, virtual]

Interpolate the image at a point position 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. Implements itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >. Definition at line 86 of file itkInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = float> virtual OutputType itk::InterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex (  const ContinuousIndexType &    index )  const [pure 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. Implements itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >. Implemented in itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, and itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >.

template<class TInputImage, class TCoordRep = float> virtual OutputType itk::InterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex (  const IndexType &    index )  const [inline, virtual]

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. Implements itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >. Definition at line 115 of file itkInterpolateImageFunction.h.

template<class TInputImage, class TCoordRep = float> virtual const char* itk::InterpolateImageFunction< TInputImage, TCoordRep >::GetClassName (    )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >. Reimplemented in itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::BSplineResampleImageFunction< TImageType, TCoordRep >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, and itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >.

template<class TInputImage, class TCoordRep = float> itk::InterpolateImageFunction< TInputImage, TCoordRep >::itkStaticConstMacro (  ImageDimension   , unsigned    int, Superclass::ImageDimension    )

Dimension underlying input image. Reimplemented in itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, and itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >.

template<class TInputImage, class TCoordRep = float> void itk::InterpolateImageFunction< TInputImage, TCoordRep >::PrintSelf (  std::ostream &    os, Indent    indent )  const [inline, protected, virtual]

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::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >. Reimplemented in itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TCoefficientType >, itk::BSplineResampleImageFunction< TImageType, TCoordRep >, itk::LinearInterpolateImageFunction< TInputImage, TCoordRep >, itk::NearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, and itk::BSplineInterpolateImageFunction< TImageType, TCoordRep, TImageType::PixelType >. Definition at line 123 of file itkInterpolateImageFunction.h.

---

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

• itkInterpolateImageFunction.h

---