Apply the Fast Marching method to solve an Eikonal equation on an image. More...

#include <sitkFastMarchingBaseImageFilter.h>

Inheritance diagram for itk::simple::FastMarchingBaseImageFilter:

Collaboration diagram for itk::simple::FastMarchingBaseImageFilter:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList

typedef FastMarchingBaseImageFilter	Self

enum	TopologyCheckType { Nothing, NoHandles, Strict }

Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter	Self

Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Self &	AddTrialPoint (std::vector< unsigned int > t)

Self &	ClearTrialPoints ()

Image	Execute (const Image &image1)

Image	Execute (const Image &, std::vector< std::vector< unsigned int > > trialPoints, double normalizationFactor, double stoppingValue, FastMarchingBaseImageFilter::TopologyCheckType topologyCheck)

	FastMarchingBaseImageFilter ()

std::string	GetName () const

double	GetNormalizationFactor () const

double	GetStoppingValue () const

TopologyCheckType	GetTopologyCheck () const

std::vector< std::vector< unsigned int > >	GetTrialPoints () const

Self &	SetNormalizationFactor (double NormalizationFactor)

Self &	SetStoppingValue (double StoppingValue)

Self &	SetTopologyCheck (TopologyCheckType TopologyCheck)

Self &	SetTrialPoints (std::vector< std::vector< unsigned int > > t)

std::string	ToString () const

virtual	~FastMarchingBaseImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter< 1 >
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...

virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands. More...

virtual	~ProcessObject ()

virtual void	DebugOn ()

virtual void	DebugOff ()

virtual bool	GetDebug () const

virtual void	SetDebug (bool debugFlag)

virtual void	SetNumberOfThreads (unsigned int n)

virtual unsigned int	GetNumberOfThreads () const

Private Types
typedef Image(Self::*	MemberFunctionType) (const Image &image1)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1)

Private Attributes
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

double	m_NormalizationFactor

double	m_StoppingValue

TopologyCheckType	m_TopologyCheck

std::vector< std::vector< unsigned int > >	m_TrialPoints

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()

static void	GlobalDefaultDebugOff ()

static void	GlobalDefaultDebugOn ()

static void	SetGlobalDefaultDebug (bool debugFlag)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static void	SetGlobalWarningDisplay (bool flag)

static bool	GetGlobalWarningDisplay ()

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()

static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()

Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
static void	FixNonZeroIndex (TImageType *img)

Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)

template<class TImageType >
static Image	CastITKToImage (TImageType *img)

template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

static const itk::EventObject &	GetITKEventObject (EventEnum e)

template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)

static std::ostream &	ToStringHelper (std::ostream &os, const char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

Apply the Fast Marching method to solve an Eikonal equation on an image.

The speed function can be specified as a speed image or a speed constant. The speed image is set using the method SetInput(). If the speed image is ITK_NULLPTR, a constant speed function is used and is specified using method the SetSpeedConstant() .

If the speed function is constant and of value one, fast marching results is an approximate distance function from the initial alive points.

There are two ways to specify the output image information (LargestPossibleRegion, Spacing, Origin):

it is copied directly from the input speed image

it is specified by the user. Default values are used if the user does not specify all the information.

The output information is computed as follows.

If the speed image is ITK_NULLPTR or if the OverrideOutputInformation is set to true, the output information is set from user specified parameters. These parameters can be specified using methods

FastMarchingImageFilterBase::SetOutputRegion() ,

FastMarchingImageFilterBase::SetOutputSpacing() ,

FastMarchingImageFilterBase::SetOutputDirection() ,

FastMarchingImageFilterBase::SetOutputOrigin() .

Else the output information is copied from the input speed image.

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.

For an alternative implementation, see itk::FastMarchingImageFilter .

TTraits

traits

See also: FastMarchingImageFilter; ImageFastMarchingTraits; ImageFastMarchingTraits2; itk::simple::FastMarchingBase for the procedural interface; itk::FastMarchingImageFilterBase for the Doxygen on the original ITK class.

Definition at line 83 of file sitkFastMarchingBaseImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::FastMarchingBaseImageFilter::MemberFunctionType) (const Image &image1)

private

Setup for member function dispatching

Definition at line 171 of file sitkFastMarchingBaseImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::FastMarchingBaseImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 95 of file sitkFastMarchingBaseImageFilter.h.

typedef FastMarchingBaseImageFilter itk::simple::FastMarchingBaseImageFilter::Self

Definition at line 85 of file sitkFastMarchingBaseImageFilter.h.

Member Enumeration Documentation

enum itk::simple::FastMarchingBaseImageFilter::TopologyCheckType

Enumerator
Nothing
NoHandles
Strict

Definition at line 119 of file sitkFastMarchingBaseImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::FastMarchingBaseImageFilter::~FastMarchingBaseImageFilter ( )

virtual

Destructor

itk::simple::FastMarchingBaseImageFilter::FastMarchingBaseImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Self& itk::simple::FastMarchingBaseImageFilter::AddTrialPoint ( std::vector< unsigned int > t )

inline

Add trial point

Definition at line 135 of file sitkFastMarchingBaseImageFilter.h.

Self& itk::simple::FastMarchingBaseImageFilter::ClearTrialPoints ( )

inline

Clear trial points

Definition at line 141 of file sitkFastMarchingBaseImageFilter.h.

Image itk::simple::FastMarchingBaseImageFilter::Execute ( const Image & image1 )

Execute the filter on the input image

Image itk::simple::FastMarchingBaseImageFilter::Execute	(	const Image &	,
		std::vector< std::vector< unsigned int > >	trialPoints,
		double	normalizationFactor,
		double	stoppingValue,
		FastMarchingBaseImageFilter::TopologyCheckType	topologyCheck
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

Image itk::simple::FastMarchingBaseImageFilter::ExecuteInternal ( const Image & image1 )

private

std::string itk::simple::FastMarchingBaseImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 153 of file sitkFastMarchingBaseImageFilter.h.

double itk::simple::FastMarchingBaseImageFilter::GetNormalizationFactor ( ) const

inline

Set/Get the Normalization Factor for the Speed Image . The values in the Speed Image is divided by this factor. This allows the use of images with integer pixel types to represent the speed.

Definition at line 107 of file sitkFastMarchingBaseImageFilter.h.

double itk::simple::FastMarchingBaseImageFilter::GetStoppingValue ( ) const

inline

Get the Fast Marching algorithm Stopping Value.

Definition at line 117 of file sitkFastMarchingBaseImageFilter.h.

TopologyCheckType itk::simple::FastMarchingBaseImageFilter::GetTopologyCheck ( ) const

inline

Definition at line 127 of file sitkFastMarchingBaseImageFilter.h.

std::vector< std::vector<unsigned int> > itk::simple::FastMarchingBaseImageFilter::GetTrialPoints ( ) const

inline

Get trial points

Definition at line 147 of file sitkFastMarchingBaseImageFilter.h.

Self& itk::simple::FastMarchingBaseImageFilter::SetNormalizationFactor ( double NormalizationFactor )

inline

Set/Get the Normalization Factor for the Speed Image . The values in the Speed Image is divided by this factor. This allows the use of images with integer pixel types to represent the speed.

Definition at line 102 of file sitkFastMarchingBaseImageFilter.h.

Self& itk::simple::FastMarchingBaseImageFilter::SetStoppingValue ( double StoppingValue )

inline

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.

Definition at line 112 of file sitkFastMarchingBaseImageFilter.h.

Self& itk::simple::FastMarchingBaseImageFilter::SetTopologyCheck ( TopologyCheckType TopologyCheck )

inline

Definition at line 123 of file sitkFastMarchingBaseImageFilter.h.

Self& itk::simple::FastMarchingBaseImageFilter::SetTrialPoints ( std::vector< std::vector< unsigned int > > t )

inline

Set trial points. The default trial value (i.e. 0.0) is used for each index.

Definition at line 129 of file sitkFastMarchingBaseImageFilter.h.

std::string itk::simple::FastMarchingBaseImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.