SimpleITK  1.3.0.dev466
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
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:

Public Types

typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef CollidingFrontsImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

SelfAddSeedPoint1 (const std::vector< unsigned int > &point)
 Add SeedPoints1 point. More...
 
SelfAddSeedPoint2 (const std::vector< unsigned int > &point)
 Add SeedPoints2 point. More...
 
SelfApplyConnectivityOff ()
 
SelfApplyConnectivityOn ()
 
SelfClearSeedPoints1 ()
 Remove all SeedPoints1 points. More...
 
SelfClearSeedPoints2 ()
 Remove all SeedPoints2 points. More...
 
 CollidingFrontsImageFilter ()
 
Image Execute (const Image &image1)
 
Image Execute (const Image &image1, const std::vector< std::vector< unsigned int > > &seedPoints1, const std::vector< std::vector< unsigned int > > &seedPoints2, bool applyConnectivity, double negativeEpsilon, bool stopOnTargets)
 
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
 
SelfSetApplyConnectivity (bool ApplyConnectivity)
 
SelfSetNegativeEpsilon (double NegativeEpsilon)
 
SelfSetSeedPoints1 (const std::vector< std::vector< unsigned int > > &SeedPoints1)
 
SelfSetSeedPoints2 (const std::vector< std::vector< unsigned int > > &SeedPoints2)
 
SelfSetStopOnTargets (bool StopOnTargets)
 
SelfStopOnTargetsOff ()
 
SelfStopOnTargetsOn ()
 
std::string ToString () const
 
virtual ~CollidingFrontsImageFilter ()
 
- 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

bool m_ApplyConnectivity
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
double m_NegativeEpsilon
 
std::vector< std::vector< unsigned int > > m_SeedPoints1
 
std::vector< std::vector< unsigned int > > m_SeedPoints2
 
bool m_StopOnTargets
 

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::ProcessObjectGetActiveProcess ()
 
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::EventObjectGetITKEventObject (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

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

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 147 of file sitkCollidingFrontsImageFilter.h.

Define the pixels types supported by this filter

Definition at line 64 of file sitkCollidingFrontsImageFilter.h.

Definition at line 54 of file sitkCollidingFrontsImageFilter.h.

Constructor & Destructor Documentation

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

Destructor

itk::simple::CollidingFrontsImageFilter::CollidingFrontsImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Add SeedPoints1 point.

Definition at line 78 of file sitkCollidingFrontsImageFilter.h.

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

Add SeedPoints2 point.

Definition at line 93 of file sitkCollidingFrontsImageFilter.h.

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

Definition at line 104 of file sitkCollidingFrontsImageFilter.h.

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

Set the value of ApplyConnectivity to true or false respectfully.

Definition at line 103 of file sitkCollidingFrontsImageFilter.h.

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

Remove all SeedPoints1 points.

Definition at line 80 of file sitkCollidingFrontsImageFilter.h.

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

Remove all SeedPoints2 points.

Definition at line 95 of file sitkCollidingFrontsImageFilter.h.

Image itk::simple::CollidingFrontsImageFilter::Execute ( const Image image1)

Execute the filter on the input image

Image itk::simple::CollidingFrontsImageFilter::Execute ( const Image image1,
const std::vector< std::vector< unsigned int > > &  seedPoints1,
const std::vector< std::vector< unsigned int > > &  seedPoints2,
bool  applyConnectivity,
double  negativeEpsilon,
bool  stopOnTargets 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::CollidingFrontsImageFilter::ExecuteInternal ( const Image image1)
private
bool itk::simple::CollidingFrontsImageFilter::GetApplyConnectivity ( ) const
inline

Definition at line 108 of file sitkCollidingFrontsImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 130 of file sitkCollidingFrontsImageFilter.h.

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

Definition at line 116 of file sitkCollidingFrontsImageFilter.h.

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

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

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

Definition at line 128 of file sitkCollidingFrontsImageFilter.h.

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

Definition at line 100 of file sitkCollidingFrontsImageFilter.h.

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

Definition at line 112 of file sitkCollidingFrontsImageFilter.h.

Self& itk::simple::CollidingFrontsImageFilter::SetSeedPoints1 ( const 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 71 of file sitkCollidingFrontsImageFilter.h.

Self& itk::simple::CollidingFrontsImageFilter::SetSeedPoints2 ( const 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 86 of file sitkCollidingFrontsImageFilter.h.

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

Definition at line 120 of file sitkCollidingFrontsImageFilter.h.

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

Definition at line 124 of file sitkCollidingFrontsImageFilter.h.

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

Set the value of StopOnTargets to true or false respectfully.

Definition at line 123 of file sitkCollidingFrontsImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 151 of file sitkCollidingFrontsImageFilter.h.

Member Data Documentation

bool itk::simple::CollidingFrontsImageFilter::m_ApplyConnectivity
private

Definition at line 158 of file sitkCollidingFrontsImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::CollidingFrontsImageFilter::m_MemberFactory
private

Definition at line 153 of file sitkCollidingFrontsImageFilter.h.

double itk::simple::CollidingFrontsImageFilter::m_NegativeEpsilon
private

Definition at line 159 of file sitkCollidingFrontsImageFilter.h.

std::vector< std::vector<unsigned int> > itk::simple::CollidingFrontsImageFilter::m_SeedPoints1
private

Definition at line 156 of file sitkCollidingFrontsImageFilter.h.

std::vector< std::vector<unsigned int> > itk::simple::CollidingFrontsImageFilter::m_SeedPoints2
private

Definition at line 157 of file sitkCollidingFrontsImageFilter.h.

bool itk::simple::CollidingFrontsImageFilter::m_StopOnTargets
private

Definition at line 160 of file sitkCollidingFrontsImageFilter.h.


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