SimpleITK  2.0.0rc2.post59
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::BinaryDilateImageFilter Class Reference

Fast binary dilation of a single intensity value in the image. More...

#include <sitkBinaryDilateImageFilter.h>

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

Public Types

using PixelIDTypeList = IntegerPixelIDTypeList
 
using Self = BinaryDilateImageFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

 BinaryDilateImageFilter ()
 
SelfBoundaryToForegroundOff ()
 
SelfBoundaryToForegroundOn ()
 
Image Execute (const Image &image1)
 
double GetBackgroundValue () const
 
bool GetBoundaryToForeground () const
 
double GetForegroundValue () const
 
std::vector< unsigned int > GetKernelRadius () const
 
KernelEnum GetKernelType () const
 
std::string GetName () const
 
SelfSetBackgroundValue (double BackgroundValue)
 
SelfSetBoundaryToForeground (bool BoundaryToForeground)
 
SelfSetForegroundValue (double ForegroundValue)
 
SelfSetKernelRadius (std::vector< unsigned int > KernelRadius)
 
SelfSetKernelRadius (unsigned int value)
 
SelfSetKernelType (KernelEnum KernelType)
 
std::string ToString () const
 
virtual ~BinaryDilateImageFilter ()
 
- 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.0}
 
bool m_BoundaryToForeground {false}
 
double m_ForegroundValue {1.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
 

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

Fast binary dilation of a single intensity value in the image.

BinaryDilateImageFilter is a binary dilation morphologic operation on the foreground of an image. Only the value designated by the intensity value "SetForegroundValue()" (alias as SetDilateValue() ) is considered as foreground, and other intensity values are considered background.

Gray scale images can be processed as binary images by selecting a "ForegroundValue" (alias "DilateValue"). Pixel values matching the dilate 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. ForegroundValue defaults to the maximum possible value of the PixelType.

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 .

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.

See also
ImageToImageFilter BinaryErodeImageFilter BinaryMorphologyImageFilter
itk::simple::BinaryDilate for the procedural interface
itk::BinaryDilateImageFilter for the Doxygen on the original ITK class.

Definition at line 55 of file sitkBinaryDilateImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 136 of file sitkBinaryDilateImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 67 of file sitkBinaryDilateImageFilter.h.

◆ Self

Definition at line 57 of file sitkBinaryDilateImageFilter.h.

Constructor & Destructor Documentation

◆ ~BinaryDilateImageFilter()

virtual itk::simple::BinaryDilateImageFilter::~BinaryDilateImageFilter ( )
virtual

Destructor

◆ BinaryDilateImageFilter()

itk::simple::BinaryDilateImageFilter::BinaryDilateImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ BoundaryToForegroundOff()

Self& itk::simple::BinaryDilateImageFilter::BoundaryToForegroundOff ( )
inline

Definition at line 115 of file sitkBinaryDilateImageFilter.h.

◆ BoundaryToForegroundOn()

Self& itk::simple::BinaryDilateImageFilter::BoundaryToForegroundOn ( )
inline

Set the value of BoundaryToForeground to true or false respectfully.

Definition at line 114 of file sitkBinaryDilateImageFilter.h.

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetBackgroundValue()

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

Definition at line 99 of file sitkBinaryDilateImageFilter.h.

◆ GetBoundaryToForeground()

bool itk::simple::BinaryDilateImageFilter::GetBoundaryToForeground ( ) const
inline

Definition at line 119 of file sitkBinaryDilateImageFilter.h.

◆ GetForegroundValue()

double itk::simple::BinaryDilateImageFilter::GetForegroundValue ( ) const
inline

Definition at line 107 of file sitkBinaryDilateImageFilter.h.

◆ GetKernelRadius()

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

Get the radius of the kernel structuring element.

Definition at line 81 of file sitkBinaryDilateImageFilter.h.

◆ GetKernelType()

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

Get the kernel or structuring element used for the morphology.

Definition at line 91 of file sitkBinaryDilateImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 122 of file sitkBinaryDilateImageFilter.h.

◆ SetBackgroundValue()

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

Definition at line 95 of file sitkBinaryDilateImageFilter.h.

◆ SetBoundaryToForeground()

Self& itk::simple::BinaryDilateImageFilter::SetBoundaryToForeground ( bool  BoundaryToForeground)
inline

Definition at line 111 of file sitkBinaryDilateImageFilter.h.

◆ SetForegroundValue()

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

Definition at line 103 of file sitkBinaryDilateImageFilter.h.

◆ SetKernelRadius() [1/2]

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

Set the radius of the kernel structuring element.

Definition at line 73 of file sitkBinaryDilateImageFilter.h.

◆ SetKernelRadius() [2/2]

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

Set the values of the KernelRadius vector all to value

Definition at line 76 of file sitkBinaryDilateImageFilter.h.

◆ SetKernelType()

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

Set the kernel or structuring element used for the morphology.

Definition at line 86 of file sitkBinaryDilateImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 140 of file sitkBinaryDilateImageFilter.h.

Member Data Documentation

◆ m_BackgroundValue

double itk::simple::BinaryDilateImageFilter::m_BackgroundValue {0.0}
private

Definition at line 151 of file sitkBinaryDilateImageFilter.h.

◆ m_BoundaryToForeground

bool itk::simple::BinaryDilateImageFilter::m_BoundaryToForeground {false}
private

Definition at line 157 of file sitkBinaryDilateImageFilter.h.

◆ m_ForegroundValue

double itk::simple::BinaryDilateImageFilter::m_ForegroundValue {1.0}
private

Definition at line 154 of file sitkBinaryDilateImageFilter.h.

◆ m_KernelRadius

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

Definition at line 146 of file sitkBinaryDilateImageFilter.h.

◆ m_KernelType

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

Definition at line 148 of file sitkBinaryDilateImageFilter.h.

◆ m_MemberFactory

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

Definition at line 142 of file sitkBinaryDilateImageFilter.h.


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