White top hat extracts local maxima that are larger than the structuring element. More...

#include <sitkWhiteTopHatImageFilter.h>

Inheritance diagram for itk::simple::WhiteTopHatImageFilter:

Collaboration diagram for itk::simple::WhiteTopHatImageFilter:

Detailed Description

White top hat extracts local maxima that are larger than the structuring element.

Top-hats are described in Chapter 4.5 of Pierre Soille's book "Morphological Image Analysis: Principles and Applications", Second Edition, Springer, 2003.

Author: Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

See also: itk::simple::WhiteTopHat for the procedural interface; itk::WhiteTopHatImageFilter for the Doxygen on the original ITK class.

Definition at line 43 of file sitkWhiteTopHatImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList

using	Self = WhiteTopHatImageFilter

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)

std::vector< unsigned int >	GetKernelRadius () const

KernelEnum	GetKernelType () const

std::string	GetName () const

bool	GetSafeBorder () const

Self &	SafeBorderOff ()

Self &	SafeBorderOn ()

Self &	SetKernelRadius (std::vector< unsigned int > KernelRadius)

Self &	SetKernelRadius (unsigned int value)

Self &	SetKernelType (KernelEnum KernelType)

Self &	SetSafeBorder (bool SafeBorder)

std::string	ToString () const

	WhiteTopHatImageFilter ()

virtual	~WhiteTopHatImageFilter ()

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
std::vector< unsigned int >	m_KernelRadius {std::vector<uint32_t>(3, 1)}

KernelEnum	m_KernelType {itk::simple::sitkBall}

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

bool	m_SafeBorder {true}

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

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default

	NonCopyable (const NonCopyable &)=delete

NonCopyable &	operator= (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::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)

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::WhiteTopHatImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 110 of file sitkWhiteTopHatImageFilter.h.

◆ PixelIDTypeList

using itk::simple::WhiteTopHatImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 55 of file sitkWhiteTopHatImageFilter.h.

◆ Self

using itk::simple::WhiteTopHatImageFilter::Self = WhiteTopHatImageFilter

Definition at line 45 of file sitkWhiteTopHatImageFilter.h.

Constructor & Destructor Documentation

◆ ~WhiteTopHatImageFilter()

virtual itk::simple::WhiteTopHatImageFilter::~WhiteTopHatImageFilter ( )

virtual

Destructor

◆ WhiteTopHatImageFilter()

itk::simple::WhiteTopHatImageFilter::WhiteTopHatImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::WhiteTopHatImageFilter::Execute ( const Image & image1 )

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >

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

private

◆ GetKernelRadius()

std::vector<unsigned int> itk::simple::WhiteTopHatImageFilter::GetKernelRadius ( ) const

inline

Get the radius of the kernel structuring element.

Definition at line 69 of file sitkWhiteTopHatImageFilter.h.

◆ GetKernelType()

KernelEnum itk::simple::WhiteTopHatImageFilter::GetKernelType ( ) const

inline

Get the kernel or structuring element used for the morphology.

Definition at line 79 of file sitkWhiteTopHatImageFilter.h.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 96 of file sitkWhiteTopHatImageFilter.h.

◆ GetSafeBorder()

bool itk::simple::WhiteTopHatImageFilter::GetSafeBorder ( ) const

inline

A safe border is added to input image to avoid borders effects and remove it once the closing is done

Definition at line 93 of file sitkWhiteTopHatImageFilter.h.

◆ SafeBorderOff()

Self& itk::simple::WhiteTopHatImageFilter::SafeBorderOff ( )

inline

Definition at line 88 of file sitkWhiteTopHatImageFilter.h.

◆ SafeBorderOn()

Self& itk::simple::WhiteTopHatImageFilter::SafeBorderOn ( )

inline

Set the value of SafeBorder to true or false respectfully.

Definition at line 87 of file sitkWhiteTopHatImageFilter.h.

◆ SetKernelRadius() [1/2]

Self& itk::simple::WhiteTopHatImageFilter::SetKernelRadius ( std::vector< unsigned int > KernelRadius )

inline

Set the radius of the kernel structuring element.

Definition at line 61 of file sitkWhiteTopHatImageFilter.h.

◆ SetKernelRadius() [2/2]

Self& itk::simple::WhiteTopHatImageFilter::SetKernelRadius ( unsigned int value )

inline

Set the values of the KernelRadius vector all to value

Definition at line 64 of file sitkWhiteTopHatImageFilter.h.

◆ SetKernelType()

Self& itk::simple::WhiteTopHatImageFilter::SetKernelType ( KernelEnum KernelType )

inline

Set the kernel or structuring element used for the morphology.

Definition at line 74 of file sitkWhiteTopHatImageFilter.h.

◆ SetSafeBorder()

Self& itk::simple::WhiteTopHatImageFilter::SetSafeBorder ( bool SafeBorder )

inline

A safe border is added to input image to avoid borders effects and remove it once the closing is done

Definition at line 84 of file sitkWhiteTopHatImageFilter.h.

◆ ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 114 of file sitkWhiteTopHatImageFilter.h.

Member Data Documentation

◆ m_KernelRadius

std::vector<unsigned int> itk::simple::WhiteTopHatImageFilter::m_KernelRadius {std::vector<uint32_t>(3, 1)}

private

Definition at line 120 of file sitkWhiteTopHatImageFilter.h.

◆ m_KernelType

KernelEnum itk::simple::WhiteTopHatImageFilter::m_KernelType {itk::simple::sitkBall}

private

Definition at line 122 of file sitkWhiteTopHatImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::WhiteTopHatImageFilter::m_MemberFactory

private

Definition at line 116 of file sitkWhiteTopHatImageFilter.h.

◆ m_SafeBorder

bool itk::simple::WhiteTopHatImageFilter::m_SafeBorder {true}

private

Definition at line 125 of file sitkWhiteTopHatImageFilter.h.

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

sitkWhiteTopHatImageFilter.h

Detailed Description

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ MemberFunctionType

◆ PixelIDTypeList

◆ Self

Constructor & Destructor Documentation

◆ ~WhiteTopHatImageFilter()

◆ WhiteTopHatImageFilter()

Member Function Documentation

◆ Execute()

◆ ExecuteInternal()

◆ GetKernelRadius()

◆ GetKernelType()

◆ GetName()

◆ GetSafeBorder()

◆ SafeBorderOff()

◆ SafeBorderOn()

◆ SetKernelRadius() [1/2]

◆ SetKernelRadius() [2/2]

◆ SetKernelType()

◆ SetSafeBorder()

◆ ToString()

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_KernelRadius

◆ m_KernelType

◆ m_MemberFactory

◆ m_SafeBorder