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:

Public Types
enum	KernelType {   Annulus =sitkAnnulus,   Ball =sitkBall,   Box =sitkBox,   Cross =sitkCross }
typedef IntegerPixelIDTypeList	PixelIDTypeList
typedef BinaryMorphologicalOpeningImageFilter	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
	BinaryMorphologicalOpeningImageFilter ()
Image	Execute (const Image &image1)
Image	Execute (const Image &image1, double backgroundValue, double foregroundValue)
double	GetBackgroundValue () const
double	GetForegroundValue () const
std::vector< uint32_t >	GetKernelRadius () const
KernelEnum	GetKernelType () const
std::string	GetName () const
Self &	SetBackgroundValue (double BackgroundValue)
Self &	SetForegroundValue (double ForegroundValue)
Self &	SetKernelRadius (uint32_t r)
Self &	SetKernelRadius (const std::vector< uint32_t > &r)
Self &	SetKernelType (KernelEnum t)
Self &	SetKernelType (KernelType t)
std::string	ToString () const
virtual	~BinaryMorphologicalOpeningImageFilter ()
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_BackgroundValue
double	m_ForegroundValue
std::vector< uint32_t >	m_KernelRadius
KernelEnum	m_KernelType
nsstd::auto_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 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

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://hdl.handle.net/1926/141 http://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::BinaryMorphologicalOpening for the procedural interface

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

Definition at line 51 of file sitkBinaryMorphologicalOpeningImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 129 of file sitkBinaryMorphologicalOpeningImageFilter.h.

typedef IntegerPixelIDTypeList itk::simple::BinaryMorphologicalOpeningImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 63 of file sitkBinaryMorphologicalOpeningImageFilter.h.

typedef BinaryMorphologicalOpeningImageFilter itk::simple::BinaryMorphologicalOpeningImageFilter::Self

Definition at line 53 of file sitkBinaryMorphologicalOpeningImageFilter.h.

Member Enumeration Documentation

enum itk::simple::BinaryMorphologicalOpeningImageFilter::KernelType

Kernel type enumeration

Enumerator
Annulus
Ball
Box
Cross

Definition at line 66 of file sitkBinaryMorphologicalOpeningImageFilter.h.

Constructor & Destructor Documentation

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

virtual

Destructor

itk::simple::BinaryMorphologicalOpeningImageFilter::BinaryMorphologicalOpeningImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::BinaryMorphologicalOpeningImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

Image itk::simple::BinaryMorphologicalOpeningImageFilter::Execute	(	const Image &	image1,
		double	backgroundValue,
		double	foregroundValue
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

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

private

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

inline

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

Definition at line 78 of file sitkBinaryMorphologicalOpeningImageFilter.h.

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 88 of file sitkBinaryMorphologicalOpeningImageFilter.h.

std::vector<uint32_t> itk::simple::BinaryMorphologicalOpeningImageFilter::GetKernelRadius

(

)

const

KernelEnum itk::simple::BinaryMorphologicalOpeningImageFilter::GetKernelType

(

)

const

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 111 of file sitkBinaryMorphologicalOpeningImageFilter.h.

Self& itk::simple::BinaryMorphologicalOpeningImageFilter::SetBackgroundValue ( double  BackgroundValue )

inline

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

Definition at line 73 of file sitkBinaryMorphologicalOpeningImageFilter.h.

Self& 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 83 of file sitkBinaryMorphologicalOpeningImageFilter.h.

Self& itk::simple::BinaryMorphologicalOpeningImageFilter::SetKernelRadius

(

uint32_t

r

)

Kernel radius as a scale for isotropic structures

Self& itk::simple::BinaryMorphologicalOpeningImageFilter::SetKernelRadius

(

const std::vector< uint32_t > &

r

)

Set/Get the radius of the kernel structuring element as a vector.

If the dimension of the image is greater then the length of r, then the radius will be padded. If it is less the r will be truncated.

Self& itk::simple::BinaryMorphologicalOpeningImageFilter::SetKernelType

(

KernelEnum

t

)

Set/Get the kernel or structuring elemenent used for the morphology

Self& itk::simple::BinaryMorphologicalOpeningImageFilter::SetKernelType

(

KernelType

t

)

std::string itk::simple::BinaryMorphologicalOpeningImageFilter::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 133 of file sitkBinaryMorphologicalOpeningImageFilter.h.

Member Data Documentation

double itk::simple::BinaryMorphologicalOpeningImageFilter::m_BackgroundValue

private

Definition at line 138 of file sitkBinaryMorphologicalOpeningImageFilter.h.

double itk::simple::BinaryMorphologicalOpeningImageFilter::m_ForegroundValue

private

Definition at line 139 of file sitkBinaryMorphologicalOpeningImageFilter.h.

std::vector<uint32_t> itk::simple::BinaryMorphologicalOpeningImageFilter::m_KernelRadius

private

Definition at line 142 of file sitkBinaryMorphologicalOpeningImageFilter.h.

KernelEnum itk::simple::BinaryMorphologicalOpeningImageFilter::m_KernelType

private

KernelType

Definition at line 145 of file sitkBinaryMorphologicalOpeningImageFilter.h.

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

private

Definition at line 135 of file sitkBinaryMorphologicalOpeningImageFilter.h.

---

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

• sitkBinaryMorphologicalOpeningImageFilter.h