itk::simple::CannySegmentationLevelSetImageFilter Class Reference

Segments structures in images based on image features derived from pseudo-canny-edges. More...

#include <sitkCannySegmentationLevelSetImageFilter.h>

Inheritance diagram for itk::simple::CannySegmentationLevelSetImageFilter:

Collaboration diagram for itk::simple::CannySegmentationLevelSetImageFilter:

Detailed Description

Segments structures in images based on image features derived from pseudo-canny-edges.

IMPORTANT

The SegmentationLevelSetImageFilter class and the CannySegmentationLevelSetFunction class contain additional information necessary to the full understanding of how to use this filter.

OVERVIEW

This class is a level set method segmentation filter. It constructs a speed function which is designed to lock onto edges as detected by a Canny filter.

The CannySegmentationLevelSetImageFilter can be a tool for refining an existing segmentation, or it can be used to try to segment a region by itself. Like all other level-set based segmentation filters (see SegmentationLevelSetImageFilter ), it works by first constructing a scalar speed term and a vector advection field based on edge features in the image. The level set front is then moved according to these two terms with the addition of a third curvature term to control the smoothness of the solution.

The speed term is constructed as the Danielsson distance transform of the Canny edge image, as calculated by the CannyEdgeDetectionImageFilter . This scalar speed can be tuned in and out of the final evolution equation by setting the PropagationScaling parameter (a value of 0 removes the speed term).

The advection field term is constructed by minimizing Danielsson distance squared. i.e. \( \mbox{min} \int D^2 \Rightarrow D \nabla D \) . This term moves the level set down the gradient of the distance transform.

In practice, you may set the speed (propagation) term to zero if your initialization is already close to the edge you are interested in. If you are trying to segment a region by seeding with a small surface (blob, sphere) then you will likely want to add speed (propagation) to the equation so that the levelsets can expand along zero gradients. The relative influence of these two terms are controlled by the SetPropagationScaling and SetAdvectionScaling parameters.

INPUTS

This filter requires two inputs. The first input is a seed image. This seed image must contain an isosurface that you want to use as the seed for your segmentation. It can be a binary, graylevel, or floating point image. The only requirement is that it contain a closed isosurface that you will identify as the seed by setting the IsosurfaceValue parameter of the filter. For a binary image you will want to set your isosurface value halfway between your on and off values (i.e. for 0's and 1's, use an isosurface value of 0.5).

The second input is the feature image. This is the image from which the speed function will be calculated. For most applications, this is the image that you want to segment. The desired isosurface in your seed image should lie within the region of your feature image that you are trying to segment.

See SegmentationLevelSetImageFilter for more information on Inputs.

OUTPUTS

The filter outputs a single, scalar, real-valued image. Positive *values in the output image are inside the segmented region and negative *values in the image are outside of the inside region. The zero crossings of *the image correspond to the position of the level set front.

See SparseFieldLevelSetImageFilter and SegmentationLevelSetImageFilter for more information.

PARAMETERS

There are five parameters important for controlling the behavior of this filter.

(1) Threshold. Sets the thresholding value of the Canny edge detection. See CannyEdgeDetectionImageFilter for more information.

(2) Variance. Controls the smoothing parameter of the gaussian filtering done during Canny edge detection.

(3) CurvatureScaling. Controls the degree to which curvature influences the evolution of the level set. Higher values relative to Propagation and Advection scalings will yield a smoother surface.

(4) PropagationScaling. Scales the propagation (speed) term of the level set equation. Set this term to zero to allow the level set to flow only down the gradient of the distance transform.

(5) AdvectionScaling. Scales influence of the advection field relative to curvature and propagation terms.

See also

SegmentationLevelSetImageFilter

CannySegmentationLevelSetFunction ,

SparseFieldLevelSetImageFilter

itk::simple::CannySegmentationLevelSet for the procedural interface

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

Definition at line 140 of file sitkCannySegmentationLevelSetImageFilter.h.

Public Types
using	PixelIDTypeList = RealPixelIDTypeList
using	Self = CannySegmentationLevelSetImageFilter
Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter
Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
	CannySegmentationLevelSetImageFilter ()
Image	Execute (const Image &initialImage, const Image &featureImage)
Image	Execute (Image &&initialImage, const Image &featureImage)
double	GetAdvectionScaling () const
Image	GetCannyImage () const
double	GetCurvatureScaling () const
uint32_t	GetElapsedIterations () const
	Number of iterations run.
double	GetIsoSurfaceValue () const
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.
double	GetThreshold () const
double	GetVariance () const
void	ReverseExpansionDirectionOff ()
void	ReverseExpansionDirectionOn ()
void	SetAdvectionScaling (double AdvectionScaling)
void	SetCurvatureScaling (double CurvatureScaling)
void	SetIsoSurfaceValue (double IsoSurfaceValue)
void	SetMaximumRMSError (double MaximumRMSError)
void	SetNumberOfIterations (uint32_t NumberOfIterations)
void	SetPropagationScaling (double PropagationScaling)
void	SetReverseExpansionDirection (bool ReverseExpansionDirection)
void	SetThreshold (double Threshold)
void	SetVariance (double Variance)
std::string	ToString () const
virtual	~CannySegmentationLevelSetImageFilter ()
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

Private Member Functions
template<class TImageType>
Image	ExecuteInternal (const Image *initialImage, const Image *featureImage)

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

Private Attributes
double	m_AdvectionScaling { 1.0 }
Image	m_CannyImage { Image() }
double	m_CurvatureScaling { 1.0 }
uint32_t	m_ElapsedIterations { 0 }
bool	m_InPlace {false}
double	m_IsoSurfaceValue { 0.0 }
double	m_MaximumRMSError { 0.02 }
uint32_t	m_NumberOfIterations { 1000u }
double	m_PropagationScaling { 1.0 }
bool	m_ReverseExpansionDirection { false }
double	m_RMSChange { 0.0 }
double	m_Threshold { 0.0 }
double	m_Variance { 0.0 }

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::CannySegmentationLevelSetImageFilter::MemberFunctionType

private

Initial value:

 Image (Self::*)(const Image *
    initialImage, const Image *
    featureImage)

Setup for member function dispatching

Definition at line 304 of file sitkCannySegmentationLevelSetImageFilter.h.

PixelIDTypeList

using itk::simple::CannySegmentationLevelSetImageFilter::PixelIDTypeList = RealPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 152 of file sitkCannySegmentationLevelSetImageFilter.h.

Self

using itk::simple::CannySegmentationLevelSetImageFilter::Self = CannySegmentationLevelSetImageFilter

Definition at line 142 of file sitkCannySegmentationLevelSetImageFilter.h.

Constructor & Destructor Documentation

~CannySegmentationLevelSetImageFilter()

virtual itk::simple::CannySegmentationLevelSetImageFilter::~CannySegmentationLevelSetImageFilter ( )

virtual

Destructor

CannySegmentationLevelSetImageFilter()

itk::simple::CannySegmentationLevelSetImageFilter::CannySegmentationLevelSetImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute() [1/2]

Image itk::simple::CannySegmentationLevelSetImageFilter::Execute	(	const Image &	initialImage,
		const Image &	featureImage )

Execute() [2/2]

Image itk::simple::CannySegmentationLevelSetImageFilter::Execute	(	Image &&	initialImage,
		const Image &	featureImage )

Execute the filter on the input image

ExecuteInternal()

template<class TImageType>

Image itk::simple::CannySegmentationLevelSetImageFilter::ExecuteInternal ( const Image * initialImage, const Image * featureImage )

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

GetAdvectionScaling()

double itk::simple::CannySegmentationLevelSetImageFilter::GetAdvectionScaling ( ) const

inline

Definition at line 224 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_AdvectionScaling.

GetCannyImage()

Image itk::simple::CannySegmentationLevelSetImageFilter::GetCannyImage ( ) const

inline

Get the Canny image that was used to create the speed and advection images

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 286 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_CannyImage.

GetCurvatureScaling()

double itk::simple::CannySegmentationLevelSetImageFilter::GetCurvatureScaling ( ) const

inline

Definition at line 213 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_CurvatureScaling.

GetElapsedIterations()

uint32_t itk::simple::CannySegmentationLevelSetImageFilter::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 271 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_ElapsedIterations.

GetIsoSurfaceValue()

double itk::simple::CannySegmentationLevelSetImageFilter::GetIsoSurfaceValue ( ) const

inline

Definition at line 263 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_IsoSurfaceValue.

GetMaximumRMSError()

double itk::simple::CannySegmentationLevelSetImageFilter::GetMaximumRMSError ( ) const

inline

Definition at line 191 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_MaximumRMSError.

GetMemberFunctionFactory()

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

staticprivate

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 289 of file sitkCannySegmentationLevelSetImageFilter.h.

GetNumberOfIterations()

uint32_t itk::simple::CannySegmentationLevelSetImageFilter::GetNumberOfIterations ( ) const

inline

Definition at line 235 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_NumberOfIterations.

GetPropagationScaling()

double itk::simple::CannySegmentationLevelSetImageFilter::GetPropagationScaling ( ) const

inline

Definition at line 202 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_PropagationScaling.

GetReverseExpansionDirection()

bool itk::simple::CannySegmentationLevelSetImageFilter::GetReverseExpansionDirection ( ) const

inline

Definition at line 252 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_ReverseExpansionDirection.

GetRMSChange()

double itk::simple::CannySegmentationLevelSetImageFilter::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 278 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_RMSChange.

GetThreshold()

double itk::simple::CannySegmentationLevelSetImageFilter::GetThreshold ( ) const

inline

Set the Threshold parameter of the CannyEdgeDetectionImageFilter used by the underlying level set function.

Definition at line 167 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_Threshold.

GetVariance()

double itk::simple::CannySegmentationLevelSetImageFilter::GetVariance ( ) const

inline

Set the Variance parameter of the CannyEdgeDetectionImageFilter used by the underlying level set function.

Definition at line 180 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_Variance.

ReverseExpansionDirectionOff()

void itk::simple::CannySegmentationLevelSetImageFilter::ReverseExpansionDirectionOff ( )

inline

Definition at line 248 of file sitkCannySegmentationLevelSetImageFilter.h.

References SetReverseExpansionDirection().

ReverseExpansionDirectionOn()

void itk::simple::CannySegmentationLevelSetImageFilter::ReverseExpansionDirectionOn ( )

inline

Set the value of ReverseExpansionDirection to true or false respectfully.

Definition at line 246 of file sitkCannySegmentationLevelSetImageFilter.h.

References SetReverseExpansionDirection().

SetAdvectionScaling()

void itk::simple::CannySegmentationLevelSetImageFilter::SetAdvectionScaling ( double AdvectionScaling )

inline

Definition at line 219 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_AdvectionScaling.

SetCurvatureScaling()

void itk::simple::CannySegmentationLevelSetImageFilter::SetCurvatureScaling ( double CurvatureScaling )

inline

Definition at line 208 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_CurvatureScaling.

SetIsoSurfaceValue()

void itk::simple::CannySegmentationLevelSetImageFilter::SetIsoSurfaceValue ( double IsoSurfaceValue )

inline

Definition at line 258 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_IsoSurfaceValue.

SetMaximumRMSError()

void itk::simple::CannySegmentationLevelSetImageFilter::SetMaximumRMSError ( double MaximumRMSError )

inline

Definition at line 186 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_MaximumRMSError.

SetNumberOfIterations()

void itk::simple::CannySegmentationLevelSetImageFilter::SetNumberOfIterations ( uint32_t NumberOfIterations )

inline

Definition at line 230 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_NumberOfIterations.

SetPropagationScaling()

void itk::simple::CannySegmentationLevelSetImageFilter::SetPropagationScaling ( double PropagationScaling )

inline

Definition at line 197 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_PropagationScaling.

SetReverseExpansionDirection()

void itk::simple::CannySegmentationLevelSetImageFilter::SetReverseExpansionDirection ( bool ReverseExpansionDirection )

inline

Definition at line 241 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_ReverseExpansionDirection.

Referenced by ReverseExpansionDirectionOff(), and ReverseExpansionDirectionOn().

SetThreshold()

void itk::simple::CannySegmentationLevelSetImageFilter::SetThreshold ( double Threshold )

inline

Set the Threshold parameter of the CannyEdgeDetectionImageFilter used by the underlying level set function.

Definition at line 161 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_Threshold, and itk::simple::Threshold().

SetVariance()

void itk::simple::CannySegmentationLevelSetImageFilter::SetVariance ( double Variance )

inline

Set the Variance parameter of the CannyEdgeDetectionImageFilter used by the underlying level set function.

Definition at line 174 of file sitkCannySegmentationLevelSetImageFilter.h.

References m_Variance.

ToString()

std::string itk::simple::CannySegmentationLevelSetImageFilter::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 307 of file sitkCannySegmentationLevelSetImageFilter.h.

References ExecuteInternal().

Member Data Documentation

m_AdvectionScaling

double itk::simple::CannySegmentationLevelSetImageFilter::m_AdvectionScaling { 1.0 }

private

Definition at line 328 of file sitkCannySegmentationLevelSetImageFilter.h.

Referenced by GetAdvectionScaling(), and SetAdvectionScaling().

m_CannyImage

Image itk::simple::CannySegmentationLevelSetImageFilter::m_CannyImage { Image() }

private

Definition at line 342 of file sitkCannySegmentationLevelSetImageFilter.h.

Referenced by GetCannyImage().

m_CurvatureScaling

double itk::simple::CannySegmentationLevelSetImageFilter::m_CurvatureScaling { 1.0 }

private

Definition at line 325 of file sitkCannySegmentationLevelSetImageFilter.h.

Referenced by GetCurvatureScaling(), and SetCurvatureScaling().

m_ElapsedIterations

uint32_t itk::simple::CannySegmentationLevelSetImageFilter::m_ElapsedIterations { 0 }

private

Definition at line 340 of file sitkCannySegmentationLevelSetImageFilter.h.

Referenced by GetElapsedIterations().

m_InPlace

bool itk::simple::CannySegmentationLevelSetImageFilter::m_InPlace {false}

private

Definition at line 347 of file sitkCannySegmentationLevelSetImageFilter.h.

m_IsoSurfaceValue

double itk::simple::CannySegmentationLevelSetImageFilter::m_IsoSurfaceValue { 0.0 }

private

Definition at line 336 of file sitkCannySegmentationLevelSetImageFilter.h.

Referenced by GetIsoSurfaceValue(), and SetIsoSurfaceValue().

m_MaximumRMSError

double itk::simple::CannySegmentationLevelSetImageFilter::m_MaximumRMSError { 0.02 }

private

Definition at line 319 of file sitkCannySegmentationLevelSetImageFilter.h.

Referenced by GetMaximumRMSError(), and SetMaximumRMSError().

m_NumberOfIterations

uint32_t itk::simple::CannySegmentationLevelSetImageFilter::m_NumberOfIterations { 1000u }

private

Definition at line 331 of file sitkCannySegmentationLevelSetImageFilter.h.

Referenced by GetNumberOfIterations(), and SetNumberOfIterations().

m_PropagationScaling

double itk::simple::CannySegmentationLevelSetImageFilter::m_PropagationScaling { 1.0 }

private

Definition at line 322 of file sitkCannySegmentationLevelSetImageFilter.h.

Referenced by GetPropagationScaling(), and SetPropagationScaling().

m_ReverseExpansionDirection

bool itk::simple::CannySegmentationLevelSetImageFilter::m_ReverseExpansionDirection { false }

private

Definition at line 334 of file sitkCannySegmentationLevelSetImageFilter.h.

Referenced by GetReverseExpansionDirection(), and SetReverseExpansionDirection().

m_RMSChange

double itk::simple::CannySegmentationLevelSetImageFilter::m_RMSChange { 0.0 }

private

Definition at line 341 of file sitkCannySegmentationLevelSetImageFilter.h.

Referenced by GetRMSChange().

m_Threshold

double itk::simple::CannySegmentationLevelSetImageFilter::m_Threshold { 0.0 }

private

Definition at line 314 of file sitkCannySegmentationLevelSetImageFilter.h.

Referenced by GetThreshold(), and SetThreshold().

m_Variance

double itk::simple::CannySegmentationLevelSetImageFilter::m_Variance { 0.0 }

private

Definition at line 316 of file sitkCannySegmentationLevelSetImageFilter.h.

Referenced by GetVariance(), and SetVariance().

---

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

• sitkCannySegmentationLevelSetImageFilter.h