itk::simple::BinaryMorphologicalClosingImageFilter Class Reference

binary morphological closing of an image. More...

#include <sitkBinaryMorphologicalClosingImageFilter.h>

Inheritance diagram for itk::simple::BinaryMorphologicalClosingImageFilter:

Collaboration diagram for itk::simple::BinaryMorphologicalClosingImageFilter:

Public Types
using	PixelIDTypeList = IntegerPixelIDTypeList
using	Self = BinaryMorphologicalClosingImageFilter
Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter
Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
	BinaryMorphologicalClosingImageFilter ()
Image	Execute (const Image &image1)
double	GetForegroundValue () const
std::vector< unsigned int >	GetKernelRadius () const
KernelEnum	GetKernelType () const
std::string	GetName () const
bool	GetSafeBorder () const
Self &	SafeBorderOff ()
Self &	SafeBorderOn ()
Self &	SetForegroundValue (double ForegroundValue)
Self &	SetKernelRadius (std::vector< unsigned int > KernelRadius)
Self &	SetKernelRadius (unsigned int value)
Self &	SetKernelType (KernelEnum KernelType)
Self &	SetSafeBorder (bool SafeBorder)
std::string	ToString () const
virtual	~BinaryMorphologicalClosingImageFilter ()
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
double	m_ForegroundValue {1.0}
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)

Detailed Description

binary morphological closing of an image.

This filter removes small (i.e., smaller than the structuring element) holes and tube like structures in the interior or at the boundaries of the image. The morphological closing of an image "f" is defined as: Closing(f) = Erosion(Dilation(f)).

The structuring element is assumed to be composed of binary values (zero or one). Only elements of the structuring element having values > 0 are candidates for affecting the center pixel.

This code was contributed in the Insight Journal paper: "Binary morphological closing and opening image filters" by Lehmann G. https://www.insight-journal.org/browse/publication/58

Author

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

See also

MorphologyImageFilter , GrayscaleDilateImageFilter , GrayscaleErodeImageFilter

itk::simple::BinaryMorphologicalClosing for the procedural interface

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

Definition at line 50 of file sitkBinaryMorphologicalClosingImageFilter.h.

Member Typedef Documentation

MemberFunctionType

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

private

Setup for member function dispatching

Definition at line 127 of file sitkBinaryMorphologicalClosingImageFilter.h.

PixelIDTypeList

using itk::simple::BinaryMorphologicalClosingImageFilter::PixelIDTypeList = IntegerPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 62 of file sitkBinaryMorphologicalClosingImageFilter.h.

Self

using itk::simple::BinaryMorphologicalClosingImageFilter::Self = BinaryMorphologicalClosingImageFilter

Definition at line 52 of file sitkBinaryMorphologicalClosingImageFilter.h.

Constructor & Destructor Documentation

~BinaryMorphologicalClosingImageFilter()

virtual itk::simple::BinaryMorphologicalClosingImageFilter::~BinaryMorphologicalClosingImageFilter ( )

virtual

Destructor

BinaryMorphologicalClosingImageFilter()

itk::simple::BinaryMorphologicalClosingImageFilter::BinaryMorphologicalClosingImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute()

Image itk::simple::BinaryMorphologicalClosingImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

ExecuteInternal()

template<class TImageType >

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

private

GetForegroundValue()

double itk::simple::BinaryMorphologicalClosingImageFilter::GetForegroundValue ( ) const

inline

Get the value in the image considered as "foreground". Defaults to maximum value of InputPixelType.

Definition at line 96 of file sitkBinaryMorphologicalClosingImageFilter.h.

GetKernelRadius()

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

inline

Get the radius of the kernel structuring element.

Definition at line 76 of file sitkBinaryMorphologicalClosingImageFilter.h.

GetKernelType()

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

inline

Get the kernel or structuring element used for the morphology.

Definition at line 86 of file sitkBinaryMorphologicalClosingImageFilter.h.

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 113 of file sitkBinaryMorphologicalClosingImageFilter.h.

GetSafeBorder()

bool itk::simple::BinaryMorphologicalClosingImageFilter::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 110 of file sitkBinaryMorphologicalClosingImageFilter.h.

SafeBorderOff()

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

inline

Definition at line 105 of file sitkBinaryMorphologicalClosingImageFilter.h.

SafeBorderOn()

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

inline

Set the value of SafeBorder to true or false respectfully.

Definition at line 104 of file sitkBinaryMorphologicalClosingImageFilter.h.

SetForegroundValue()

Self& itk::simple::BinaryMorphologicalClosingImageFilter::SetForegroundValue ( double  ForegroundValue )

inline

Set the value in the image to consider as "foreground". Defaults to maximum value of InputPixelType.

Definition at line 91 of file sitkBinaryMorphologicalClosingImageFilter.h.

SetKernelRadius() [1/2]

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

inline

Set the radius of the kernel structuring element.

Definition at line 68 of file sitkBinaryMorphologicalClosingImageFilter.h.

SetKernelRadius() [2/2]

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

inline

Set the values of the KernelRadius vector all to value

Definition at line 71 of file sitkBinaryMorphologicalClosingImageFilter.h.

SetKernelType()

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

inline

Set the kernel or structuring element used for the morphology.

Definition at line 81 of file sitkBinaryMorphologicalClosingImageFilter.h.

SetSafeBorder()

Self& itk::simple::BinaryMorphologicalClosingImageFilter::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 101 of file sitkBinaryMorphologicalClosingImageFilter.h.

ToString()

std::string itk::simple::BinaryMorphologicalClosingImageFilter::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 131 of file sitkBinaryMorphologicalClosingImageFilter.h.

Member Data Documentation

m_ForegroundValue

double itk::simple::BinaryMorphologicalClosingImageFilter::m_ForegroundValue {1.0}

private

Definition at line 141 of file sitkBinaryMorphologicalClosingImageFilter.h.

m_KernelRadius

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

private

Definition at line 137 of file sitkBinaryMorphologicalClosingImageFilter.h.

m_KernelType

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

private

Definition at line 139 of file sitkBinaryMorphologicalClosingImageFilter.h.

m_MemberFactory

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

private

Definition at line 133 of file sitkBinaryMorphologicalClosingImageFilter.h.

m_SafeBorder

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

private

Definition at line 144 of file sitkBinaryMorphologicalClosingImageFilter.h.

---

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

• sitkBinaryMorphologicalClosingImageFilter.h