SimpleITK
|
Dense implementation of the Chan and Vese multiphase level set image filter. More...
#include <sitkScalarChanAndVeseDenseLevelSetImageFilter.h>
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.
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
Definition at line 55 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Public Types | |
enum | HeavisideStepFunctionType { AtanRegularizedHeaviside , SinRegularizedHeaviside , Heaviside } |
using | PixelIDTypeList = RealPixelIDTypeList |
using | Self = ScalarChanAndVeseDenseLevelSetImageFilter |
![]() | |
using | Self = ImageFilter |
![]() | |
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 () | |
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 () |
![]() | |
ImageFilter () | |
virtual | ~ImageFilter ()=0 |
![]() | |
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 = 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 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. | |
![]() | |
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) |
![]() | |
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) |
![]() | |
NonCopyable ()=default | |
NonCopyable (const NonCopyable &)=delete | |
NonCopyable & | operator= (const NonCopyable &)=delete |
![]() | |
template<class TImageType> | |
static void | FixNonZeroIndex (TImageType *img) |
![]() | |
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) |
|
private |
Setup for member function dispatching
Definition at line 207 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Define the pixels types supported by this filter
Definition at line 67 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
using itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::Self = ScalarChanAndVeseDenseLevelSetImageFilter |
Definition at line 57 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Enumerator | |
---|---|
AtanRegularizedHeaviside | |
SinRegularizedHeaviside | |
Heaviside |
Definition at line 150 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
|
virtual |
Destructor
itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::ScalarChanAndVeseDenseLevelSetImageFilter | ( | ) |
Default Constructor that takes no arguments and initializes default parameters
Image itk::simple::ScalarChanAndVeseDenseLevelSetImageFilter::Execute | ( | const Image & | initialImage, |
const Image & | featureImage ) |
Execute the filter on the input image
|
private |
Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.
|
inline |
Definition at line 124 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_AreaWeight.
|
inline |
Definition at line 116 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_CurvatureWeight.
|
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.
References m_ElapsedIterations.
|
inline |
Definition at line 108 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_Epsilon.
|
inline |
Definition at line 158 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_HeavisideStepFunction.
|
inline |
Definition at line 92 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_Lambda1.
|
inline |
Definition at line 100 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_Lambda2.
|
inline |
Definition at line 76 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_MaximumRMSError.
|
inlinevirtual |
Name of this class
Implements itk::simple::ProcessObject.
Definition at line 193 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
|
inline |
Definition at line 84 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_NumberOfIterations.
|
inline |
Definition at line 132 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_ReinitializationSmoothingWeight.
|
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.
References m_RMSChange.
|
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.
References m_UseImageSpacing.
|
inline |
Definition at line 140 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_Volume.
|
inline |
Definition at line 148 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_VolumeMatchingWeight.
|
inline |
Definition at line 120 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_AreaWeight.
|
inline |
Definition at line 112 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_CurvatureWeight.
|
inline |
Definition at line 104 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_Epsilon.
|
inline |
Definition at line 154 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_HeavisideStepFunction.
|
inline |
Definition at line 88 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_Lambda1.
|
inline |
Definition at line 96 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_Lambda2.
|
inline |
Definition at line 72 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_MaximumRMSError.
|
inline |
Definition at line 80 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_NumberOfIterations.
|
inline |
Definition at line 128 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_ReinitializationSmoothingWeight.
|
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.
References m_UseImageSpacing.
Referenced by UseImageSpacingOff(), and UseImageSpacingOn().
|
inline |
Definition at line 136 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_Volume.
|
inline |
Definition at line 144 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References m_VolumeMatchingWeight.
|
virtual |
Print ourselves out
Reimplemented from itk::simple::ProcessObject.
|
inline |
Definition at line 168 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References SetUseImageSpacing().
|
inline |
Set the value of UseImageSpacing to true or false respectfully.
Definition at line 167 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References SetUseImageSpacing().
|
friend |
Definition at line 208 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
References ExecuteInternal().
|
private |
Definition at line 235 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Referenced by GetAreaWeight(), and SetAreaWeight().
|
private |
Definition at line 232 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Referenced by GetCurvatureWeight(), and SetCurvatureWeight().
|
private |
Definition at line 252 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Referenced by GetElapsedIterations().
|
private |
Definition at line 229 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Referenced by GetEpsilon(), and SetEpsilon().
|
private |
Definition at line 247 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Referenced by GetHeavisideStepFunction(), and SetHeavisideStepFunction().
|
private |
Definition at line 223 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Referenced by GetLambda1(), and SetLambda1().
|
private |
Definition at line 226 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Referenced by GetLambda2(), and SetLambda2().
|
private |
Definition at line 217 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Referenced by GetMaximumRMSError(), and SetMaximumRMSError().
|
private |
Definition at line 213 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
|
private |
Definition at line 220 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Referenced by GetNumberOfIterations(), and SetNumberOfIterations().
|
private |
Definition at line 238 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Referenced by GetReinitializationSmoothingWeight(), and SetReinitializationSmoothingWeight().
|
private |
Definition at line 254 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Referenced by GetRMSChange().
|
private |
Definition at line 249 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Referenced by GetUseImageSpacing(), and SetUseImageSpacing().
|
private |
Definition at line 241 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Referenced by GetVolume(), and SetVolume().
|
private |
Definition at line 244 of file sitkScalarChanAndVeseDenseLevelSetImageFilter.h.
Referenced by GetVolumeMatchingWeight(), and SetVolumeMatchingWeight().