itk::simple::CollidingFrontsImageFilter Class Reference

Selects a region of space where two independent fronts run towards each other. More...

#include <sitkCollidingFrontsImageFilter.h>

Inheritance diagram for itk::simple::CollidingFrontsImageFilter:

Collaboration diagram for itk::simple::CollidingFrontsImageFilter:

Detailed Description

Selects a region of space where two independent fronts run towards each other.

The filter can be used to quickly segment anatomical structures (e.g. for level set initialization).

The filter uses two instances of FastMarchingUpwindGradientImageFilter to compute the gradients of arrival times of two wavefronts propagating from two sets of seeds. The input of the filter is used as the speed of the two wavefronts. The output is the dot product between the two gradient vector fields.

The filter works on the following basic idea. In the regions where the dot product between the two gradient fields is negative, the two fronts propagate in opposite directions. In the regions where the dot product is positive, the two fronts propagate in the same direction. This can be used to extract the region of space between two sets of points.

If StopOnTargets is On, then each front will stop as soon as all seeds of the other front have been reached. This can markedly speed up the execution of the filter, since wave propagation does not take place on the complete image.

Optionally, a connectivity criterion can be applied to the resulting dot product image. In this case, the only negative region in the output image is the one connected to the seeds.

Author

Luca Antiga Ph.D. Biomedical Technologies Laboratory, Bioengineering Department, Mario Negri Institute, Italy.

See also

itk::simple::CollidingFronts for the procedural interface

itk::CollidingFrontsImageFilter for the Doxygen on the original ITK class.

Definition at line 51 of file sitkCollidingFrontsImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList
using	Self = CollidingFrontsImageFilter
Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter
Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
Self &	AddSeedPoint1 (std::vector< unsigned int > point)
	Add SeedPoints1 point. More...
Self &	AddSeedPoint2 (std::vector< unsigned int > point)
	Add SeedPoints2 point. More...
Self &	ApplyConnectivityOff ()
Self &	ApplyConnectivityOn ()
Self &	ClearSeedPoints1 ()
	Remove all SeedPoints1 points. More...
Self &	ClearSeedPoints2 ()
	Remove all SeedPoints2 points. More...
	CollidingFrontsImageFilter ()
Image	Execute (const Image &image1)
bool	GetApplyConnectivity () const
std::string	GetName () const
double	GetNegativeEpsilon () const
std::vector< std::vector< unsigned int > >	GetSeedPoints1 () const
std::vector< std::vector< unsigned int > >	GetSeedPoints2 () const
bool	GetStopOnTargets () const
Self &	SetApplyConnectivity (bool ApplyConnectivity)
Self &	SetNegativeEpsilon (double NegativeEpsilon)
Self &	SetSeedPoints1 (std::vector< std::vector< unsigned int > > SeedPoints1)
Self &	SetSeedPoints2 (std::vector< std::vector< unsigned int > > SeedPoints2)
Self &	SetStopOnTargets (bool StopOnTargets)
Self &	StopOnTargetsOff ()
Self &	StopOnTargetsOn ()
std::string	ToString () const
virtual	~CollidingFrontsImageFilter ()
Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event. More...
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
virtual void	SetNumberOfWorkUnits (unsigned int n)
virtual unsigned int	GetNumberOfWorkUnits () const

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

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

Private Attributes
bool	m_ApplyConnectivity {true}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
double	m_NegativeEpsilon {-1e-6}
std::vector< std::vector< unsigned int > >	m_SeedPoints1 {std::vector< std::vector<unsigned int > >()}
std::vector< std::vector< unsigned int > >	m_SeedPoints2 {std::vector< std::vector<unsigned int > >()}
bool	m_StopOnTargets {false}

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 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...
static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects. More...
static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects. More...
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects. More...
Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
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) noexcept
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default
	NonCopyable (const NonCopyable &)=delete
NonCopyable &	operator= (const NonCopyable &)=delete
Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
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 TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)
template<class TImageType >
static Image	CastITKToImage (TImageType *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)

Member Typedef Documentation

MemberFunctionType

using itk::simple::CollidingFrontsImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 143 of file sitkCollidingFrontsImageFilter.h.

PixelIDTypeList

using itk::simple::CollidingFrontsImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 63 of file sitkCollidingFrontsImageFilter.h.

Self

using itk::simple::CollidingFrontsImageFilter::Self = CollidingFrontsImageFilter

Definition at line 53 of file sitkCollidingFrontsImageFilter.h.

Constructor & Destructor Documentation

~CollidingFrontsImageFilter()

virtual itk::simple::CollidingFrontsImageFilter::~CollidingFrontsImageFilter ( )

virtual

Destructor

CollidingFrontsImageFilter()

itk::simple::CollidingFrontsImageFilter::CollidingFrontsImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

AddSeedPoint1()

Self& itk::simple::CollidingFrontsImageFilter::AddSeedPoint1 ( std::vector< unsigned int >  point )

inline

Add SeedPoints1 point.

Definition at line 76 of file sitkCollidingFrontsImageFilter.h.

References itk::point().

AddSeedPoint2()

Self& itk::simple::CollidingFrontsImageFilter::AddSeedPoint2 ( std::vector< unsigned int >  point )

inline

Add SeedPoints2 point.

Definition at line 91 of file sitkCollidingFrontsImageFilter.h.

References itk::point().

ApplyConnectivityOff()

Self& itk::simple::CollidingFrontsImageFilter::ApplyConnectivityOff ( )

inline

Definition at line 102 of file sitkCollidingFrontsImageFilter.h.

ApplyConnectivityOn()

Self& itk::simple::CollidingFrontsImageFilter::ApplyConnectivityOn ( )

inline

Set the value of ApplyConnectivity to true or false respectfully.

Definition at line 101 of file sitkCollidingFrontsImageFilter.h.

ClearSeedPoints1()

Self& itk::simple::CollidingFrontsImageFilter::ClearSeedPoints1 ( )

inline

Remove all SeedPoints1 points.

Definition at line 78 of file sitkCollidingFrontsImageFilter.h.

ClearSeedPoints2()

Self& itk::simple::CollidingFrontsImageFilter::ClearSeedPoints2 ( )

inline

Remove all SeedPoints2 points.

Definition at line 93 of file sitkCollidingFrontsImageFilter.h.

Execute()

Image itk::simple::CollidingFrontsImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

ExecuteInternal()

template<class TImageType >

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

private

GetApplyConnectivity()

bool itk::simple::CollidingFrontsImageFilter::GetApplyConnectivity ( ) const

inline

Definition at line 106 of file sitkCollidingFrontsImageFilter.h.

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 129 of file sitkCollidingFrontsImageFilter.h.

GetNegativeEpsilon()

double itk::simple::CollidingFrontsImageFilter::GetNegativeEpsilon ( ) const

inline

Definition at line 114 of file sitkCollidingFrontsImageFilter.h.

GetSeedPoints1()

std::vector< std::vector< unsigned int > > itk::simple::CollidingFrontsImageFilter::GetSeedPoints1 ( ) const

inline

Get the container of Seed Points representing the first initial front.

Definition at line 74 of file sitkCollidingFrontsImageFilter.h.

GetSeedPoints2()

std::vector< std::vector< unsigned int > > itk::simple::CollidingFrontsImageFilter::GetSeedPoints2 ( ) const

inline

Get the container of Seed Points representing the second initial front.

Definition at line 89 of file sitkCollidingFrontsImageFilter.h.

GetStopOnTargets()

bool itk::simple::CollidingFrontsImageFilter::GetStopOnTargets ( ) const

inline

Definition at line 126 of file sitkCollidingFrontsImageFilter.h.

SetApplyConnectivity()

Self& itk::simple::CollidingFrontsImageFilter::SetApplyConnectivity ( bool  ApplyConnectivity )

inline

Definition at line 98 of file sitkCollidingFrontsImageFilter.h.

SetNegativeEpsilon()

Self& itk::simple::CollidingFrontsImageFilter::SetNegativeEpsilon ( double  NegativeEpsilon )

inline

Definition at line 110 of file sitkCollidingFrontsImageFilter.h.

SetSeedPoints1()

Self& itk::simple::CollidingFrontsImageFilter::SetSeedPoints1 ( std::vector< std::vector< unsigned int > >  SeedPoints1 )

inline

Set the container of Seed Points representing the first initial front. Seed points are represented as a VectorContainer of LevelSetNodes.

Definition at line 69 of file sitkCollidingFrontsImageFilter.h.

SetSeedPoints2()

Self& itk::simple::CollidingFrontsImageFilter::SetSeedPoints2 ( std::vector< std::vector< unsigned int > >  SeedPoints2 )

inline

Set the container of Seed Points representing the second initial front. Seed points are represented as a VectorContainer of LevelSetNodes.

Definition at line 84 of file sitkCollidingFrontsImageFilter.h.

SetStopOnTargets()

Self& itk::simple::CollidingFrontsImageFilter::SetStopOnTargets ( bool  StopOnTargets )

inline

Definition at line 118 of file sitkCollidingFrontsImageFilter.h.

StopOnTargetsOff()

Self& itk::simple::CollidingFrontsImageFilter::StopOnTargetsOff ( )

inline

Definition at line 122 of file sitkCollidingFrontsImageFilter.h.

StopOnTargetsOn()

Self& itk::simple::CollidingFrontsImageFilter::StopOnTargetsOn ( )

inline

Set the value of StopOnTargets to true or false respectfully.

Definition at line 121 of file sitkCollidingFrontsImageFilter.h.

ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 147 of file sitkCollidingFrontsImageFilter.h.

Member Data Documentation

m_ApplyConnectivity

bool itk::simple::CollidingFrontsImageFilter::m_ApplyConnectivity {true}

private

Definition at line 156 of file sitkCollidingFrontsImageFilter.h.

m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::CollidingFrontsImageFilter::m_MemberFactory

private

Definition at line 149 of file sitkCollidingFrontsImageFilter.h.

m_NegativeEpsilon

double itk::simple::CollidingFrontsImageFilter::m_NegativeEpsilon {-1e-6}

private

Definition at line 158 of file sitkCollidingFrontsImageFilter.h.

m_SeedPoints1

std::vector< std::vector<unsigned int> > itk::simple::CollidingFrontsImageFilter::m_SeedPoints1 {std::vector< std::vector<unsigned int > >()}

private

Definition at line 152 of file sitkCollidingFrontsImageFilter.h.

m_SeedPoints2

std::vector< std::vector<unsigned int> > itk::simple::CollidingFrontsImageFilter::m_SeedPoints2 {std::vector< std::vector<unsigned int > >()}

private

Definition at line 154 of file sitkCollidingFrontsImageFilter.h.

m_StopOnTargets

bool itk::simple::CollidingFrontsImageFilter::m_StopOnTargets {false}

private

Definition at line 160 of file sitkCollidingFrontsImageFilter.h.

---

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

• sitkCollidingFrontsImageFilter.h