SimpleITK  2.1.0.dev86
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

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = BlackTopHatImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

 BlackTopHatImageFilter ()
 
Image Execute (const Image &image1)
 
std::vector< unsigned int > GetKernelRadius () const
 
KernelEnum GetKernelType () const
 
std::string GetName () const
 
bool GetSafeBorder () const
 
SelfSafeBorderOff ()
 
SelfSafeBorderOn ()
 
SelfSetKernelRadius (std::vector< unsigned int > KernelRadius)
 
SelfSetKernelRadius (unsigned int value)
 
SelfSetKernelType (KernelEnum KernelType)
 
SelfSetSafeBorder (bool SafeBorder)
 
std::string ToString () const
 
virtual ~BlackTopHatImageFilter ()
 
- 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

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::ProcessObjectGetActiveProcess ()
 
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
 
NonCopyableoperator= (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<class TImageType >
static Image CastITKToImage (TImageType *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.

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 46 of file sitkBlackTopHatImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 113 of file sitkBlackTopHatImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 58 of file sitkBlackTopHatImageFilter.h.

◆ Self

Definition at line 48 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()

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

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::BlackTopHatImageFilter::ExecuteInternal ( const Image image1)
private

◆ GetKernelRadius()

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

Get the radius of the kernel structuring element.

Definition at line 72 of file sitkBlackTopHatImageFilter.h.

◆ GetKernelType()

KernelEnum itk::simple::BlackTopHatImageFilter::GetKernelType ( ) const
inline

Get the kernel or structuring element used for the morphology.

Definition at line 82 of file sitkBlackTopHatImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 99 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 96 of file sitkBlackTopHatImageFilter.h.

◆ SafeBorderOff()

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

Definition at line 91 of file sitkBlackTopHatImageFilter.h.

◆ SafeBorderOn()

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

Set the value of SafeBorder to true or false respectfully.

Definition at line 90 of file sitkBlackTopHatImageFilter.h.

◆ SetKernelRadius() [1/2]

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

Set the radius of the kernel structuring element.

Definition at line 64 of file sitkBlackTopHatImageFilter.h.

◆ SetKernelRadius() [2/2]

Self& itk::simple::BlackTopHatImageFilter::SetKernelRadius ( unsigned int  value)
inline

Set the values of the KernelRadius vector all to value

Definition at line 67 of file sitkBlackTopHatImageFilter.h.

◆ SetKernelType()

Self& itk::simple::BlackTopHatImageFilter::SetKernelType ( KernelEnum  KernelType)
inline

Set the kernel or structuring element used for the morphology.

Definition at line 77 of file sitkBlackTopHatImageFilter.h.

◆ 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 87 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 >

Definition at line 117 of file sitkBlackTopHatImageFilter.h.

Member Data Documentation

◆ m_KernelRadius

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

Definition at line 123 of file sitkBlackTopHatImageFilter.h.

◆ m_KernelType

KernelEnum itk::simple::BlackTopHatImageFilter::m_KernelType {itk::simple::sitkBall}
private

Definition at line 125 of file sitkBlackTopHatImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::BlackTopHatImageFilter::m_MemberFactory
private

Definition at line 119 of file sitkBlackTopHatImageFilter.h.

◆ m_SafeBorder

bool itk::simple::BlackTopHatImageFilter::m_SafeBorder {true}
private

Definition at line 128 of file sitkBlackTopHatImageFilter.h.


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