SimpleITK  1.3.0.dev216
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::BinaryMorphologicalClosingImageFilter Class Reference

binary morphological closing of an image. More...

#include <sitkBinaryMorphologicalClosingImageFilter.h>

+ Inheritance diagram for itk::simple::BinaryMorphologicalClosingImageFilter:
+ Collaboration diagram for itk::simple::BinaryMorphologicalClosingImageFilter:

Public Types

enum  KernelType {
  Annulus =sitkAnnulus,
  Ball =sitkBall,
  Box =sitkBox,
  Cross =sitkCross
}
 
typedef IntegerPixelIDTypeList PixelIDTypeList
 
typedef BinaryMorphologicalClosingImageFilter 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

 BinaryMorphologicalClosingImageFilter ()
 
Image Execute (const Image &image1)
 
Image Execute (const Image &image1, double foregroundValue, bool safeBorder)
 
double GetForegroundValue () const
 
std::vector< uint32_tGetKernelRadius () const
 
KernelEnum GetKernelType () const
 
std::string GetName () const
 
bool GetSafeBorder () const
 
SelfSafeBorderOff ()
 
SelfSafeBorderOn ()
 
SelfSetForegroundValue (double ForegroundValue)
 
SelfSetKernelRadius (uint32_t r)
 
SelfSetKernelRadius (const std::vector< uint32_t > &r)
 
SelfSetKernelType (KernelEnum t)
 
SelfSetKernelType (KernelType t)
 
SelfSetSafeBorder (bool SafeBorder)
 
std::string ToString () const
 
virtual ~BinaryMorphologicalClosingImageFilter ()
 
- 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_ForegroundValue
 
std::vector< uint32_tm_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::ProcessObjectGetActiveProcess ()
 
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::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

binary morphological closing of an image.

This filter removes small (i.e., smaller than the structuring element) holes and tube like structures in the interior or at the boundaries of the image. The morphological closing of an image "f" is defined as: Closing(f) = Erosion(Dilation(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::BinaryMorphologicalClosing for the procedural interface
itk::BinaryMorphologicalClosingImageFilter for the Doxygen on the original ITK class.

Definition at line 51 of file sitkBinaryMorphologicalClosingImageFilter.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 133 of file sitkBinaryMorphologicalClosingImageFilter.h.

Define the pixels types supported by this filter

Definition at line 63 of file sitkBinaryMorphologicalClosingImageFilter.h.

Definition at line 53 of file sitkBinaryMorphologicalClosingImageFilter.h.

Member Enumeration Documentation

Kernel type enumeration

Enumerator
Annulus 
Ball 
Box 
Cross 

Definition at line 66 of file sitkBinaryMorphologicalClosingImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::BinaryMorphologicalClosingImageFilter::~BinaryMorphologicalClosingImageFilter ( )
virtual

Destructor

itk::simple::BinaryMorphologicalClosingImageFilter::BinaryMorphologicalClosingImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::BinaryMorphologicalClosingImageFilter::Execute ( const Image image1,
double  foregroundValue,
bool  safeBorder 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::BinaryMorphologicalClosingImageFilter::ExecuteInternal ( const Image image1)
private
double itk::simple::BinaryMorphologicalClosingImageFilter::GetForegroundValue ( ) const
inline

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

Definition at line 78 of file sitkBinaryMorphologicalClosingImageFilter.h.

std::vector<uint32_t> itk::simple::BinaryMorphologicalClosingImageFilter::GetKernelRadius ( ) const
KernelEnum itk::simple::BinaryMorphologicalClosingImageFilter::GetKernelType ( ) const
std::string itk::simple::BinaryMorphologicalClosingImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 115 of file sitkBinaryMorphologicalClosingImageFilter.h.

bool itk::simple::BinaryMorphologicalClosingImageFilter::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 92 of file sitkBinaryMorphologicalClosingImageFilter.h.

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

Definition at line 87 of file sitkBinaryMorphologicalClosingImageFilter.h.

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

Set the value of SafeBorder to true or false respectfully.

Definition at line 86 of file sitkBinaryMorphologicalClosingImageFilter.h.

Self& itk::simple::BinaryMorphologicalClosingImageFilter::SetForegroundValue ( double  ForegroundValue)
inline

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

Definition at line 73 of file sitkBinaryMorphologicalClosingImageFilter.h.

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

Kernel radius as a scale for isotropic structures

Self& itk::simple::BinaryMorphologicalClosingImageFilter::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::BinaryMorphologicalClosingImageFilter::SetKernelType ( KernelEnum  t)

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

Self& itk::simple::BinaryMorphologicalClosingImageFilter::SetKernelType ( KernelType  t)
Self& itk::simple::BinaryMorphologicalClosingImageFilter::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 83 of file sitkBinaryMorphologicalClosingImageFilter.h.

std::string itk::simple::BinaryMorphologicalClosingImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 137 of file sitkBinaryMorphologicalClosingImageFilter.h.

Member Data Documentation

double itk::simple::BinaryMorphologicalClosingImageFilter::m_ForegroundValue
private

Definition at line 142 of file sitkBinaryMorphologicalClosingImageFilter.h.

std::vector<uint32_t> itk::simple::BinaryMorphologicalClosingImageFilter::m_KernelRadius
private

Definition at line 147 of file sitkBinaryMorphologicalClosingImageFilter.h.

KernelEnum itk::simple::BinaryMorphologicalClosingImageFilter::m_KernelType
private

KernelType

Definition at line 150 of file sitkBinaryMorphologicalClosingImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::BinaryMorphologicalClosingImageFilter::m_MemberFactory
private

Definition at line 139 of file sitkBinaryMorphologicalClosingImageFilter.h.

bool itk::simple::BinaryMorphologicalClosingImageFilter::m_SafeBorder
private

Definition at line 144 of file sitkBinaryMorphologicalClosingImageFilter.h.


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