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

Fills in holes and cavities by applying a voting operation on each pixel. More...

#include <sitkVotingBinaryHoleFillingImageFilter.h>

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

Public Types

using PixelIDTypeList = IntegerPixelIDTypeList
 
using Self = VotingBinaryHoleFillingImageFilter
 
- 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)
 
double GetBackgroundValue () const
 
double GetForegroundValue () const
 
unsigned int GetMajorityThreshold () const
 
std::string GetName () const
 
std::vector< unsigned int > GetRadius () const
 
SelfSetBackgroundValue (double BackgroundValue)
 
SelfSetForegroundValue (double ForegroundValue)
 
SelfSetMajorityThreshold (unsigned int MajorityThreshold)
 
SelfSetRadius (std::vector< unsigned int > Radius)
 
SelfSetRadius (unsigned int value)
 
std::string ToString () const
 
 VotingBinaryHoleFillingImageFilter ()
 
virtual ~VotingBinaryHoleFillingImageFilter ()
 
- 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}
 
double m_ForegroundValue {1.0}
 
unsigned int m_MajorityThreshold {1u}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< unsigned int > m_Radius {std::vector<unsigned int>(3, 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

Fills in holes and cavities by applying a voting operation on each pixel.

See also
Image
VotingBinaryImageFilter
VotingBinaryIterativeHoleFillingImageFilter
Neighborhood
NeighborhoodOperator
NeighborhoodIterator
itk::simple::VotingBinaryHoleFilling for the procedural interface
itk::VotingBinaryHoleFillingImageFilter for the Doxygen on the original ITK class.

Definition at line 57 of file sitkVotingBinaryHoleFillingImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 124 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 69 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ Self

Definition at line 59 of file sitkVotingBinaryHoleFillingImageFilter.h.

Constructor & Destructor Documentation

◆ ~VotingBinaryHoleFillingImageFilter()

virtual itk::simple::VotingBinaryHoleFillingImageFilter::~VotingBinaryHoleFillingImageFilter ( )
virtual

Destructor

◆ VotingBinaryHoleFillingImageFilter()

itk::simple::VotingBinaryHoleFillingImageFilter::VotingBinaryHoleFillingImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetBackgroundValue()

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

Definition at line 107 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ GetForegroundValue()

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

Definition at line 99 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ GetMajorityThreshold()

unsigned int itk::simple::VotingBinaryHoleFillingImageFilter::GetMajorityThreshold ( ) const
inline

Majority threshold. It is the number of pixels over 50% that will decide whether an OFF pixel will become ON or not. For example, if the neighborhood of a pixel has 124 pixels (excluding itself), the 50% will be 62, and if you set upd a Majority threshold of 5, that means that the filter will require 67 or more neighbor pixels to be ON in order to switch the current OFF pixel to ON. The default value is 1.

Definition at line 91 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 110 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ GetRadius()

std::vector<unsigned int> itk::simple::VotingBinaryHoleFillingImageFilter::GetRadius ( ) const
inline

Definition at line 81 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ SetBackgroundValue()

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

Definition at line 103 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ SetForegroundValue()

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

Definition at line 95 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ SetMajorityThreshold()

Self& itk::simple::VotingBinaryHoleFillingImageFilter::SetMajorityThreshold ( unsigned int  MajorityThreshold)
inline

Majority threshold. It is the number of pixels over 50% that will decide whether an OFF pixel will become ON or not. For example, if the neighborhood of a pixel has 124 pixels (excluding itself), the 50% will be 62, and if you set upd a Majority threshold of 5, that means that the filter will require 67 or more neighbor pixels to be ON in order to switch the current OFF pixel to ON. The default value is 1.

Definition at line 86 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ SetRadius() [1/2]

Self& itk::simple::VotingBinaryHoleFillingImageFilter::SetRadius ( std::vector< unsigned int >  Radius)
inline

Definition at line 74 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ SetRadius() [2/2]

Self& itk::simple::VotingBinaryHoleFillingImageFilter::SetRadius ( unsigned int  value)
inline

Set the values of the Radius vector all to value

Definition at line 77 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 128 of file sitkVotingBinaryHoleFillingImageFilter.h.

Member Data Documentation

◆ m_BackgroundValue

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

Definition at line 140 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ m_ForegroundValue

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

Definition at line 138 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ m_MajorityThreshold

unsigned int itk::simple::VotingBinaryHoleFillingImageFilter::m_MajorityThreshold {1u}
private

Definition at line 136 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ m_MemberFactory

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

Definition at line 130 of file sitkVotingBinaryHoleFillingImageFilter.h.

◆ m_Radius

std::vector<unsigned int> itk::simple::VotingBinaryHoleFillingImageFilter::m_Radius {std::vector<unsigned int>(3, 1)}
private

Definition at line 134 of file sitkVotingBinaryHoleFillingImageFilter.h.


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