SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::GrayscaleMorphologicalOpeningImageFilter Class Reference

gray scale dilation of an image More...

#include <sitkGrayscaleMorphologicalOpeningImageFilter.h>

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

Public Types

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

Public Member Functions

Image Execute (const Image &image1)
 
std::vector< unsigned int > GetKernelRadius () const
 
KernelEnum GetKernelType () const
 
std::string GetName () const
 
bool GetSafeBorder () const
 
 GrayscaleMorphologicalOpeningImageFilter ()
 
SelfSafeBorderOff ()
 
SelfSafeBorderOn ()
 
SelfSetKernelRadius (std::vector< unsigned int > KernelRadius)
 
SelfSetKernelRadius (unsigned int value)
 
SelfSetKernelType (KernelEnum KernelType)
 
SelfSetSafeBorder (bool SafeBorder)
 
std::string ToString () const
 
virtual ~GrayscaleMorphologicalOpeningImageFilter ()
 
- 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

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
 
bool m_SafeBorder {true}
 

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

gray scale dilation of an image

Dilate an image using grayscale morphology. Dilation takes the maximum of all the pixels identified by the structuring element.

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.

See also
MorphologyImageFilter , GrayscaleFunctionDilateImageFilter , BinaryDilateImageFilter
itk::simple::GrayscaleMorphologicalOpening for the procedural interface
itk::GrayscaleMorphologicalOpeningImageFilter for the Doxygen on the original ITK class.

Definition at line 46 of file sitkGrayscaleMorphologicalOpeningImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 113 of file sitkGrayscaleMorphologicalOpeningImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 58 of file sitkGrayscaleMorphologicalOpeningImageFilter.h.

◆ Self

Constructor & Destructor Documentation

◆ ~GrayscaleMorphologicalOpeningImageFilter()

virtual itk::simple::GrayscaleMorphologicalOpeningImageFilter::~GrayscaleMorphologicalOpeningImageFilter ( )
virtual

Destructor

◆ GrayscaleMorphologicalOpeningImageFilter()

itk::simple::GrayscaleMorphologicalOpeningImageFilter::GrayscaleMorphologicalOpeningImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetKernelRadius()

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

Get the radius of the kernel structuring element.

Definition at line 72 of file sitkGrayscaleMorphologicalOpeningImageFilter.h.

◆ GetKernelType()

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

Get the kernel or structuring element used for the morphology.

Definition at line 82 of file sitkGrayscaleMorphologicalOpeningImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 99 of file sitkGrayscaleMorphologicalOpeningImageFilter.h.

◆ GetSafeBorder()

bool itk::simple::GrayscaleMorphologicalOpeningImageFilter::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 96 of file sitkGrayscaleMorphologicalOpeningImageFilter.h.

◆ SafeBorderOff()

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

◆ SafeBorderOn()

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

Set the value of SafeBorder to true or false respectfully.

Definition at line 90 of file sitkGrayscaleMorphologicalOpeningImageFilter.h.

◆ SetKernelRadius() [1/2]

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

Set the radius of the kernel structuring element.

Definition at line 64 of file sitkGrayscaleMorphologicalOpeningImageFilter.h.

◆ SetKernelRadius() [2/2]

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

Set the values of the KernelRadius vector all to value

Definition at line 67 of file sitkGrayscaleMorphologicalOpeningImageFilter.h.

◆ SetKernelType()

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

Set the kernel or structuring element used for the morphology.

Definition at line 77 of file sitkGrayscaleMorphologicalOpeningImageFilter.h.

◆ SetSafeBorder()

Self& itk::simple::GrayscaleMorphologicalOpeningImageFilter::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 87 of file sitkGrayscaleMorphologicalOpeningImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_KernelRadius

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

◆ m_KernelType

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

◆ m_MemberFactory

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

◆ m_SafeBorder

bool itk::simple::GrayscaleMorphologicalOpeningImageFilter::m_SafeBorder {true}
private

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