SimpleITK  1.0.1
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::BinaryErodeImageFilter Class Reference

Fast binary erosion. More...

#include <sitkBinaryErodeImageFilter.h>

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

Public Types

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

 BinaryErodeImageFilter ()
SelfBoundaryToForegroundOff ()
SelfBoundaryToForegroundOn ()
Image Execute (const Image &image1)
Image Execute (const Image &image1, double backgroundValue, double foregroundValue, bool boundaryToForeground)
double GetBackgroundValue () const
bool GetBoundaryToForeground () const
double GetForegroundValue () const
std::vector< uint32_tGetKernelRadius () const
KernelEnum GetKernelType () const
std::string GetName () const
SelfSetBackgroundValue (double BackgroundValue)
SelfSetBoundaryToForeground (bool BoundaryToForeground)
SelfSetForegroundValue (double ForegroundValue)
SelfSetKernelRadius (uint32_t r)
SelfSetKernelRadius (const std::vector< uint32_t > &r)
SelfSetKernelType (KernelEnum t)
SelfSetKernelType (KernelType t)
std::string ToString () const
 ~BinaryErodeImageFilter ()
- 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
bool m_BoundaryToForeground
double m_ForegroundValue
std::vector< uint32_tm_KernelRadius
KernelEnum m_KernelType
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory


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

Fast binary erosion.

BinaryErodeImageFilter is a binary erosion morphologic operation. This implementation is based on the papers:

L.Vincent "Morphological transformations of binary images with arbitrary structuring elements", and

N.Nikopoulos et al. "An efficient algorithm for 3d binary morphological transformations with 3d structuring elements for arbitrary size and shape". IEEE Transactions on Image Processing. Vol. 9. No. 3. 2000. pp. 283-286.

Gray scale images can be processed as binary images by selecting a "ErodeValue". Pixel values matching the erode value are considered the "foreground" and all other pixels are "background". This is useful in processing segmented images where all pixels in segment #1 have value 1 and pixels in segment #2 have value 2, etc. A particular "segment number" can be processed. ErodeValue defaults to the maximum possible value of the PixelType. The eroded pixels will receive the BackgroundValue (defaults to 0).

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. A reasonable choice of structuring element is itk::BinaryBallStructuringElement .

See also
ImageToImageFilter BinaryDilateImageFilter BinaryMorphologyImageFilter
Wiki Examples:

Definition at line 60 of file sitkBinaryErodeImageFilter.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 146 of file sitkBinaryErodeImageFilter.h.

Define the pixels types supported by this filter

Definition at line 72 of file sitkBinaryErodeImageFilter.h.

Definition at line 62 of file sitkBinaryErodeImageFilter.h.

Member Enumeration Documentation

Kernel type enumeration


Definition at line 75 of file sitkBinaryErodeImageFilter.h.

Constructor & Destructor Documentation

itk::simple::BinaryErodeImageFilter::BinaryErodeImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

itk::simple::BinaryErodeImageFilter::~BinaryErodeImageFilter ( )


Member Function Documentation

Self& itk::simple::BinaryErodeImageFilter::BoundaryToForegroundOff ( )

Definition at line 101 of file sitkBinaryErodeImageFilter.h.

Self& itk::simple::BinaryErodeImageFilter::BoundaryToForegroundOn ( )

Set the value of BoundaryToForeground to true or false respectfully.

Definition at line 100 of file sitkBinaryErodeImageFilter.h.

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

Execute the filter on the input image

Image itk::simple::BinaryErodeImageFilter::Execute ( const Image image1,
double  backgroundValue,
double  foregroundValue,
bool  boundaryToForeground 

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::BinaryErodeImageFilter::ExecuteInternal ( const Image image1)
double itk::simple::BinaryErodeImageFilter::GetBackgroundValue ( ) const

Definition at line 85 of file sitkBinaryErodeImageFilter.h.

bool itk::simple::BinaryErodeImageFilter::GetBoundaryToForeground ( ) const

Definition at line 105 of file sitkBinaryErodeImageFilter.h.

double itk::simple::BinaryErodeImageFilter::GetForegroundValue ( ) const

Definition at line 93 of file sitkBinaryErodeImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 128 of file sitkBinaryErodeImageFilter.h.

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

Definition at line 81 of file sitkBinaryErodeImageFilter.h.

Self& itk::simple::BinaryErodeImageFilter::SetBoundaryToForeground ( bool  BoundaryToForeground)

Definition at line 97 of file sitkBinaryErodeImageFilter.h.

Self& itk::simple::BinaryErodeImageFilter::SetForegroundValue ( double  ForegroundValue)

Definition at line 89 of file sitkBinaryErodeImageFilter.h.

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

Kernel radius as a scale for isotropic structures

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

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

Self& itk::simple::BinaryErodeImageFilter::SetKernelType ( KernelType  t)
std::string itk::simple::BinaryErodeImageFilter::ToString ( ) const

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 151 of file sitkBinaryErodeImageFilter.h.

Member Data Documentation

double itk::simple::BinaryErodeImageFilter::m_BackgroundValue

Definition at line 157 of file sitkBinaryErodeImageFilter.h.

bool itk::simple::BinaryErodeImageFilter::m_BoundaryToForeground

Definition at line 161 of file sitkBinaryErodeImageFilter.h.

double itk::simple::BinaryErodeImageFilter::m_ForegroundValue

Definition at line 159 of file sitkBinaryErodeImageFilter.h.

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

Definition at line 164 of file sitkBinaryErodeImageFilter.h.

KernelEnum itk::simple::BinaryErodeImageFilter::m_KernelType


Definition at line 167 of file sitkBinaryErodeImageFilter.h.

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

Definition at line 153 of file sitkBinaryErodeImageFilter.h.

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