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

Public Types

enum  HeavisideStepFunctionType {
  AtanRegularizedHeaviside,
  SinRegularizedHeaviside,
  Heaviside
}
 
typedef RealPixelIDTypeList PixelIDTypeList
 
typedef ScalarChanAndVeseDenseLevelSetImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 0 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &initialImage, const Image &featureImage)
 
Image Execute (const Image &initialImage, const Image &featureImage, double maximumRMSError, uint32_t numberOfIterations, double lambda1, double lambda2, double epsilon, double curvatureWeight, double areaWeight, double reinitializationSmoothingWeight, double volume, double volumeMatchingWeight, ScalarChanAndVeseDenseLevelSetImageFilter::HeavisideStepFunctionType heavisideStepFunction, bool useImageSpacing)
 
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 ()
 
SelfSetAreaWeight (double AreaWeight)
 
SelfSetCurvatureWeight (double CurvatureWeight)
 
SelfSetEpsilon (double Epsilon)
 
SelfSetHeavisideStepFunction (HeavisideStepFunctionType HeavisideStepFunction)
 
SelfSetLambda1 (double Lambda1)
 
SelfSetLambda2 (double Lambda2)
 
SelfSetMaximumRMSError (double MaximumRMSError)
 
SelfSetNumberOfIterations (uint32_t NumberOfIterations)
 
SelfSetReinitializationSmoothingWeight (double ReinitializationSmoothingWeight)
 
SelfSetUseImageSpacing (bool UseImageSpacing)
 
SelfSetVolume (double Volume)
 
SelfSetVolumeMatchingWeight (double VolumeMatchingWeight)
 
std::string ToString () const
 
SelfUseImageSpacingOff ()
 
SelfUseImageSpacingOn ()
 
virtual ~ScalarChanAndVeseDenseLevelSetImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 0 >
 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 *initialImage, const Image *featureImage)
 

Private Member Functions

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

Private Attributes

double m_AreaWeight
 
double m_CurvatureWeight
 
uint32_t m_ElapsedIterations
 
double m_Epsilon
 
HeavisideStepFunctionType m_HeavisideStepFunction
 
double m_Lambda1
 
double m_Lambda2
 
double m_MaximumRMSError
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
uint32_t m_NumberOfIterations
 
double m_ReinitializationSmoothingWeight
 
double m_RMSChange
 
bool m_UseImageSpacing
 
double m_Volume
 
double m_VolumeMatchingWeight
 

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

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" http://www.insight-journal.org/browse/publication/642 https://hdl.handle.net/10380/3055

That is based on the papers: "Level Set Segmentation: Active Contours without edge" http://www.insight-journal.org/browse/publication/322 https://hdl.handle.net/1926/1532

and

"Level set segmentation using coupled active surfaces" http://www.insight-journal.org/browse/publication/323 https://hdl.handle.net/1926/1533

See also
itk::simple::ScalarChanAndVeseDenseLevelSet for the procedural interface
itk::ScalarChanAndVeseDenseLevelSetImageFilter for the Doxygen on the original ITK class.

Definition at line 60 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::MemberFunctionType) (const Image *initialImage, const Image *featureImage)
private

Setup for member function dispatching

Definition at line 215 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Define the pixels types supported by this filter

Definition at line 72 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Member Enumeration Documentation

Enumerator
AtanRegularizedHeaviside 
SinRegularizedHeaviside 
Heaviside 

Definition at line 156 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Constructor & Destructor Documentation

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

Destructor

itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::ScalarChanAndVeseDenseLevelSetImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::Execute ( const Image initialImage,
const Image featureImage,
double  maximumRMSError,
uint32_t  numberOfIterations,
double  lambda1,
double  lambda2,
double  epsilon,
double  curvatureWeight,
double  areaWeight,
double  reinitializationSmoothingWeight,
double  volume,
double  volumeMatchingWeight,
ScalarChanAndVeseDenseLevelSetImageFilter::HeavisideStepFunctionType  heavisideStepFunction,
bool  useImageSpacing 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::ExecuteInternal ( const Image initialImage,
const Image featureImage 
)
private
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetAreaWeight ( ) const
inline
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetCurvatureWeight ( ) const
inline
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 187 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetEpsilon ( ) const
inline
HeavisideStepFunctionType itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetHeavisideStepFunction ( ) const
inline
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetLambda1 ( ) const
inline
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetLambda2 ( ) const
inline
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetMaximumRMSError ( ) const
inline
std::string itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 198 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

uint32_t itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetNumberOfIterations ( ) const
inline
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetReinitializationSmoothingWeight ( ) const
inline
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 195 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

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

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetVolume ( ) const
inline
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::GetVolumeMatchingWeight ( ) const
inline
Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetAreaWeight ( double  AreaWeight)
inline
Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetCurvatureWeight ( double  CurvatureWeight)
inline
Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetEpsilon ( double  Epsilon)
inline
Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetHeavisideStepFunction ( HeavisideStepFunctionType  HeavisideStepFunction)
inline
Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetLambda1 ( double  Lambda1)
inline
Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetLambda2 ( double  Lambda2)
inline
Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetMaximumRMSError ( double  MaximumRMSError)
inline
Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetNumberOfIterations ( uint32_t  NumberOfIterations)
inline
Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetReinitializationSmoothingWeight ( double  ReinitializationSmoothingWeight)
inline
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 170 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetVolume ( double  Volume)
inline
Self& itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::SetVolumeMatchingWeight ( double  VolumeMatchingWeight)
inline
std::string itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

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

Set the value of UseImageSpacing to true or false respectfully.

Definition at line 173 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.

Friends And Related Function Documentation

Member Data Documentation

double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_AreaWeight
private
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_CurvatureWeight
private
uint32_t itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_ElapsedIterations
private
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_Epsilon
private
HeavisideStepFunctionType itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_HeavisideStepFunction
private
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_Lambda1
private
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_Lambda2
private
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_MaximumRMSError
private
nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_MemberFactory
private
uint32_t itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_NumberOfIterations
private
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_ReinitializationSmoothingWeight
private
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_RMSChange
private
bool itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_UseImageSpacing
private
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_Volume
private
double itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::m_VolumeMatchingWeight
private

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