SimpleITK  1.0.1
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
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_tGetKernelRadius () const
KernelEnum GetKernelType () const
std::string GetName () const
bool GetSafeBorder () const
SelfSafeBorderOff ()
SelfSafeBorderOn ()
SelfSetKernelRadius (uint32_t r)
SelfSetKernelRadius (const std::vector< uint32_t > &r)
SelfSetKernelType (KernelEnum t)
SelfSetKernelType (KernelType t)
SelfSetSafeBorder (bool SafeBorder)
std::string ToString () const
 ~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_tm_KernelRadius
KernelEnum m_KernelType
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
bool m_SafeBorder


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::ProcessObjectGetActiveProcess ()
virtual void OnActiveProcessDelete ()
virtual void onCommandDelete (const itk::simple::Command *cmd) throw ()
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::EventObjectGetITKEventObject (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.

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

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

Setup for member function dispatching

Definition at line 119 of file sitkBlackTopHatImageFilter.h.

Define the pixels types supported by this filter

Definition at line 59 of file sitkBlackTopHatImageFilter.h.

Definition at line 49 of file sitkBlackTopHatImageFilter.h.

Member Enumeration Documentation

Kernel type enumeration


Definition at line 62 of file sitkBlackTopHatImageFilter.h.

Constructor & Destructor Documentation

itk::simple::BlackTopHatImageFilter::BlackTopHatImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

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


Member Function Documentation

Image itk::simple::BlackTopHatImageFilter::Execute ( const Image image1)

Execute the filter on the input image

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

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::BlackTopHatImageFilter::ExecuteInternal ( const Image image1)
std::vector<uint32_t> itk::simple::BlackTopHatImageFilter::GetKernelRadius ( ) const
KernelEnum itk::simple::BlackTopHatImageFilter::GetKernelType ( ) const
std::string itk::simple::BlackTopHatImageFilter::GetName ( ) const

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 101 of file sitkBlackTopHatImageFilter.h.

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

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.

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

Definition at line 73 of file sitkBlackTopHatImageFilter.h.

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

Set the value of SafeBorder to true or false respectfully.

Definition at line 72 of file sitkBlackTopHatImageFilter.h.

Self& itk::simple::BlackTopHatImageFilter::SetKernelRadius ( uint32_t  r)

Kernel radius as a scale for isotropic structures

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.

Self& itk::simple::BlackTopHatImageFilter::SetKernelType ( KernelEnum  t)

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

Self& itk::simple::BlackTopHatImageFilter::SetKernelType ( KernelType  t)
Self& itk::simple::BlackTopHatImageFilter::SetSafeBorder ( bool  SafeBorder)

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.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 124 of file sitkBlackTopHatImageFilter.h.

Member Data Documentation

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

Definition at line 133 of file sitkBlackTopHatImageFilter.h.

KernelEnum itk::simple::BlackTopHatImageFilter::m_KernelType


Definition at line 136 of file sitkBlackTopHatImageFilter.h.

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

Definition at line 126 of file sitkBlackTopHatImageFilter.h.

bool itk::simple::BlackTopHatImageFilter::m_SafeBorder

Definition at line 130 of file sitkBlackTopHatImageFilter.h.

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