itk::simple::ErodeObjectMorphologyImageFilter Class Reference

Erosion of an object in an image. More...

#include <sitkErodeObjectMorphologyImageFilter.h>

Inheritance diagram for itk::simple::ErodeObjectMorphologyImageFilter:

Collaboration diagram for itk::simple::ErodeObjectMorphologyImageFilter:

Public Types
enum	KernelType {   Annulus =sitkAnnulus,   Ball =sitkBall,   Box =sitkBox,   Cross =sitkCross }
typedef BasicPixelIDTypeList	PixelIDTypeList
typedef ErodeObjectMorphologyImageFilter	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
	ErodeObjectMorphologyImageFilter ()
Image	Execute (const Image &image1)
Image	Execute (const Image &image1, double objectValue, double backgroundValue)
double	GetBackgroundValue () const
std::vector< uint32_t >	GetKernelRadius () const
KernelEnum	GetKernelType () const
std::string	GetName () const
double	GetObjectValue () const
Self &	SetBackgroundValue (double BackgroundValue)
Self &	SetKernelRadius (uint32_t r)
Self &	SetKernelRadius (const std::vector< uint32_t > &r)
Self &	SetKernelType (KernelEnum t)
Self &	SetKernelType (KernelType t)
Self &	SetObjectValue (double ObjectValue)
std::string	ToString () const
	~ErodeObjectMorphologyImageFilter ()
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
std::vector< uint32_t >	m_KernelRadius
KernelEnum	m_KernelType
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
double	m_ObjectValue

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) 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::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

Erosion of an object in an image.

Erosion of an image using binary morphology. Pixel values matching the object value are considered the "object" and all other pixels are "background". This is useful in processing mask images containing only one object.

If the pixel covered by the center of the kernel has the pixel value ObjectValue and the pixel is adjacent to a non-object valued pixel, then the kernel is centered on the object-value pixel and neighboring pixels covered by the kernel are assigned the background value. The structuring element is assumed to be composed of binary values (zero or one).

See also

ObjectMorphologyImageFilter , BinaryFunctionErodeImageFilter

BinaryErodeImageFilter

itk::simple::ErodeObjectMorphology for the procedural interface

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

Definition at line 49 of file sitkErodeObjectMorphologyImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 125 of file sitkErodeObjectMorphologyImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::ErodeObjectMorphologyImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 61 of file sitkErodeObjectMorphologyImageFilter.h.

typedef ErodeObjectMorphologyImageFilter itk::simple::ErodeObjectMorphologyImageFilter::Self

Definition at line 51 of file sitkErodeObjectMorphologyImageFilter.h.

Member Enumeration Documentation

enum itk::simple::ErodeObjectMorphologyImageFilter::KernelType

Kernel type enumeration

Enumerator
Annulus
Ball
Box
Cross

Definition at line 64 of file sitkErodeObjectMorphologyImageFilter.h.

Constructor & Destructor Documentation

itk::simple::ErodeObjectMorphologyImageFilter::ErodeObjectMorphologyImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

itk::simple::ErodeObjectMorphologyImageFilter::~ErodeObjectMorphologyImageFilter

(

)

Destructor

Member Function Documentation

Image itk::simple::ErodeObjectMorphologyImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

Image itk::simple::ErodeObjectMorphologyImageFilter::Execute	(	const Image &	image1,
		double	objectValue,
		double	backgroundValue
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

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

private

double itk::simple::ErodeObjectMorphologyImageFilter::GetBackgroundValue ( ) const

inline

Get the value to be assigned to eroded pixels

Definition at line 84 of file sitkErodeObjectMorphologyImageFilter.h.

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

(

)

const

KernelEnum itk::simple::ErodeObjectMorphologyImageFilter::GetKernelType

(

)

const

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 107 of file sitkErodeObjectMorphologyImageFilter.h.

double itk::simple::ErodeObjectMorphologyImageFilter::GetObjectValue ( ) const

inline

Definition at line 74 of file sitkErodeObjectMorphologyImageFilter.h.

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

inline

Set the value to be assigned to eroded pixels

Definition at line 79 of file sitkErodeObjectMorphologyImageFilter.h.

Self& itk::simple::ErodeObjectMorphologyImageFilter::SetKernelRadius

(

uint32_t

r

)

Kernel radius as a scale for isotropic structures

Self& itk::simple::ErodeObjectMorphologyImageFilter::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::ErodeObjectMorphologyImageFilter::SetKernelType

(

KernelEnum

t

)

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

Self& itk::simple::ErodeObjectMorphologyImageFilter::SetKernelType

(

KernelType

t

)

Self& itk::simple::ErodeObjectMorphologyImageFilter::SetObjectValue ( double  ObjectValue )

inline

Definition at line 70 of file sitkErodeObjectMorphologyImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 130 of file sitkErodeObjectMorphologyImageFilter.h.

Member Data Documentation

double itk::simple::ErodeObjectMorphologyImageFilter::m_BackgroundValue

private

Definition at line 137 of file sitkErodeObjectMorphologyImageFilter.h.

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

private

Definition at line 140 of file sitkErodeObjectMorphologyImageFilter.h.

KernelEnum itk::simple::ErodeObjectMorphologyImageFilter::m_KernelType

private

KernelType

Definition at line 143 of file sitkErodeObjectMorphologyImageFilter.h.

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

private

Definition at line 132 of file sitkErodeObjectMorphologyImageFilter.h.

double itk::simple::ErodeObjectMorphologyImageFilter::m_ObjectValue

private

Definition at line 136 of file sitkErodeObjectMorphologyImageFilter.h.

---

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

• sitkErodeObjectMorphologyImageFilter.h