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

Calculate the derivative using only upwind neighbors. More...

#include <itkUpwindDerivativeImageFunction.h>

Inheritance diagram for itk::UpwindDerivativeImageFunction:

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

[legend]List of all members.

Public Types
typedef UpwindDerivativeImageFunction	Self
typedef ImageFunction< TInputImage, double, TCoordRep >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef Superclass::IndexType	IndexType
typedef Superclass::ContinuousIndexType	ContinuousIndexType
typedef Superclass::PointType	PointType
Public Methods
virtual const char *	GetClassName () const
	itkStaticConstMacro (ImageDimension, unsigned int, InputImageType::ImageDimension)
virtual void	SetInputImage (const InputImageType *ptr)
virtual void	SetSpeed (double value)
virtual double	GetSpeed () const
virtual double	EvaluateAtIndex (const IndexType &index) const
virtual double	EvaluateNthDerivativeAtIndex (const IndexType &index, unsigned int dim=0) const
virtual double	GetDerivative () const
virtual double	Evaluate (const PointType &point) const
virtual double	EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const
Static Public Methods
Pointer	New ()
Protected Methods
	UpwindDerivativeImageFunction ()
	~UpwindDerivativeImageFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
double	m_Speed
double	m_Derivative

---

Detailed Description

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

Calculate the derivative using only upwind neighbors.

UpwindDerivativeImageFunction calculates a derivative using only upwind neighbors. The flow direction can be specified by the sign of the speed value set via the SetSpeed() method.

If the speed is positive, the backward difference operator is used. If speed is negative, the forward difference operator is used.

This class is templated over the input image type and the coordinate representation type (e.g. float or double).

Reference: "Level Set Methods and Fast Marching Methods", J.A. Sethian, Cambridge Press, Chapter 6, Second edition, 1999.

Possible improvements:

• the use of Neighborhood operators may improve efficiency.

Definition at line 49 of file itkUpwindDerivativeImageFunction.h.

---

Member Typedef Documentation

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

Reimplemented from itk::ImageFunction< TInputImage, double, TCoordRep >. Definition at line 57 of file itkUpwindDerivativeImageFunction.h.

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

ContinuousIndex typedef support. Reimplemented from itk::ImageFunction< TInputImage, double, TCoordRep >. Definition at line 76 of file itkUpwindDerivativeImageFunction.h.

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

Index typedef support. Reimplemented from itk::ImageFunction< TInputImage, double, TCoordRep >. Definition at line 73 of file itkUpwindDerivativeImageFunction.h.

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

InputImageType typedef support. Reimplemented from itk::ImageFunction< TInputImage, double, TCoordRep >. Definition at line 66 of file itkUpwindDerivativeImageFunction.h.

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

Reimplemented from itk::ImageFunction< TInputImage, double, TCoordRep >. Definition at line 56 of file itkUpwindDerivativeImageFunction.h.

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

Point typedef support. Reimplemented from itk::ImageFunction< TInputImage, double, TCoordRep >. Definition at line 79 of file itkUpwindDerivativeImageFunction.h.

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

Standard class typedefs. Reimplemented from itk::ImageFunction< TInputImage, double, TCoordRep >. Definition at line 54 of file itkUpwindDerivativeImageFunction.h.

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

Reimplemented from itk::ImageFunction< TInputImage, double, TCoordRep >. Definition at line 55 of file itkUpwindDerivativeImageFunction.h.

---

Constructor & Destructor Documentation

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

Definition at line 121 of file itkUpwindDerivativeImageFunction.h.

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

Definition at line 122 of file itkUpwindDerivativeImageFunction.h. References HardConnectedComponentImageFilter::PrintSelf().

---

Member Function Documentation

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

Evaluate the function at non-integer positions. Implements itk::ImageFunction< TInputImage, double, TCoordRep >. Definition at line 97 of file itkUpwindDerivativeImageFunction.h. References HardConnectedComponentImageFilter::IndexType.

template<class TInputImage, class TCoordRep = float> virtual double itk::UpwindDerivativeImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex (  const ContinuousIndexType &    cindex )  const [inline, virtual]

Evaluate the function at non-integer positions. Implements itk::ImageFunction< TInputImage, double, TCoordRep >. Definition at line 103 of file itkUpwindDerivativeImageFunction.h. References HardConnectedComponentImageFilter::IndexType.

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

Evalulate the function at specified index. Implements itk::ImageFunction< TInputImage, double, TCoordRep >. Definition at line 93 of file itkUpwindDerivativeImageFunction.h. References HardConnectedComponentImageFilter::IndexType.

template<class TInputImage, class TCoordRep = float> virtual double itk::UpwindDerivativeImageFunction< TInputImage, TCoordRep >::EvaluateNthDerivativeAtIndex (  const IndexType &    index, unsigned int    dim = 0 )  const [virtual]

Evalulate the Nth derivative at specified index.

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

Run-time type information (and related methods). Reimplemented from itk::ImageFunction< TInputImage, double, TCoordRep >.

template<class TInputImage, class TCoordRep = float> virtual double itk::UpwindDerivativeImageFunction< TInputImage, TCoordRep >::GetDerivative (    )  const [inline, virtual]

Get the derivative from last evaluation Definition at line 117 of file itkUpwindDerivativeImageFunction.h.

template<class TInputImage, class TCoordRep = float> virtual double itk::UpwindDerivativeImageFunction< TInputImage, TCoordRep >::GetSpeed (    )  const [inline, virtual]

Get the speed parameter. Definition at line 89 of file itkUpwindDerivativeImageFunction.h.

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

Dimension of the underlying image.

template<class TInputImage, class TCoordRep = float> Pointer itk::UpwindDerivativeImageFunction< TInputImage, TCoordRep >::New (    )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TInputImage, class TCoordRep = float> void itk::UpwindDerivativeImageFunction< TInputImage, TCoordRep >::PrintSelf (  std::ostream &    os, Indent    indent )  const [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, double, TCoordRep >.

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

Set the input image. Reimplemented from itk::ImageFunction< TInputImage, double, TCoordRep >.

template<class TInputImage, class TCoordRep = float> virtual void itk::UpwindDerivativeImageFunction< TInputImage, TCoordRep >::SetSpeed (  double    value )  [inline, virtual]

Set the speed parameter. Definition at line 85 of file itkUpwindDerivativeImageFunction.h.

---

Member Data Documentation

template<class TInputImage, class TCoordRep = float> double itk::UpwindDerivativeImageFunction< TInputImage, TCoordRep >::m_Derivative [protected]

Definition at line 126 of file itkUpwindDerivativeImageFunction.h.

template<class TInputImage, class TCoordRep = float> double itk::UpwindDerivativeImageFunction< TInputImage, TCoordRep >::m_Speed [protected]

Definition at line 125 of file itkUpwindDerivativeImageFunction.h.

---

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

• itkUpwindDerivativeImageFunction.h

---