itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter Class Reference

Dense implementation of the Chan and Vese multiphase level set image filter. More...

#include <sitkScalarChanAndVeseDenseLevelSetImageFilter.h>

Inheritance diagram for itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter:

Collaboration diagram for itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter:

Detailed Description

Dense implementation of the Chan and Vese multiphase level set image filter.

This code was adapted from the paper: "An active contour model without edges" T. Chan and L. Vese. In Scale-Space Theories in Computer Vision, pages 141-151, 1999.

Author

Mosaliganti K., Smith B., Gelas A., Gouaillard A., Megason S.

This code was taken from the Insight Journal paper: "Cell Tracking using Coupled Active Surfaces for Nuclei and Membranes" https://doi.org/10.54294/wvwmf8 That is based on the papers: "Level Set Segmentation: Active Contours without edge" https://doi.org/10.54294/8jk6oy

and

"Level set segmentation using coupled active surfaces" https://doi.org/10.54294/23ugmy

See also

itk::simple::ScalarChanAndVeseDenseLevelSet for the procedural interface

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

Definition at line 55 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Public Types
enum	HeavisideStepFunctionType {   AtanRegularizedHeaviside,   SinRegularizedHeaviside,   Heaviside }
using	PixelIDTypeList = RealPixelIDTypeList
using	Self = ScalarChanAndVeseDenseLevelSetImageFilter
Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter
Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
Image	Execute (const Image &initialImage, const Image &featureImage)
double	GetAreaWeight () const
double	GetCurvatureWeight () const
uint32_t	GetElapsedIterations () const
	Number of iterations run. More...
double	GetEpsilon () const
HeavisideStepFunctionType	GetHeavisideStepFunction () const
double	GetLambda1 () const
double	GetLambda2 () const
double	GetMaximumRMSError () const
std::string	GetName () const
uint32_t	GetNumberOfIterations () const
double	GetReinitializationSmoothingWeight () const
double	GetRMSChange () const
	The Root Mean Square of the levelset upon termination. More...
bool	GetUseImageSpacing () const
double	GetVolume () const
double	GetVolumeMatchingWeight () const
	ScalarChanAndVeseDenseLevelSetImageFilter ()
Self &	SetAreaWeight (double AreaWeight)
Self &	SetCurvatureWeight (double CurvatureWeight)
Self &	SetEpsilon (double Epsilon)
Self &	SetHeavisideStepFunction (HeavisideStepFunctionType HeavisideStepFunction)
Self &	SetLambda1 (double Lambda1)
Self &	SetLambda2 (double Lambda2)
Self &	SetMaximumRMSError (double MaximumRMSError)
Self &	SetNumberOfIterations (uint32_t NumberOfIterations)
Self &	SetReinitializationSmoothingWeight (double ReinitializationSmoothingWeight)
Self &	SetUseImageSpacing (bool UseImageSpacing)
Self &	SetVolume (double Volume)
Self &	SetVolumeMatchingWeight (double VolumeMatchingWeight)
std::string	ToString () const
Self &	UseImageSpacingOff ()
Self &	UseImageSpacingOn ()
virtual	~ScalarChanAndVeseDenseLevelSetImageFilter ()
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 *initialImage, const Image *featureImage)

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

Private Attributes
double	m_AreaWeight {0.0}
double	m_CurvatureWeight {1.0}
uint32_t	m_ElapsedIterations {0}
double	m_Epsilon {1.0}
HeavisideStepFunctionType	m_HeavisideStepFunction {itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::AtanRegularizedHeaviside}
double	m_Lambda1 {1.0}
double	m_Lambda2 {1.0}
double	m_MaximumRMSError {0.02}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
uint32_t	m_NumberOfIterations {1000u}
double	m_ReinitializationSmoothingWeight {0.0}
double	m_RMSChange {0.0}
bool	m_UseImageSpacing {true}
double	m_Volume {0.0}
double	m_VolumeMatchingWeight {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. 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::ScalarChanAndVeseDenseLevelSetImageFilter::MemberFunctionType = Image (Self::*)( const Image * initialImage, const Image * featureImage )

private

Setup for member function dispatching

Definition at line 207 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

PixelIDTypeList

using itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::PixelIDTypeList = RealPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 67 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Self

using itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::Self = ScalarChanAndVeseDenseLevelSetImageFilter

Definition at line 57 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Member Enumeration Documentation

HeavisideStepFunctionType

enum itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::HeavisideStepFunctionType

Enumerator
AtanRegularizedHeaviside
SinRegularizedHeaviside
Heaviside

Definition at line 150 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Constructor & Destructor Documentation

~ScalarChanAndVeseDenseLevelSetImageFilter()

virtual itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::~ScalarChanAndVeseDenseLevelSetImageFilter ( )

virtual

Destructor

ScalarChanAndVeseDenseLevelSetImageFilter()

itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::ScalarChanAndVeseDenseLevelSetImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute()

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

Execute the filter on the input image

ExecuteInternal()

template<class TImageType >

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

private

GetAreaWeight()

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetAreaWeight ( ) const

inline

Definition at line 124 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

GetCurvatureWeight()

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetCurvatureWeight ( ) const

inline

Definition at line 116 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

GetElapsedIterations()

uint32_t itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::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 181 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

GetEpsilon()

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetEpsilon ( ) const

inline

Definition at line 108 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

GetHeavisideStepFunction()

HeavisideStepFunctionType itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetHeavisideStepFunction ( ) const

inline

Definition at line 158 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

GetLambda1()

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetLambda1 ( ) const

inline

Definition at line 92 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

GetLambda2()

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetLambda2 ( ) const

inline

Definition at line 100 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

GetMaximumRMSError()

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

inline

Definition at line 76 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 193 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

GetNumberOfIterations()

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

inline

Definition at line 84 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

GetReinitializationSmoothingWeight()

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetReinitializationSmoothingWeight ( ) const

inline

Definition at line 132 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

GetRMSChange()

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::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 189 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

GetUseImageSpacing()

bool itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetUseImageSpacing ( ) const

inline

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOn.

Definition at line 174 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

GetVolume()

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetVolume ( ) const

inline

Definition at line 140 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

GetVolumeMatchingWeight()

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetVolumeMatchingWeight ( ) const

inline

Definition at line 148 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

SetAreaWeight()

Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetAreaWeight ( double  AreaWeight )

inline

Definition at line 120 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

SetCurvatureWeight()

Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetCurvatureWeight ( double  CurvatureWeight )

inline

Definition at line 112 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

SetEpsilon()

Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetEpsilon ( double  Epsilon )

inline

Definition at line 104 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

SetHeavisideStepFunction()

Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetHeavisideStepFunction ( HeavisideStepFunctionType  HeavisideStepFunction )

inline

Definition at line 154 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

SetLambda1()

Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetLambda1 ( double  Lambda1 )

inline

Definition at line 88 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

SetLambda2()

Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetLambda2 ( double  Lambda2 )

inline

Definition at line 96 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

SetMaximumRMSError()

Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetMaximumRMSError ( double  MaximumRMSError )

inline

Definition at line 72 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

SetNumberOfIterations()

Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetNumberOfIterations ( uint32_t  NumberOfIterations )

inline

Definition at line 80 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

SetReinitializationSmoothingWeight()

Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetReinitializationSmoothingWeight ( double  ReinitializationSmoothingWeight )

inline

Definition at line 128 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

SetUseImageSpacing()

Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetUseImageSpacing ( bool  UseImageSpacing )

inline

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOn.

Definition at line 164 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

SetVolume()

Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetVolume ( double  Volume )

inline

Definition at line 136 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

SetVolumeMatchingWeight()

Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetVolumeMatchingWeight ( double  VolumeMatchingWeight )

inline

Definition at line 144 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

UseImageSpacingOff()

Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::UseImageSpacingOff ( )

inline

Definition at line 168 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

UseImageSpacingOn()

Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::UseImageSpacingOn ( )

inline

Set the value of UseImageSpacing to true or false respectfully.

Definition at line 167 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Friends And Related Function Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 211 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Member Data Documentation

m_AreaWeight

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_AreaWeight {0.0}

private

Definition at line 235 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

m_CurvatureWeight

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_CurvatureWeight {1.0}

private

Definition at line 232 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

m_ElapsedIterations

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

private

Definition at line 252 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

m_Epsilon

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_Epsilon {1.0}

private

Definition at line 229 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

m_HeavisideStepFunction

HeavisideStepFunctionType itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_HeavisideStepFunction {itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::AtanRegularizedHeaviside}

private

Definition at line 247 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

m_Lambda1

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_Lambda1 {1.0}

private

Definition at line 223 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

m_Lambda2

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_Lambda2 {1.0}

private

Definition at line 226 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

m_MaximumRMSError

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

private

Definition at line 217 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

m_MemberFactory

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

private

Definition at line 213 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

m_NumberOfIterations

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

private

Definition at line 220 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

m_ReinitializationSmoothingWeight

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_ReinitializationSmoothingWeight {0.0}

private

Definition at line 238 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

m_RMSChange

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

private

Definition at line 254 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

m_UseImageSpacing

bool itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_UseImageSpacing {true}

private

Definition at line 249 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

m_Volume

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_Volume {0.0}

private

Definition at line 241 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

m_VolumeMatchingWeight

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_VolumeMatchingWeight {0.0}

private

Definition at line 244 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

---

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

• sitkScalarChanAndVeseDenseLevelSetImageFilter.h