itk::simple::IsolatedWatershedImageFilter Class Reference

Isolate watershed basins using two seeds. More...

#include <sitkIsolatedWatershedImageFilter.h>

Inheritance diagram for itk::simple::IsolatedWatershedImageFilter:

Collaboration diagram for itk::simple::IsolatedWatershedImageFilter:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList
typedef IsolatedWatershedImageFilter	Self
Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter	Self
Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Image	Execute (const Image &image1)
Image	Execute (const Image &image1, const std::vector< uint32_t > &seed1, const std::vector< uint32_t > &seed2, double threshold, double upperValueLimit, double isolatedValueTolerance, uint8_t replaceValue1, uint8_t replaceValue2)
double	GetIsolatedValueTolerance () const
std::string	GetName () const
uint8_t	GetReplaceValue1 () const
uint8_t	GetReplaceValue2 () const
std::vector< uint32_t >	GetSeed1 () const
std::vector< uint32_t >	GetSeed2 () const
double	GetThreshold () const
double	GetUpperValueLimit () const
	IsolatedWatershedImageFilter ()
Self &	SetIsolatedValueTolerance (double IsolatedValueTolerance)
Self &	SetReplaceValue1 (uint8_t ReplaceValue1)
Self &	SetReplaceValue2 (uint8_t ReplaceValue2)
Self &	SetSeed1 (const std::vector< uint32_t > &Seed1)
Self &	SetSeed2 (const std::vector< uint32_t > &Seed2)
Self &	SetThreshold (double Threshold)
Self &	SetUpperValueLimit (double UpperValueLimit)
std::string	ToString () const
virtual	~IsolatedWatershedImageFilter ()
Public Member Functions inherited from itk::simple::ImageFilter< 1 >
	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 &image1)

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

Private Attributes
double	m_IsolatedValueTolerance
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
uint8_t	m_ReplaceValue1
uint8_t	m_ReplaceValue2
std::vector< uint32_t >	m_Seed1
std::vector< uint32_t >	m_Seed2
double	m_Threshold
double	m_UpperValueLimit

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::ProcessObject *	GetActiveProcess ()
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< 1 >
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::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)

Detailed Description

Isolate watershed basins using two seeds.

IsolatedWatershedImageFilter labels pixels with ReplaceValue1 that are in the same watershed basin as Seed1 AND NOT the same as Seed2. The filter adjusts the waterlevel until the two seeds are not in different basins. The user supplies a Watershed threshold. The algorithm uses a binary search to adjust the upper waterlevel, starting at UpperValueLimit. UpperValueLimit defaults to the 1.0.

See also

itk::simple::IsolatedWatershed for the procedural interface

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

Definition at line 42 of file sitkIsolatedWatershedImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::IsolatedWatershedImageFilter::MemberFunctionType) (const Image &image1)

private

Setup for member function dispatching

Definition at line 145 of file sitkIsolatedWatershedImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::IsolatedWatershedImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 54 of file sitkIsolatedWatershedImageFilter.h.

typedef IsolatedWatershedImageFilter itk::simple::IsolatedWatershedImageFilter::Self

Definition at line 44 of file sitkIsolatedWatershedImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::IsolatedWatershedImageFilter::~IsolatedWatershedImageFilter ( )

virtual

Destructor

itk::simple::IsolatedWatershedImageFilter::IsolatedWatershedImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::IsolatedWatershedImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

Image itk::simple::IsolatedWatershedImageFilter::Execute	(	const Image &	image1,
		const std::vector< uint32_t > &	seed1,
		const std::vector< uint32_t > &	seed2,
		double	threshold,
		double	upperValueLimit,
		double	isolatedValueTolerance,
		uint8_t	replaceValue1,
		uint8_t	replaceValue2
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

Image itk::simple::IsolatedWatershedImageFilter::ExecuteInternal ( const Image &  image1 )

private

double itk::simple::IsolatedWatershedImageFilter::GetIsolatedValueTolerance ( ) const

inline

Set/Get the precision required for the intensity threshold value. The default is .001.

Definition at line 106 of file sitkIsolatedWatershedImageFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 128 of file sitkIsolatedWatershedImageFilter.h.

uint8_t itk::simple::IsolatedWatershedImageFilter::GetReplaceValue1 ( ) const

inline

Set/Get value to replace Seed1(Seed2) pixels, pixels that are within the basin that contains Seed1(Seed2) this value. The default is 1(0).

Definition at line 116 of file sitkIsolatedWatershedImageFilter.h.

uint8_t itk::simple::IsolatedWatershedImageFilter::GetReplaceValue2 ( ) const

inline

Set/Get value to replace Seed1(Seed2) pixels, pixels that are within the basin that contains Seed1(Seed2) this value. The default is 1(0).

Definition at line 126 of file sitkIsolatedWatershedImageFilter.h.

std::vector<uint32_t> itk::simple::IsolatedWatershedImageFilter::GetSeed1 ( ) const

inline

Set seed point 1. This seed will be isolated from Seed2 (if possible). All pixels connected to this seed will be replaced with ReplaceValue1.

Definition at line 66 of file sitkIsolatedWatershedImageFilter.h.

std::vector<uint32_t> itk::simple::IsolatedWatershedImageFilter::GetSeed2 ( ) const

inline

Set seed point 2. This seed will be isolated from Seed1 (if possible). All pixels connected to this seed will be replaced with ReplaceValue2.

Definition at line 76 of file sitkIsolatedWatershedImageFilter.h.

double itk::simple::IsolatedWatershedImageFilter::GetThreshold ( ) const

inline

Set/Get the Watershed threshold. The default is 0.

Definition at line 86 of file sitkIsolatedWatershedImageFilter.h.

double itk::simple::IsolatedWatershedImageFilter::GetUpperValueLimit ( ) const

inline

Set/Get the limit on the upper waterlevel value. The default is 1.0.

Definition at line 96 of file sitkIsolatedWatershedImageFilter.h.

Self& itk::simple::IsolatedWatershedImageFilter::SetIsolatedValueTolerance ( double  IsolatedValueTolerance )

inline

Set/Get the precision required for the intensity threshold value. The default is .001.

Definition at line 101 of file sitkIsolatedWatershedImageFilter.h.

Self& itk::simple::IsolatedWatershedImageFilter::SetReplaceValue1 ( uint8_t  ReplaceValue1 )

inline

Set/Get value to replace Seed1(Seed2) pixels, pixels that are within the basin that contains Seed1(Seed2) this value. The default is 1(0).

Definition at line 111 of file sitkIsolatedWatershedImageFilter.h.

Self& itk::simple::IsolatedWatershedImageFilter::SetReplaceValue2 ( uint8_t  ReplaceValue2 )

inline

Set/Get value to replace Seed1(Seed2) pixels, pixels that are within the basin that contains Seed1(Seed2) this value. The default is 1(0).

Definition at line 121 of file sitkIsolatedWatershedImageFilter.h.

Self& itk::simple::IsolatedWatershedImageFilter::SetSeed1 ( const std::vector< uint32_t > &  Seed1 )

inline

Set seed point 1. This seed will be isolated from Seed2 (if possible). All pixels connected to this seed will be replaced with ReplaceValue1.

Definition at line 61 of file sitkIsolatedWatershedImageFilter.h.

Self& itk::simple::IsolatedWatershedImageFilter::SetSeed2 ( const std::vector< uint32_t > &  Seed2 )

inline

Set seed point 2. This seed will be isolated from Seed1 (if possible). All pixels connected to this seed will be replaced with ReplaceValue2.

Definition at line 71 of file sitkIsolatedWatershedImageFilter.h.

Self& itk::simple::IsolatedWatershedImageFilter::SetThreshold ( double  Threshold )

inline

Set/Get the Watershed threshold. The default is 0.

Definition at line 81 of file sitkIsolatedWatershedImageFilter.h.

References itk::simple::Threshold().

Self& itk::simple::IsolatedWatershedImageFilter::SetUpperValueLimit ( double  UpperValueLimit )

inline

Set/Get the limit on the upper waterlevel value. The default is 1.0.

Definition at line 91 of file sitkIsolatedWatershedImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 149 of file sitkIsolatedWatershedImageFilter.h.

Member Data Documentation

double itk::simple::IsolatedWatershedImageFilter::m_IsolatedValueTolerance

private

Definition at line 160 of file sitkIsolatedWatershedImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::IsolatedWatershedImageFilter::m_MemberFactory

private

Definition at line 151 of file sitkIsolatedWatershedImageFilter.h.

uint8_t itk::simple::IsolatedWatershedImageFilter::m_ReplaceValue1

private

Definition at line 161 of file sitkIsolatedWatershedImageFilter.h.

uint8_t itk::simple::IsolatedWatershedImageFilter::m_ReplaceValue2

private

Definition at line 162 of file sitkIsolatedWatershedImageFilter.h.

std::vector<uint32_t> itk::simple::IsolatedWatershedImageFilter::m_Seed1

private

Definition at line 155 of file sitkIsolatedWatershedImageFilter.h.

std::vector<uint32_t> itk::simple::IsolatedWatershedImageFilter::m_Seed2

private

Definition at line 157 of file sitkIsolatedWatershedImageFilter.h.

double itk::simple::IsolatedWatershedImageFilter::m_Threshold

private

Definition at line 158 of file sitkIsolatedWatershedImageFilter.h.

double itk::simple::IsolatedWatershedImageFilter::m_UpperValueLimit

private

Definition at line 159 of file sitkIsolatedWatershedImageFilter.h.

---

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

• sitkIsolatedWatershedImageFilter.h