Main Page Groups Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Concepts

itk::FastMarchingImageFilter< TLevelSet, TSpeedImage > Class Template Reference
[Level Set-Based Segmentation Filters]

Solve an Eikonal equation using Fast Marching. More...

#include <itkFastMarchingImageFilter.h>

Inheritance diagram for itk::FastMarchingImageFilter:

[legend]Collaboration diagram for itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >:

[legend]List of all members.

Public Types
typedef FastMarchingImageFilter	Self
typedef ImageSource< TLevelSet >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef LevelSetTypeDefault< TLevelSet >	LevelSetType
typedef LevelSetType::LevelSetImageType	LevelSetImageType
typedef LevelSetType::LevelSetPointer	LevelSetPointer
typedef LevelSetType::PixelType	PixelType
typedef LevelSetType::NodeType	NodeType
typedef LevelSetType::NodeContainer	NodeContainer
typedef LevelSetType::NodeContainerPointer	NodeContainerPointer
typedef Index< itkGetStaticConstMacro(SetDimension)	IndexType )
typedef TSpeedImage	SpeedImageType
typedef SpeedImageType::Pointer	SpeedImagePointer
typedef SpeedImageType::ConstPointer	SpeedImageConstPointer
typedef Image< unsigned char, itkGetStaticConstMacro(SetDimension)	LabelImageType )
typedef LabelImageType::Pointer	LabelImagePointer
enum	LabelType { FarPoint, AlivePoint, TrialPoint }
Public Methods
virtual const char *	GetClassName () const
	itkStaticConstMacro (SetDimension, unsigned int, LevelSetType::SetDimension)
NodeContainerPointer	GetAlivePoints ()
NodeContainerPointer	GetTrialPoints ()
LabelImagePointer	GetLabelImage () const
virtual double	GetSpeedConstant ()
virtual void	SetStoppingValue (double _arg)
virtual double	GetStoppingValue ()
virtual void	SetCollectPoints (bool _arg)
NodeContainerPointer	GetProcessedPoints () const
void	SetOutputSize (const typename LevelSetImageType::SizeType &size)
const LevelSetImageType::SizeType &	GetOutputSize () const

void	SetAlivePoints (NodeContainer *points)

void	SetTrialPoints (NodeContainer *points)

void	SetSpeedConstant (double value)

virtual double	GetCollectPoints ()
virtual void	CollectPointsOn ()
virtual void	CollectPointsOff ()
Static Public Methods
Pointer	New ()
Protected Methods
	FastMarchingImageFilter ()
	~FastMarchingImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	Initialize (LevelSetImageType *)
virtual void	UpdateNeighbors (const IndexType &index, const SpeedImageType , LevelSetImageType )
virtual double	UpdateValue (const IndexType &index, const SpeedImageType , LevelSetImageType )
LevelSetImageType::PixelType	GetLargeValue () const
const NodeType &	GetNodeUsedInCalculation (unsigned int idx) const
void	GenerateData ()

virtual void	GenerateOutputInformation ()
virtual void	EnlargeOutputRequestedRegion (DataObject *output)

Detailed Description

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>
class itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >

Solve an Eikonal equation using Fast Marching.

Fast marching solves an Eikonal equation where the speed is always non-negative and depends on the position only. Starting from an initial position on the front, fast marching systematically move the front forward one grid point at a time.

Updates are preformed using an entropy satisfy scheme where only "upwind" neighborhoods are used. This implementation of Fast Marching uses a std::priority_queue to locate the next proper grid position to update.

Fast Marching sweeps through N grid points in (N log N) steps to obtain the arrival time value as the front propagate through the grid.

Implementation of this class is based on Chapter 8 of "Level Set Methods and Fast Marching Methods", J.A. Sethian, Cambridge Press, Second edition, 1999.

This class is templated over the level set image type and the speed image image type. The initial front is specified by two containers: one containing the known points and one containing the trial points. The speed function can be specified as a speed image or a speed constant. The speed image is set using method SetInput(). If the speed image is NULL, a constant speed function is used and is specified using method SetSpeedConstant().

If the speed function is constant and of value one, fast marching results in a approximate distance function from the initial alive points. FastMarchingImageFilter is used in the ReinitializeLevelSetImageFilter object to create a signed distance function from the zero level set.

The algorithm can be terminated early by setting an appropriate stopping value. The algorithm terminates when the current arrival time being processed is greater than the stopping value.

Possible Improvements: In the current implemenation, std::priority_queue only allows taking nodes out from the front and putting nodes in from the back. To update a value already on the heap, a new node is added to the heap. The defunct old node is left on the heap. When it is removed from the top, it will be recognized as invalid and not used. Future implementations can implement the heap in a different way allowing the values to be updated. This will generally require some sift-up and sift-down functions and an image of back-pointers going from the image to heap in order to locate the node which is to be updated.

See also:: LevelSetTypeDefault

Definition at line 85 of file itkFastMarchingImageFilter.h.

Member Typedef Documentation

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef SmartPointer<const Self> itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TSpeedImage, TLevelSet >.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.
Definition at line 93 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef Index<itkGetStaticConstMacro(SetDimension) itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::IndexType)

Index typedef support.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.
Definition at line 115 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef LabelImageType::Pointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LabelImagePointer

LabelImagePointer typedef support.
Definition at line 134 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef Image<unsigned char, itkGetStaticConstMacro(SetDimension) itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LabelImageType)

LabelImage typedef support.
Definition at line 131 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef LevelSetType::LevelSetImageType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LevelSetImageType

Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.
Definition at line 103 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef LevelSetType::LevelSetPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LevelSetPointer

Definition at line 104 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef LevelSetTypeDefault<TLevelSet> itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LevelSetType

Typedef support of level set method types.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.
Definition at line 102 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef LevelSetType::NodeContainer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::NodeContainer

Definition at line 107 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef LevelSetType::NodeContainerPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::NodeContainerPointer

Definition at line 108 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef LevelSetType::NodeType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::NodeType

Definition at line 106 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef LevelSetType::PixelType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::PixelType

Definition at line 105 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef SmartPointer<Self> itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TSpeedImage, TLevelSet >.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.
Definition at line 92 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef FastMarchingImageFilter itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::Self

Standard class typdedefs.
Reimplemented from itk::ImageToImageFilter< TSpeedImage, TLevelSet >.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.
Definition at line 90 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef SpeedImageType::ConstPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SpeedImageConstPointer

Definition at line 122 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef SpeedImageType::Pointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SpeedImagePointer

SpeedImagePointer typedef support.
Definition at line 121 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef TSpeedImage itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SpeedImageType

SpeedImage typedef support.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.
Definition at line 118 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

typedef ImageSource<TLevelSet> itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TSpeedImage, TLevelSet >.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.
Definition at line 91 of file itkFastMarchingImageFilter.h.

Member Enumeration Documentation

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

enum itk::FastMarchingImageFilter::LabelType

Enum of Fast Marching algorithm point types. FarPoints represent far away points; TrialPoints represent points within a narrowband of the propagating front; and AlivePoints represent points which have already been processed.
Enumeration values:

FarPoint

AlivePoint

TrialPoint

Definition at line 128 of file itkFastMarchingImageFilter.h.

Constructor & Destructor Documentation

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::FastMarchingImageFilter ( ) [protected]

Member Function Documentation

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::EnlargeOutputRequestedRegion ( DataObject * output ) [protected, virtual]

Generate the output image meta information.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GenerateData ( void ) [protected, virtual]

This method causes the filter to generate its output.
Reimplemented from itk::ImageSource< TLevelSet >.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GenerateOutputInformation ( ) [protected, virtual]

Generate the output image meta information.
Reimplemented from itk::ProcessObject.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

virtual const char* itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetClassName ( ) const [virtual]

Run-time type information (and related methods).
Reimplemented from itk::ImageToImageFilter< TSpeedImage, TLevelSet >.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

LabelImagePointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetLabelImage ( ) const [inline]

Get the point type label image.
Definition at line 163 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

LevelSetImageType::PixelType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetLargeValue ( ) const [inline, protected]

Definition at line 226 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

const NodeType& itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetNodeUsedInCalculation ( unsigned int idx ) const [inline, protected]

Definition at line 229 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

const LevelSetImageType::SizeType& itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetOutputSize ( ) const [inline]

Get the output level set size.
Definition at line 212 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

NodeContainerPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetProcessedPoints ( ) const [inline]

Get the container of Processed Points. If the CollectPoints flag is set, the algorithm collects a container of all processed nodes. This is useful for defining creating Narrowbands for level set algorithms that supports narrow banding.
Definition at line 203 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::Initialize ( LevelSetImageType * ) [protected, virtual]

Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

Pointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::New ( ) [static]

Method for creation through the object factory.
Reimplemented from itk::Object.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::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::ImageToImageFilter< TSpeedImage, TLevelSet >.
Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetAlivePoints ( NodeContainer * points ) [inline]

Set the container of Alive Points representing the initial front. Alive points are represented as a VectorContainer of LevelSetNodes.
Definition at line 138 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetCollectPoints ( bool _arg ) [virtual]

Set the Collect Points flag. Instrument the algorithm to collect a container of all nodes which it has visited. Useful for creating Narrowbands for level set algorithms that supports narrow banding.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOutputSize ( const typename LevelSetImageType::SizeType & size ) [inline]

Set the output level set size. Defines the size of the output level set.
Definition at line 208 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetSpeedConstant ( double value ) [inline]

Set the Speed Constant. If the Speed Image is NULL, the SpeedConstant value is used for the whole level set. By default, the SpeedConstant is set to 1.0.
Definition at line 169 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetStoppingValue ( double _arg ) [virtual]

Set the Fast Marching algorithm Stopping Value. The Fast Marching algorithm is terminated when the value of the smallest trial point is greater than the stopping value.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetTrialPoints ( NodeContainer * points ) [inline]

Set the container of Trial Points representing the initial front. Trial points are represented as a VectorContainer of LevelSetNodes.
Definition at line 151 of file itkFastMarchingImageFilter.h.

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::UpdateNeighbors ( const IndexType & index,

const SpeedImageType * ,

LevelSetImageType *

) [protected, virtual]

template<class TLevelSet, class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension>>

virtual double itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::UpdateValue ( const IndexType & index,

const SpeedImageType * ,

LevelSetImageType *

) [protected, virtual]

Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >.

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

itkFastMarchingImageFilter.h

Generated at Fri May 21 01:45:31 2004 for ITK by

itk::FastMarchingImageFilter< TLevelSet, TSpeedImage > Class Template Reference [Level Set-Based Segmentation Filters]

Public Types

Public Methods

Static Public Methods

Protected Methods