SimpleITK  
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 58 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.
 
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.
 
bool GetUseImageSpacing () const
 
double GetVolume () const
 
double GetVolumeMatchingWeight () const
 
 ScalarChanAndVeseDenseLevelSetImageFilter ()
 
void SetAreaWeight (double AreaWeight)
 
void SetCurvatureWeight (double CurvatureWeight)
 
void SetEpsilon (double Epsilon)
 
void SetHeavisideStepFunction (HeavisideStepFunctionType HeavisideStepFunction)
 
void SetLambda1 (double Lambda1)
 
void SetLambda2 (double Lambda2)
 
void SetMaximumRMSError (double MaximumRMSError)
 
void SetNumberOfIterations (uint32_t NumberOfIterations)
 
void SetReinitializationSmoothingWeight (double ReinitializationSmoothingWeight)
 
void SetUseImageSpacing (bool UseImageSpacing)
 
void SetVolume (double Volume)
 
void SetVolumeMatchingWeight (double VolumeMatchingWeight)
 
std::string ToString () const
 
void UseImageSpacingOff ()
 
void 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.
 
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_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 }
 
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.
 
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::ProcessObjectGetActiveProcess ()
 
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
 
NonCopyableoperator= (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::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)
 

Member Typedef Documentation

◆ MemberFunctionType

Initial value:
Image (Self::*)(const Image *
initialImage, const Image *
featureImage)
The Image class for SimpleITK.
Definition sitkImage.h:77

Setup for member function dispatching

Definition at line 245 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

◆ PixelIDTypeList

◆ Self

Member Enumeration Documentation

◆ HeavisideStepFunctionType

Enumerator
AtanRegularizedHeaviside 
SinRegularizedHeaviside 
Heaviside 

Definition at line 184 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 149 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_AreaWeight.

◆ GetCurvatureWeight()

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

◆ 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 223 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_ElapsedIterations.

◆ GetEpsilon()

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

Definition at line 127 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_Epsilon.

◆ GetHeavisideStepFunction()

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

◆ GetLambda1()

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

Definition at line 105 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_Lambda1.

◆ GetLambda2()

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

Definition at line 116 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_Lambda2.

◆ GetMaximumRMSError()

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

Definition at line 83 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_MaximumRMSError.

◆ GetMemberFunctionFactory()

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

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 233 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

◆ GetNumberOfIterations()

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

◆ GetReinitializationSmoothingWeight()

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

◆ 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 230 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_RMSChange.

◆ 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 215 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_UseImageSpacing.

◆ GetVolume()

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

Definition at line 171 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_Volume.

◆ GetVolumeMatchingWeight()

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

◆ SetAreaWeight()

void itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetAreaWeight ( double AreaWeight)
inline

Definition at line 144 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_AreaWeight.

◆ SetCurvatureWeight()

void itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetCurvatureWeight ( double CurvatureWeight)
inline

◆ SetEpsilon()

void itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetEpsilon ( double Epsilon)
inline

Definition at line 122 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_Epsilon.

◆ SetHeavisideStepFunction()

void itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetHeavisideStepFunction ( HeavisideStepFunctionType HeavisideStepFunction)
inline

◆ SetLambda1()

void itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetLambda1 ( double Lambda1)
inline

Definition at line 100 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_Lambda1.

◆ SetLambda2()

void itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetLambda2 ( double Lambda2)
inline

Definition at line 111 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_Lambda2.

◆ SetMaximumRMSError()

void itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetMaximumRMSError ( double MaximumRMSError)
inline

Definition at line 78 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_MaximumRMSError.

◆ SetNumberOfIterations()

void itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetNumberOfIterations ( uint32_t NumberOfIterations)
inline

◆ SetReinitializationSmoothingWeight()

void itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetReinitializationSmoothingWeight ( double ReinitializationSmoothingWeight)
inline

◆ SetUseImageSpacing()

void 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 202 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_UseImageSpacing.

Referenced by UseImageSpacingOff(), and UseImageSpacingOn().

◆ SetVolume()

void itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetVolume ( double Volume)
inline

Definition at line 166 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References m_Volume.

◆ SetVolumeMatchingWeight()

void itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetVolumeMatchingWeight ( double VolumeMatchingWeight)
inline

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

◆ UseImageSpacingOff()

void itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::UseImageSpacingOff ( )
inline

◆ UseImageSpacingOn()

void itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::UseImageSpacingOn ( )
inline

Set the value of UseImageSpacing to true or false respectfully.

Definition at line 207 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

References SetUseImageSpacing().

Friends And Related Symbol Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_AreaWeight

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

◆ m_CurvatureWeight

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

◆ m_ElapsedIterations

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

◆ m_Epsilon

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

Definition at line 268 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Referenced by GetEpsilon(), and SetEpsilon().

◆ m_HeavisideStepFunction

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

◆ m_Lambda1

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

Definition at line 262 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Referenced by GetLambda1(), and SetLambda1().

◆ m_Lambda2

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

Definition at line 265 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Referenced by GetLambda2(), and SetLambda2().

◆ m_MaximumRMSError

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

◆ m_NumberOfIterations

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

◆ m_ReinitializationSmoothingWeight

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

◆ m_RMSChange

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

Definition at line 293 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Referenced by GetRMSChange().

◆ m_UseImageSpacing

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

◆ m_Volume

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

Definition at line 280 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Referenced by GetVolume(), and SetVolume().

◆ m_VolumeMatchingWeight

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

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