itk::simple::BinaryMorphologicalOpeningImageFilter Class Reference

binary morphological opening of an image. More...

#include <sitkBinaryMorphologicalOpeningImageFilter.h>

Inheritance diagram for itk::simple::BinaryMorphologicalOpeningImageFilter:

Collaboration diagram for itk::simple::BinaryMorphologicalOpeningImageFilter:

Detailed Description

binary morphological opening of an image.

This filter removes small (i.e., smaller than the structuring element) structures in the interior or at the boundaries of the image. The morphological opening of an image "f" is defined as: Opening(f) = Dilatation(Erosion(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://doi.org/10.54294/bcwtvq

Author

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

See also

MorphologyImageFilter , GrayscaleDilateImageFilter , GrayscaleErodeImageFilter

itk::simple::BinaryMorphologicalOpening for the procedural interface

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

Definition at line 56 of file sitkBinaryMorphologicalOpeningImageFilter.h.

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

Public Member Functions
	BinaryMorphologicalOpeningImageFilter ()
Image	Execute (const Image &image1)
double	GetBackgroundValue () const
double	GetForegroundValue () const
std::vector< unsigned int >	GetKernelRadius () const
KernelEnum	GetKernelType () const
std::string	GetName () const
void	SetBackgroundValue (double BackgroundValue)
void	SetForegroundValue (double ForegroundValue)
void	SetKernelRadius (std::vector< unsigned int > KernelRadius)
void	SetKernelRadius (unsigned int value)
void	SetKernelType (KernelEnum KernelType)
std::string	ToString () const
virtual	~BinaryMorphologicalOpeningImageFilter ()
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.
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 &image1)

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

Static Private Member Functions
static const detail::MemberFunctionFactory< MemberFunctionType > &	GetMemberFunctionFactory ()

Private Attributes
double	m_BackgroundValue { 0.0 }
double	m_ForegroundValue { 1.0 }
std::vector< unsigned int >	m_KernelRadius { std::vector<uint32_t>(3, 1) }
KernelEnum	m_KernelType { itk::simple::sitkBall }

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.
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.
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::BinaryMorphologicalOpeningImageFilter::MemberFunctionType = Image (Self::*)(const Image &image1)

private

Setup for member function dispatching

Definition at line 142 of file sitkBinaryMorphologicalOpeningImageFilter.h.

PixelIDTypeList

using itk::simple::BinaryMorphologicalOpeningImageFilter::PixelIDTypeList = IntegerPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 68 of file sitkBinaryMorphologicalOpeningImageFilter.h.

Self

using itk::simple::BinaryMorphologicalOpeningImageFilter::Self = BinaryMorphologicalOpeningImageFilter

Definition at line 58 of file sitkBinaryMorphologicalOpeningImageFilter.h.

Constructor & Destructor Documentation

~BinaryMorphologicalOpeningImageFilter()

virtual itk::simple::BinaryMorphologicalOpeningImageFilter::~BinaryMorphologicalOpeningImageFilter ( )

virtual

Destructor

BinaryMorphologicalOpeningImageFilter()

itk::simple::BinaryMorphologicalOpeningImageFilter::BinaryMorphologicalOpeningImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute()

Image itk::simple::BinaryMorphologicalOpeningImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

ExecuteInternal()

template<class TImageType>

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

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

GetBackgroundValue()

double itk::simple::BinaryMorphologicalOpeningImageFilter::GetBackgroundValue ( ) const

inline

Set the value in eroded part of the image. Defaults to zero

Definition at line 113 of file sitkBinaryMorphologicalOpeningImageFilter.h.

References m_BackgroundValue.

GetForegroundValue()

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

inline

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

Definition at line 126 of file sitkBinaryMorphologicalOpeningImageFilter.h.

References m_ForegroundValue.

GetKernelRadius()

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

inline

Get the radius of the kernel structuring element.

Definition at line 87 of file sitkBinaryMorphologicalOpeningImageFilter.h.

References m_KernelRadius.

GetKernelType()

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

inline

Get the kernel or structuring element used for the morphology.

Definition at line 100 of file sitkBinaryMorphologicalOpeningImageFilter.h.

References m_KernelType.

GetMemberFunctionFactory()

static const detail::MemberFunctionFactory< MemberFunctionType > & itk::simple::BinaryMorphologicalOpeningImageFilter::GetMemberFunctionFactory ( )

staticprivate

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 130 of file sitkBinaryMorphologicalOpeningImageFilter.h.

SetBackgroundValue()

void itk::simple::BinaryMorphologicalOpeningImageFilter::SetBackgroundValue ( double BackgroundValue )

inline

Set the value in eroded part of the image. Defaults to zero

Definition at line 107 of file sitkBinaryMorphologicalOpeningImageFilter.h.

References m_BackgroundValue.

SetForegroundValue()

void itk::simple::BinaryMorphologicalOpeningImageFilter::SetForegroundValue ( double ForegroundValue )

inline

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

Definition at line 120 of file sitkBinaryMorphologicalOpeningImageFilter.h.

References m_ForegroundValue.

SetKernelRadius() [1/2]

void itk::simple::BinaryMorphologicalOpeningImageFilter::SetKernelRadius ( std::vector< unsigned int > KernelRadius )

inline

Set the radius of the kernel structuring element.

Definition at line 77 of file sitkBinaryMorphologicalOpeningImageFilter.h.

References m_KernelRadius.

SetKernelRadius() [2/2]

void itk::simple::BinaryMorphologicalOpeningImageFilter::SetKernelRadius ( unsigned int value )

inline

Set the values of the KernelRadius vector all to value

Definition at line 82 of file sitkBinaryMorphologicalOpeningImageFilter.h.

References m_KernelRadius.

SetKernelType()

void itk::simple::BinaryMorphologicalOpeningImageFilter::SetKernelType ( KernelEnum KernelType )

inline

Set the kernel or structuring element used for the morphology.

Definition at line 94 of file sitkBinaryMorphologicalOpeningImageFilter.h.

References m_KernelType.

ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 143 of file sitkBinaryMorphologicalOpeningImageFilter.h.

References ExecuteInternal().

Member Data Documentation

m_BackgroundValue

double itk::simple::BinaryMorphologicalOpeningImageFilter::m_BackgroundValue { 0.0 }

private

Definition at line 152 of file sitkBinaryMorphologicalOpeningImageFilter.h.

Referenced by GetBackgroundValue(), and SetBackgroundValue().

m_ForegroundValue

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

private

Definition at line 154 of file sitkBinaryMorphologicalOpeningImageFilter.h.

Referenced by GetForegroundValue(), and SetForegroundValue().

m_KernelRadius

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

private

Definition at line 148 of file sitkBinaryMorphologicalOpeningImageFilter.h.

Referenced by GetKernelRadius(), SetKernelRadius(), and SetKernelRadius().

m_KernelType

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

private

Definition at line 150 of file sitkBinaryMorphologicalOpeningImageFilter.h.

Referenced by GetKernelType(), and SetKernelType().

---

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

• sitkBinaryMorphologicalOpeningImageFilter.h