itk::simple::BlackTopHatImageFilter Class Reference

Black top hat extracts local minima that are smaller than the structuring element. More...

#include <sitkBlackTopHatImageFilter.h>

Inheritance diagram for itk::simple::BlackTopHatImageFilter:

Collaboration diagram for itk::simple::BlackTopHatImageFilter:

Public Types
enum	KernelType {   Annulus =sitkAnnulus,   Ball =sitkBall,   Box =sitkBox,   Cross =sitkCross }
typedef BasicPixelIDTypeList	PixelIDTypeList
typedef BlackTopHatImageFilter	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
	BlackTopHatImageFilter ()
Image	Execute (const Image &image1)
Image	Execute (const Image &image1, bool safeBorder)
std::vector< uint32_t >	GetKernelRadius () const
KernelEnum	GetKernelType () const
std::string	GetName () const
bool	GetSafeBorder () const
Self &	SafeBorderOff ()
Self &	SafeBorderOn ()
Self &	SetKernelRadius (const std::vector< uint32_t > &r)
Self &	SetKernelRadius (uint32_t r)
Self &	SetKernelType (KernelEnum t)
Self &	SetKernelType (KernelType t)
Self &	SetSafeBorder (bool SafeBorder)
std::string	ToString () const
virtual	~BlackTopHatImageFilter ()
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
std::vector< uint32_t >	m_KernelRadius
KernelEnum	m_KernelType
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
bool	m_SafeBorder

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 TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, 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

Black top hat extracts local minima that are smaller than the structuring element.

Black top hat extracts local minima that are smaller than the structuring element. It subtracts the background from the input image. The output of the filter transforms the black valleys into white peaks.

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::BlackTopHat for the procedural interface

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

Definition at line 47 of file sitkBlackTopHatImageFilter.h.

Member Typedef Documentation

MemberFunctionType

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

private

Setup for member function dispatching

Definition at line 119 of file sitkBlackTopHatImageFilter.h.

PixelIDTypeList

typedef BasicPixelIDTypeList itk::simple::BlackTopHatImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 59 of file sitkBlackTopHatImageFilter.h.

Self

typedef BlackTopHatImageFilter itk::simple::BlackTopHatImageFilter::Self

Definition at line 49 of file sitkBlackTopHatImageFilter.h.

Member Enumeration Documentation

KernelType

enum itk::simple::BlackTopHatImageFilter::KernelType

Kernel type enumeration

Enumerator
Annulus
Ball
Box
Cross

Definition at line 62 of file sitkBlackTopHatImageFilter.h.

Constructor & Destructor Documentation

~BlackTopHatImageFilter()

virtual itk::simple::BlackTopHatImageFilter::~BlackTopHatImageFilter ( )

virtual

Destructor

BlackTopHatImageFilter()

itk::simple::BlackTopHatImageFilter::BlackTopHatImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute() [1/2]

Image itk::simple::BlackTopHatImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

Execute() [2/2]

Image itk::simple::BlackTopHatImageFilter::Execute	(	const Image &	image1,
		bool	safeBorder
	)

Execute the filter on the input image with the given parameters

ExecuteInternal()

template<class TImageType >

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

private

GetKernelRadius()

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

(

)

const

GetKernelType()

KernelEnum itk::simple::BlackTopHatImageFilter::GetKernelType

(

)

const

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 101 of file sitkBlackTopHatImageFilter.h.

GetSafeBorder()

bool itk::simple::BlackTopHatImageFilter::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 78 of file sitkBlackTopHatImageFilter.h.

SafeBorderOff()

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

inline

Definition at line 73 of file sitkBlackTopHatImageFilter.h.

SafeBorderOn()

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

inline

Set the value of SafeBorder to true or false respectfully.

Definition at line 72 of file sitkBlackTopHatImageFilter.h.

SetKernelRadius() [1/2]

Self& itk::simple::BlackTopHatImageFilter::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.

SetKernelRadius() [2/2]

Self& itk::simple::BlackTopHatImageFilter::SetKernelRadius

(

uint32_t

r

)

Kernel radius as a scale for isotropic structures

SetKernelType() [1/2]

Self& itk::simple::BlackTopHatImageFilter::SetKernelType

(

KernelEnum

t

)

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

SetKernelType() [2/2]

Self& itk::simple::BlackTopHatImageFilter::SetKernelType

(

KernelType

t

)

SetSafeBorder()

Self& itk::simple::BlackTopHatImageFilter::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 69 of file sitkBlackTopHatImageFilter.h.

ToString()

std::string itk::simple::BlackTopHatImageFilter::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 123 of file sitkBlackTopHatImageFilter.h.

Member Data Documentation

m_KernelRadius

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

private

Definition at line 132 of file sitkBlackTopHatImageFilter.h.

m_KernelType

KernelEnum itk::simple::BlackTopHatImageFilter::m_KernelType

private

KernelType

Definition at line 135 of file sitkBlackTopHatImageFilter.h.

m_MemberFactory

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

private

Definition at line 125 of file sitkBlackTopHatImageFilter.h.

m_SafeBorder

bool itk::simple::BlackTopHatImageFilter::m_SafeBorder

private

Definition at line 129 of file sitkBlackTopHatImageFilter.h.

---

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

• sitkBlackTopHatImageFilter.h