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 60 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
void	AddSeedPoint1 (std::vector< unsigned int > point)
	Add SeedPoints1 point.
void	AddSeedPoint2 (std::vector< unsigned int > point)
	Add SeedPoints2 point.
void	ApplyConnectivityOff ()
void	ApplyConnectivityOn ()
void	ClearSeedPoints1 ()
	Remove all SeedPoints1 points.
void	ClearSeedPoints2 ()
	Remove all SeedPoints2 points.
	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
void	SetApplyConnectivity (bool ApplyConnectivity)
void	SetNegativeEpsilon (double NegativeEpsilon)
void	SetSeedPoints1 (std::vector< std::vector< unsigned int > > SeedPoints1)
void	SetSeedPoints2 (std::vector< std::vector< unsigned int > > SeedPoints2)
void	SetStopOnTargets (bool StopOnTargets)
void	StopOnTargetsOff ()
void	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.
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.
virtual float	GetProgress () const
	An Active Measurement of the progress of execution.
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands.
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)

Static Private Member Functions
static const detail::MemberFunctionFactory< MemberFunctionType > &	GetMemberFunctionFactory ()

Private Attributes
bool	m_ApplyConnectivity { true }
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.
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.
static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.
static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.
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 175 of file sitkCollidingFrontsImageFilter.h.

PixelIDTypeList

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

Define the pixels types supported by this filter

Definition at line 72 of file sitkCollidingFrontsImageFilter.h.

Self

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

Definition at line 62 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()

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

inline

Add SeedPoints1 point.

Definition at line 91 of file sitkCollidingFrontsImageFilter.h.

References m_SeedPoints1.

AddSeedPoint2()

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

inline

Add SeedPoints2 point.

Definition at line 111 of file sitkCollidingFrontsImageFilter.h.

References m_SeedPoints2.

ApplyConnectivityOff()

void itk::simple::CollidingFrontsImageFilter::ApplyConnectivityOff ( )

inline

Definition at line 127 of file sitkCollidingFrontsImageFilter.h.

References SetApplyConnectivity().

ApplyConnectivityOn()

void itk::simple::CollidingFrontsImageFilter::ApplyConnectivityOn ( )

inline

Set the value of ApplyConnectivity to true or false respectfully.

Definition at line 125 of file sitkCollidingFrontsImageFilter.h.

References SetApplyConnectivity().

ClearSeedPoints1()

void itk::simple::CollidingFrontsImageFilter::ClearSeedPoints1 ( )

inline

Remove all SeedPoints1 points.

Definition at line 94 of file sitkCollidingFrontsImageFilter.h.

References m_SeedPoints1.

ClearSeedPoints2()

void itk::simple::CollidingFrontsImageFilter::ClearSeedPoints2 ( )

inline

Remove all SeedPoints2 points.

Definition at line 114 of file sitkCollidingFrontsImageFilter.h.

References m_SeedPoints2.

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

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

GetApplyConnectivity()

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

inline

Definition at line 131 of file sitkCollidingFrontsImageFilter.h.

References m_ApplyConnectivity.

GetMemberFunctionFactory()

static const detail::MemberFunctionFactory< MemberFunctionType > & itk::simple::CollidingFrontsImageFilter::GetMemberFunctionFactory ( )

staticprivate

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 163 of file sitkCollidingFrontsImageFilter.h.

GetNegativeEpsilon()

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

inline

Definition at line 142 of file sitkCollidingFrontsImageFilter.h.

References m_NegativeEpsilon.

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 88 of file sitkCollidingFrontsImageFilter.h.

References m_SeedPoints1.

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 108 of file sitkCollidingFrontsImageFilter.h.

References m_SeedPoints2.

GetStopOnTargets()

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

inline

Definition at line 159 of file sitkCollidingFrontsImageFilter.h.

References m_StopOnTargets.

SetApplyConnectivity()

void itk::simple::CollidingFrontsImageFilter::SetApplyConnectivity ( bool ApplyConnectivity )

inline

Definition at line 120 of file sitkCollidingFrontsImageFilter.h.

References m_ApplyConnectivity.

Referenced by ApplyConnectivityOff(), and ApplyConnectivityOn().

SetNegativeEpsilon()

void itk::simple::CollidingFrontsImageFilter::SetNegativeEpsilon ( double NegativeEpsilon )

inline

Definition at line 137 of file sitkCollidingFrontsImageFilter.h.

References m_NegativeEpsilon.

SetSeedPoints1()

void 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 82 of file sitkCollidingFrontsImageFilter.h.

References m_SeedPoints1.

SetSeedPoints2()

void 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 102 of file sitkCollidingFrontsImageFilter.h.

References m_SeedPoints2.

SetStopOnTargets()

void itk::simple::CollidingFrontsImageFilter::SetStopOnTargets ( bool StopOnTargets )

inline

Definition at line 148 of file sitkCollidingFrontsImageFilter.h.

References m_StopOnTargets.

Referenced by StopOnTargetsOff(), and StopOnTargetsOn().

StopOnTargetsOff()

void itk::simple::CollidingFrontsImageFilter::StopOnTargetsOff ( )

inline

Definition at line 155 of file sitkCollidingFrontsImageFilter.h.

References SetStopOnTargets().

StopOnTargetsOn()

void itk::simple::CollidingFrontsImageFilter::StopOnTargetsOn ( )

inline

Set the value of StopOnTargets to true or false respectfully.

Definition at line 153 of file sitkCollidingFrontsImageFilter.h.

References SetStopOnTargets().

ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 176 of file sitkCollidingFrontsImageFilter.h.

References ExecuteInternal().

Member Data Documentation

m_ApplyConnectivity

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

private

Definition at line 185 of file sitkCollidingFrontsImageFilter.h.

Referenced by GetApplyConnectivity(), and SetApplyConnectivity().

m_NegativeEpsilon

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

private

Definition at line 187 of file sitkCollidingFrontsImageFilter.h.

Referenced by GetNegativeEpsilon(), and SetNegativeEpsilon().

m_SeedPoints1

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

private

Definition at line 181 of file sitkCollidingFrontsImageFilter.h.

Referenced by AddSeedPoint1(), ClearSeedPoints1(), GetSeedPoints1(), and SetSeedPoints1().

m_SeedPoints2

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

private

Definition at line 183 of file sitkCollidingFrontsImageFilter.h.

Referenced by AddSeedPoint2(), ClearSeedPoints2(), GetSeedPoints2(), and SetSeedPoints2().

m_StopOnTargets

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

private

Definition at line 189 of file sitkCollidingFrontsImageFilter.h.

Referenced by GetStopOnTargets(), and SetStopOnTargets().

---

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

• sitkCollidingFrontsImageFilter.h