SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::MorphologicalWatershedImageFilter Class Reference

Watershed segmentation implementation with morphological operators. More...

#include <sitkMorphologicalWatershedImageFilter.h>

+ Inheritance diagram for itk::simple::MorphologicalWatershedImageFilter:
+ Collaboration diagram for itk::simple::MorphologicalWatershedImageFilter:

Public Types

using PixelIDTypeList = ScalarPixelIDTypeList
 
using Self = MorphologicalWatershedImageFilter
 
- 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 &image1)
 
SelfFullyConnectedOff ()
 
SelfFullyConnectedOn ()
 
bool GetFullyConnected () const
 
double GetLevel () const
 
bool GetMarkWatershedLine () const
 
std::string GetName () const
 
SelfMarkWatershedLineOff ()
 
SelfMarkWatershedLineOn ()
 
 MorphologicalWatershedImageFilter ()
 
SelfSetFullyConnected (bool FullyConnected)
 
SelfSetLevel (double Level)
 
SelfSetMarkWatershedLine (bool MarkWatershedLine)
 
std::string ToString () const
 
virtual ~MorphologicalWatershedImageFilter ()
 
- 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 &image1)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1)
 

Private Attributes

bool m_FullyConnected {false}
 
double m_Level {0.0}
 
bool m_MarkWatershedLine {true}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 

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::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<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)
 

Detailed Description

Watershed segmentation implementation with morphological operators.

Watershed pixel are labeled 0. TOutputImage should be an integer type. Labels of output image are in no particular order. You can reorder the labels such that object labels are consecutive and sorted based on object size by passing the output of this filter to a RelabelComponentImageFilter .

The morphological watershed transform algorithm is described in Chapter 9.2 of Pierre Soille's book "Morphological Image Analysis: Principles and Applications", Second Edition, Springer, 2003.

This code was contributed in the Insight Journal paper: "The watershed transform in ITK - discussion and new developments" by Beare R., Lehmann G. https://hdl.handle.net/1926/202 http://www.insight-journal.org/browse/publication/92

Author
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.
See also
WatershedImageFilter , MorphologicalWatershedFromMarkersImageFilter
itk::simple::MorphologicalWatershed for the procedural interface
itk::MorphologicalWatershedImageFilter for the Doxygen on the original ITK class.

Definition at line 52 of file sitkMorphologicalWatershedImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 118 of file sitkMorphologicalWatershedImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 64 of file sitkMorphologicalWatershedImageFilter.h.

◆ Self

Definition at line 54 of file sitkMorphologicalWatershedImageFilter.h.

Constructor & Destructor Documentation

◆ ~MorphologicalWatershedImageFilter()

virtual itk::simple::MorphologicalWatershedImageFilter::~MorphologicalWatershedImageFilter ( )
virtual

Destructor

◆ MorphologicalWatershedImageFilter()

itk::simple::MorphologicalWatershedImageFilter::MorphologicalWatershedImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::MorphologicalWatershedImageFilter::Execute ( const Image image1)

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::MorphologicalWatershedImageFilter::ExecuteInternal ( const Image image1)
private

◆ FullyConnectedOff()

Self& itk::simple::MorphologicalWatershedImageFilter::FullyConnectedOff ( )
inline

Definition at line 96 of file sitkMorphologicalWatershedImageFilter.h.

◆ FullyConnectedOn()

Self& itk::simple::MorphologicalWatershedImageFilter::FullyConnectedOn ( )
inline

Set the value of FullyConnected to true or false respectfully.

Definition at line 95 of file sitkMorphologicalWatershedImageFilter.h.

◆ GetFullyConnected()

bool itk::simple::MorphologicalWatershedImageFilter::GetFullyConnected ( ) const
inline

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Definition at line 101 of file sitkMorphologicalWatershedImageFilter.h.

◆ GetLevel()

double itk::simple::MorphologicalWatershedImageFilter::GetLevel ( ) const
inline

Definition at line 73 of file sitkMorphologicalWatershedImageFilter.h.

◆ GetMarkWatershedLine()

bool itk::simple::MorphologicalWatershedImageFilter::GetMarkWatershedLine ( ) const
inline

Set/Get whether the watershed pixel must be marked or not. Default is true. Set it to false do not only avoid writing watershed pixels, it also decrease algorithm complexity.

Definition at line 87 of file sitkMorphologicalWatershedImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 104 of file sitkMorphologicalWatershedImageFilter.h.

◆ MarkWatershedLineOff()

Self& itk::simple::MorphologicalWatershedImageFilter::MarkWatershedLineOff ( )
inline

Definition at line 82 of file sitkMorphologicalWatershedImageFilter.h.

◆ MarkWatershedLineOn()

Self& itk::simple::MorphologicalWatershedImageFilter::MarkWatershedLineOn ( )
inline

Set the value of MarkWatershedLine to true or false respectfully.

Definition at line 81 of file sitkMorphologicalWatershedImageFilter.h.

◆ SetFullyConnected()

Self& itk::simple::MorphologicalWatershedImageFilter::SetFullyConnected ( bool  FullyConnected)
inline

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Definition at line 92 of file sitkMorphologicalWatershedImageFilter.h.

◆ SetLevel()

Self& itk::simple::MorphologicalWatershedImageFilter::SetLevel ( double  Level)
inline

Definition at line 69 of file sitkMorphologicalWatershedImageFilter.h.

◆ SetMarkWatershedLine()

Self& itk::simple::MorphologicalWatershedImageFilter::SetMarkWatershedLine ( bool  MarkWatershedLine)
inline

Set/Get whether the watershed pixel must be marked or not. Default is true. Set it to false do not only avoid writing watershed pixels, it also decrease algorithm complexity.

Definition at line 78 of file sitkMorphologicalWatershedImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 122 of file sitkMorphologicalWatershedImageFilter.h.

Member Data Documentation

◆ m_FullyConnected

bool itk::simple::MorphologicalWatershedImageFilter::m_FullyConnected {false}
private

Definition at line 132 of file sitkMorphologicalWatershedImageFilter.h.

◆ m_Level

double itk::simple::MorphologicalWatershedImageFilter::m_Level {0.0}
private

Definition at line 127 of file sitkMorphologicalWatershedImageFilter.h.

◆ m_MarkWatershedLine

bool itk::simple::MorphologicalWatershedImageFilter::m_MarkWatershedLine {true}
private

Definition at line 129 of file sitkMorphologicalWatershedImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::MorphologicalWatershedImageFilter::m_MemberFactory
private

Definition at line 124 of file sitkMorphologicalWatershedImageFilter.h.


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