SimpleITK  2.0.0rc2.post59
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
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

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

Public Member Functions

 ErodeObjectMorphologyImageFilter ()
 
Image Execute (const Image &image1)
 
double GetBackgroundValue () const
 
std::vector< unsigned int > GetKernelRadius () const
 
KernelEnum GetKernelType () const
 
std::string GetName () const
 
double GetObjectValue () const
 
SelfSetBackgroundValue (double BackgroundValue)
 
SelfSetKernelRadius (std::vector< unsigned int > KernelRadius)
 
SelfSetKernelRadius (unsigned int value)
 
SelfSetKernelType (KernelEnum KernelType)
 
SelfSetObjectValue (double ObjectValue)
 
std::string ToString () const
 
virtual ~ErodeObjectMorphologyImageFilter ()
 
- 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

double m_BackgroundValue {0}
 
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
 
double m_ObjectValue {1}
 

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

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

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 120 of file sitkErodeObjectMorphologyImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 61 of file sitkErodeObjectMorphologyImageFilter.h.

◆ Self

Definition at line 51 of file sitkErodeObjectMorphologyImageFilter.h.

Constructor & Destructor Documentation

◆ ~ErodeObjectMorphologyImageFilter()

virtual itk::simple::ErodeObjectMorphologyImageFilter::~ErodeObjectMorphologyImageFilter ( )
virtual

Destructor

◆ ErodeObjectMorphologyImageFilter()

itk::simple::ErodeObjectMorphologyImageFilter::ErodeObjectMorphologyImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetBackgroundValue()

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

Get the value to be assigned to eroded pixels

Definition at line 103 of file sitkErodeObjectMorphologyImageFilter.h.

◆ GetKernelRadius()

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

Get the radius of the kernel structuring element.

Definition at line 75 of file sitkErodeObjectMorphologyImageFilter.h.

◆ GetKernelType()

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

Get the kernel or structuring element used for the morphology.

Definition at line 85 of file sitkErodeObjectMorphologyImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 106 of file sitkErodeObjectMorphologyImageFilter.h.

◆ GetObjectValue()

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

Definition at line 93 of file sitkErodeObjectMorphologyImageFilter.h.

◆ SetBackgroundValue()

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

Set the value to be assigned to eroded pixels

Definition at line 98 of file sitkErodeObjectMorphologyImageFilter.h.

◆ SetKernelRadius() [1/2]

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

Set the radius of the kernel structuring element.

Definition at line 67 of file sitkErodeObjectMorphologyImageFilter.h.

◆ SetKernelRadius() [2/2]

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

Set the values of the KernelRadius vector all to value

Definition at line 70 of file sitkErodeObjectMorphologyImageFilter.h.

◆ SetKernelType()

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

Set the kernel or structuring element used for the morphology.

Definition at line 80 of file sitkErodeObjectMorphologyImageFilter.h.

◆ SetObjectValue()

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

Definition at line 89 of file sitkErodeObjectMorphologyImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 124 of file sitkErodeObjectMorphologyImageFilter.h.

Member Data Documentation

◆ m_BackgroundValue

double itk::simple::ErodeObjectMorphologyImageFilter::m_BackgroundValue {0}
private

Definition at line 137 of file sitkErodeObjectMorphologyImageFilter.h.

◆ m_KernelRadius

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

Definition at line 130 of file sitkErodeObjectMorphologyImageFilter.h.

◆ m_KernelType

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

Definition at line 132 of file sitkErodeObjectMorphologyImageFilter.h.

◆ m_MemberFactory

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

Definition at line 126 of file sitkErodeObjectMorphologyImageFilter.h.

◆ m_ObjectValue

double itk::simple::ErodeObjectMorphologyImageFilter::m_ObjectValue {1}
private

Definition at line 135 of file sitkErodeObjectMorphologyImageFilter.h.


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