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

Evaluates a function of an image at specified position. More...

#include <itkImageFunction.h>

List of all members.

Public Types
typedef ImageFunction	Self
typedef FunctionBase< Point< TCoordRep, itkGetStaticConstMacro(ImageDimension)>, TOutput	Superclass )
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef InputImageType::PixelType	InputPixelType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef TOutput	OutputType
typedef TCoordRep	CoordRepType
typedef InputImageType::IndexType	IndexType
typedef ContinuousIndex< TCoordRep, itkGetStaticConstMacro(ImageDimension)	ContinuousIndexType )
typedef Point< TCoordRep, itkGetStaticConstMacro(ImageDimension)	PointType )
Public Member Functions
	itkStaticConstMacro (ImageDimension, unsigned int, TInputImage::ImageDimension)
virtual const char *	GetClassName () const
virtual void	SetInputImage (const InputImageType *ptr)
const InputImageType *	GetInputImage () const
virtual TOutput	Evaluate (const PointType &point) const =0
virtual TOutput	EvaluateAtIndex (const IndexType &index) const =0
virtual TOutput	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0
bool	IsInsideBuffer (const IndexType &index) const
bool	IsInsideBuffer (const ContinuousIndexType &index) const
bool	IsInsideBuffer (const PointType &point) const
void	ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
void	ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
Protected Member Functions
	ImageFunction ()
	~ImageFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
InputImageConstPointer	m_Image
IndexType	m_StartIndex
IndexType	m_EndIndex
ContinuousIndexType	m_StartContinuousIndex
ContinuousIndexType	m_EndContinuousIndex

---

Detailed Description

template<class TInputImage, class TOutput, class TCoordRep = float>
class itk::ImageFunction< TInputImage, TOutput, TCoordRep >

Evaluates a function of an image at specified position.

ImageFunction is a baseclass for all objects that evaluates a function of an image at index, continuous index or point. This class is templated over the input image type, the type of the function output and the coordinate representation type (e.g. float or double).

The input image is set via method SetInputImage(). Methods Evaluate, EvaluateAtIndex and EvaluateAtContinuousIndex respectively evaluates the function at an geometric point, image index and continuous image index.

Warning:

Image BufferedRegion information is cached during in SetInputImage( image ). If the image BufferedRegion has changed one must call SetInputImage( image ) again to update the cache to the current values.

See also:

Point

Index

ContinuousIndex

Definition at line 60 of file itkImageFunction.h.

---

Member Typedef Documentation

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

Reimplemented in itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, and itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >. Definition at line 76 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> typedef ContinuousIndex<TCoordRep,itkGetStaticConstMacro(ImageDimension) itk::ImageFunction< TInputImage, TOutput, TCoordRep >::ContinuousIndexType)

ContinuousIndex Type. Reimplemented in itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, and itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >. Definition at line 101 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> typedef TCoordRep itk::ImageFunction< TInputImage, TOutput, TCoordRep >::CoordRepType

CoordRepType typedef support. Definition at line 94 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> typedef InputImageType::IndexType itk::ImageFunction< TInputImage, TOutput, TCoordRep >::IndexType

Index Type. Reimplemented in itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, and itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >. Definition at line 97 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> typedef InputImageType::ConstPointer itk::ImageFunction< TInputImage, TOutput, TCoordRep >::InputImageConstPointer

InputImagePointer typedef support Definition at line 88 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> typedef TInputImage itk::ImageFunction< TInputImage, TOutput, TCoordRep >::InputImageType

InputImageType typedef support. Reimplemented in itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, and itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >. Definition at line 82 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> typedef InputImageType::PixelType itk::ImageFunction< TInputImage, TOutput, TCoordRep >::InputPixelType

InputPixel typedef support Reimplemented in itk::GaussianBlurImageFunction< TInputImage, TOutput >, and itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >. Definition at line 85 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> typedef TOutput itk::ImageFunction< TInputImage, TOutput, TCoordRep >::OutputType

OutputType typedef support. Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >. Definition at line 91 of file itkImageFunction.h.

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

Reimplemented in itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, and itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >. Definition at line 75 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> typedef Point<TCoordRep,itkGetStaticConstMacro(ImageDimension) itk::ImageFunction< TInputImage, TOutput, TCoordRep >::PointType)

Point Type. Reimplemented in itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, and itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >. Definition at line 104 of file itkImageFunction.h.

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

Standard class typedefs. Reimplemented in itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, and itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >. Definition at line 71 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> typedef FunctionBase< Point<TCoordRep, itkGetStaticConstMacro(ImageDimension)>, TOutput itk::ImageFunction< TInputImage, TOutput, TCoordRep >::Superclass)

Reimplemented in itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, and itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >. Definition at line 74 of file itkImageFunction.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 190 of file itkImageFunction.h.

---

Member Function Documentation

template<class TInputImage, class TOutput, class TCoordRep = float> void itk::ImageFunction< TInputImage, TOutput, TCoordRep >::ConvertContinuousIndexToNearestIndex (  const ContinuousIndexType &  cindex, IndexType &  index )  const [inline]

Convert continuous index to nearest index. Definition at line 179 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> void itk::ImageFunction< TInputImage, TOutput, TCoordRep >::ConvertPointToNearestIndex (  const PointType &  point, IndexType &  index )  const [inline]

Convert point to nearest index. Definition at line 169 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> virtual TOutput itk::ImageFunction< TInputImage, TOutput, TCoordRep >::Evaluate (  const PointType &  point  )  const [pure virtual]

Evaluate the function at specified Point position. Subclasses must provide this method. Implemented in itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, and itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >.

template<class TInputImage, class TOutput, class TCoordRep = float> virtual TOutput itk::ImageFunction< TInputImage, TOutput, TCoordRep >::EvaluateAtContinuousIndex (  const ContinuousIndexType &  index  )  const [pure virtual]

Evaluate the function at specified ContinousIndex position. Subclasses must provide this method. Implemented in itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, and itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >.

template<class TInputImage, class TOutput, class TCoordRep = float> virtual TOutput itk::ImageFunction< TInputImage, TOutput, TCoordRep >::EvaluateAtIndex (  const IndexType &  index  )  const [pure virtual]

Evaluate the function at specified Index position. Subclasses must provide this method. Implemented in itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, and itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >.

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

Run-time type information (and related methods). Reimplemented in itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, and itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >.

template<class TInputImage, class TOutput, class TCoordRep = float> const InputImageType* itk::ImageFunction< TInputImage, TOutput, TCoordRep >::GetInputImage (   )  const [inline]

Get the input image. Definition at line 113 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> bool itk::ImageFunction< TInputImage, TOutput, TCoordRep >::IsInsideBuffer (  const PointType &  point  )  const [inline]

Check if a point is inside the image buffer. Warning: For efficiency, no validity checking of the input image pointer is done. Definition at line 160 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> bool itk::ImageFunction< TInputImage, TOutput, TCoordRep >::IsInsideBuffer (  const ContinuousIndexType &  index  )  const [inline]

Check if a continuous index is inside the image buffer. Warning: For efficiency, no validity checking of the input image is done. Definition at line 146 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> bool itk::ImageFunction< TInputImage, TOutput, TCoordRep >::IsInsideBuffer (  const IndexType &  index  )  const [inline]

Check if an index is inside the image buffer. Warning: For efficiency, no validity checking of the input image is done. Definition at line 132 of file itkImageFunction.h.

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

Dimension underlying input image.

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

Reimplemented in itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >, itk::GaussianBlurImageFunction< TInputImage, TOutput >, itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >, itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >, and itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >.

template<class TInputImage, class TOutput, class TCoordRep = float> virtual void itk::ImageFunction< TInputImage, TOutput, TCoordRep >::SetInputImage (  const InputImageType *  ptr  )  [virtual]

Set the input image. Warning: this method caches BufferedRegion information. If the BufferedRegion has changed, user must call SetInputImage again to update cached values. Reimplemented in itk::GaussianBlurImageFunction< TInputImage, TOutput >.

---

Member Data Documentation

template<class TInputImage, class TOutput, class TCoordRep = float> ContinuousIndexType itk::ImageFunction< TInputImage, TOutput, TCoordRep >::m_EndContinuousIndex [protected]

Definition at line 200 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> IndexType itk::ImageFunction< TInputImage, TOutput, TCoordRep >::m_EndIndex [protected]

Definition at line 198 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> InputImageConstPointer itk::ImageFunction< TInputImage, TOutput, TCoordRep >::m_Image [protected]

Const pointer to the input image. Definition at line 194 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> ContinuousIndexType itk::ImageFunction< TInputImage, TOutput, TCoordRep >::m_StartContinuousIndex [protected]

Definition at line 199 of file itkImageFunction.h.

template<class TInputImage, class TOutput, class TCoordRep = float> IndexType itk::ImageFunction< TInputImage, TOutput, TCoordRep >::m_StartIndex [protected]

Cache some values for testing if indices are inside buffered region. Definition at line 197 of file itkImageFunction.h.

---

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

• itkImageFunction.h

---