SimpleITK  1.2.4
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::GeodesicActiveContourLevelSetImageFilter Class Reference

Segments structures in images based on a user supplied edge potential map. More...

#include <sitkGeodesicActiveContourLevelSetImageFilter.h>

+ Inheritance diagram for itk::simple::GeodesicActiveContourLevelSetImageFilter:
+ Collaboration diagram for itk::simple::GeodesicActiveContourLevelSetImageFilter:

Public Types

typedef RealPixelIDTypeList PixelIDTypeList
 
typedef GeodesicActiveContourLevelSetImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 2 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &image1, const Image &image2)
 
Image Execute (const Image &image1, const Image &image2, double maximumRMSError, double propagationScaling, double curvatureScaling, double advectionScaling, uint32_t numberOfIterations, bool reverseExpansionDirection)
 
 GeodesicActiveContourLevelSetImageFilter ()
 
double GetAdvectionScaling () const
 
double GetCurvatureScaling () const
 
uint32_t GetElapsedIterations () const
 Number of iterations run. More...
 
double GetMaximumRMSError () const
 
std::string GetName () const
 
uint32_t GetNumberOfIterations () const
 
double GetPropagationScaling () const
 
bool GetReverseExpansionDirection () const
 
double GetRMSChange () const
 The Root Mean Square of the levelset upon termination. More...
 
Self & ReverseExpansionDirectionOff ()
 
Self & ReverseExpansionDirectionOn ()
 
Self & SetAdvectionScaling (double AdvectionScaling)
 
Self & SetCurvatureScaling (double CurvatureScaling)
 
Self & SetMaximumRMSError (double MaximumRMSError)
 
Self & SetNumberOfIterations (uint32_t NumberOfIterations)
 
Self & SetPropagationScaling (double PropagationScaling)
 
Self & SetReverseExpansionDirection (bool ReverseExpansionDirection)
 
std::string ToString () const
 
virtual ~GeodesicActiveContourLevelSetImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 2 >
 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, const Image &image2)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1, const Image &image2)
 

Private Attributes

double m_AdvectionScaling
 
double m_CurvatureScaling
 
uint32_t m_ElapsedIterations
 
double m_MaximumRMSError
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
uint32_t m_NumberOfIterations
 
double m_PropagationScaling
 
bool m_ReverseExpansionDirection
 
double m_RMSChange
 

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< 2 >
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

Segments structures in images based on a user supplied edge potential map.

IMPORTANT
The SegmentationLevelSetImageFilter class and the GeodesicActiveContourLevelSetFunction class contain additional information necessary to gain full understanding of how to use this filter.
OVERVIEW
This class is a level set method segmentation filter. An initial contour is propagated outwards (or inwards) until it ''sticks'' to the shape boundaries. This is done by using a level set speed function based on a user supplied edge potential map.
INPUTS
This filter requires two inputs. The first input is a initial level set. The initial level set is a real image which contains the initial contour/surface as the zero level set. For example, a signed distance function from the initial contour/surface is typically used. Unlike the simpler ShapeDetectionLevelSetImageFilter the initial contour does not have to lie wholly within the shape to be segmented. The initial contour is allow to overlap the shape boundary. The extra advection term in the update equation behaves like a doublet and attracts the contour to the boundary. This approach for segmentation follows that of Caselles et al (1997).
The second input is the feature image. For this filter, this is the edge potential map. General characteristics of an edge potential map is that it has values close to zero in regions near the edges and values close to one inside the shape itself. Typically, the edge potential map is compute from the image gradient, for example:

\[ g(I) = 1 / ( 1 + | (\nabla * G)(I)| ) \]

\[ g(I) = \exp^{-|(\nabla * G)(I)|} \]

where $ I $ is image intensity and $ (\nabla * G) $ is the derivative of Gaussian operator.

See SegmentationLevelSetImageFilter and SparseFieldLevelSetImageFilter for more information on Inputs.
PARAMETERS
The PropagationScaling parameter can be used to switch from propagation outwards (POSITIVE scaling parameter) versus propagating inwards (NEGATIVE scaling parameter).

This implementation allows the user to set the weights between the propagation, advection and curvature term using methods SetPropagationScaling() , SetAdvectionScaling() , SetCurvatureScaling() . In general, the larger the CurvatureScaling, the smoother the resulting contour. To follow the implementation in Caselles et al paper, set the PropagationScaling to $ c $ (the inflation or ballon force) and AdvectionScaling and CurvatureScaling both to 1.0.

OUTPUTS
The filter outputs a single, scalar, real-valued image. Negative values in the output image represent the inside of the segmented region and positive values in the image represent the outside of the segmented region. The zero crossings of the image correspond to the position of the propagating front.
See SparseFieldLevelSetImageFilter and SegmentationLevelSetImageFilter for more information.
REFERENCES
"Geodesic Active Contours", V. Caselles, R. Kimmel and G. Sapiro. International Journal on Computer Vision, Vol 22, No. 1, pp 61-97, 1997
See also
SegmentationLevelSetImageFilter
GeodesicActiveContourLevelSetFunction
SparseFieldLevelSetImageFilter
itk::simple::GeodesicActiveContourLevelSet for the procedural interface
itk::GeodesicActiveContourLevelSetImageFilter for the Doxygen on the original ITK class.

Definition at line 82 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::GeodesicActiveContourLevelSetImageFilter::MemberFunctionType) (const Image &image1, const Image &image2)
private

Setup for member function dispatching

Definition at line 183 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

typedef RealPixelIDTypeList itk::simple::GeodesicActiveContourLevelSetImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 94 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

typedef GeodesicActiveContourLevelSetImageFilter itk::simple::GeodesicActiveContourLevelSetImageFilter::Self

Definition at line 84 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::GeodesicActiveContourLevelSetImageFilter::~GeodesicActiveContourLevelSetImageFilter ( )
virtual

Destructor

itk::simple::GeodesicActiveContourLevelSetImageFilter::GeodesicActiveContourLevelSetImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::GeodesicActiveContourLevelSetImageFilter::Execute ( const Image &  image1,
const Image &  image2 
)

Execute the filter on the input images

Image itk::simple::GeodesicActiveContourLevelSetImageFilter::Execute ( const Image &  image1,
const Image &  image2,
double  maximumRMSError,
double  propagationScaling,
double  curvatureScaling,
double  advectionScaling,
uint32_t  numberOfIterations,
bool  reverseExpansionDirection 
)

Execute the filter on the input images with the given parameters

template<class TImageType >
Image itk::simple::GeodesicActiveContourLevelSetImageFilter::ExecuteInternal ( const Image &  image1,
const Image &  image2 
)
private
double itk::simple::GeodesicActiveContourLevelSetImageFilter::GetAdvectionScaling ( ) const
inline

Definition at line 128 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

double itk::simple::GeodesicActiveContourLevelSetImageFilter::GetCurvatureScaling ( ) const
inline

Definition at line 120 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

uint32_t itk::simple::GeodesicActiveContourLevelSetImageFilter::GetElapsedIterations ( ) const
inline

Number of iterations run.

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 155 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

double itk::simple::GeodesicActiveContourLevelSetImageFilter::GetMaximumRMSError ( ) const
inline

Definition at line 104 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 166 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

uint32_t itk::simple::GeodesicActiveContourLevelSetImageFilter::GetNumberOfIterations ( ) const
inline

Definition at line 136 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

double itk::simple::GeodesicActiveContourLevelSetImageFilter::GetPropagationScaling ( ) const
inline

Definition at line 112 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

bool itk::simple::GeodesicActiveContourLevelSetImageFilter::GetReverseExpansionDirection ( ) const
inline

Definition at line 148 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

double itk::simple::GeodesicActiveContourLevelSetImageFilter::GetRMSChange ( ) const
inline

The Root Mean Square of the levelset upon termination.

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 163 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::ReverseExpansionDirectionOff ( )
inline

Definition at line 144 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::ReverseExpansionDirectionOn ( )
inline

Set the value of ReverseExpansionDirection to true or false respectfully.

Definition at line 143 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::SetAdvectionScaling ( double  AdvectionScaling)
inline

Definition at line 124 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::SetCurvatureScaling ( double  CurvatureScaling)
inline

Definition at line 116 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::SetMaximumRMSError ( double  MaximumRMSError)
inline

Definition at line 100 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::SetNumberOfIterations ( uint32_t  NumberOfIterations)
inline

Definition at line 132 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::SetPropagationScaling ( double  PropagationScaling)
inline

Definition at line 108 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

Self& itk::simple::GeodesicActiveContourLevelSetImageFilter::SetReverseExpansionDirection ( bool  ReverseExpansionDirection)
inline

Definition at line 140 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >
friend

Definition at line 187 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

Member Data Documentation

double itk::simple::GeodesicActiveContourLevelSetImageFilter::m_AdvectionScaling
private

Definition at line 199 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

double itk::simple::GeodesicActiveContourLevelSetImageFilter::m_CurvatureScaling
private

Definition at line 197 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

uint32_t itk::simple::GeodesicActiveContourLevelSetImageFilter::m_ElapsedIterations
private

Definition at line 205 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

double itk::simple::GeodesicActiveContourLevelSetImageFilter::m_MaximumRMSError
private

Definition at line 193 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

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

Definition at line 189 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

uint32_t itk::simple::GeodesicActiveContourLevelSetImageFilter::m_NumberOfIterations
private

Definition at line 201 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

double itk::simple::GeodesicActiveContourLevelSetImageFilter::m_PropagationScaling
private

Definition at line 195 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

bool itk::simple::GeodesicActiveContourLevelSetImageFilter::m_ReverseExpansionDirection
private

Definition at line 203 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

double itk::simple::GeodesicActiveContourLevelSetImageFilter::m_RMSChange
private

Definition at line 207 of file sitkGeodesicActiveContourLevelSetImageFilter.h.

The documentation for this class was generated from the following file:
Generated on Thu Jan 16 2020 20:47:21 for SimpleITK by   doxygen 1.8.9.1