Applies a voting operation in a neighborhood of each pixel. More...

#include <sitkVotingBinaryImageFilter.h>

Inheritance diagram for itk::simple::VotingBinaryImageFilter:

Collaboration diagram for itk::simple::VotingBinaryImageFilter:

Detailed Description

Applies a voting operation in a neighborhood of each pixel.

Note: Pixels which are not Foreground or Background will remain unchanged.

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

Definition at line 53 of file sitkVotingBinaryImageFilter.h.

Public Types
using	PixelIDTypeList = IntegerPixelIDTypeList

using	Self = VotingBinaryImageFilter

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

unsigned int	GetBirthThreshold () const

double	GetForegroundValue () const

std::string	GetName () const

std::vector< unsigned int >	GetRadius () const

unsigned int	GetSurvivalThreshold () const

Self &	SetBackgroundValue (double BackgroundValue)

Self &	SetBirthThreshold (unsigned int BirthThreshold)

Self &	SetForegroundValue (double ForegroundValue)

Self &	SetRadius (std::vector< unsigned int > Radius)

Self &	SetRadius (unsigned int value)

Self &	SetSurvivalThreshold (unsigned int SurvivalThreshold)

std::string	ToString () const

	VotingBinaryImageFilter ()

virtual	~VotingBinaryImageFilter ()

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}

unsigned int	m_BirthThreshold {1u}

double	m_ForegroundValue {1.0}

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

std::vector< unsigned int >	m_Radius {std::vector<unsigned int>(3, 1)}

unsigned int	m_SurvivalThreshold {1u}

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::ProcessObject *	GetActiveProcess ()

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

NonCopyable &	operator= (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<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType >
static Image	CastITKToImage (TImageType *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)

Member Typedef Documentation

◆ MemberFunctionType

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

private

Setup for member function dispatching

Definition at line 136 of file sitkVotingBinaryImageFilter.h.

◆ PixelIDTypeList

using itk::simple::VotingBinaryImageFilter::PixelIDTypeList = IntegerPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 65 of file sitkVotingBinaryImageFilter.h.

◆ Self

using itk::simple::VotingBinaryImageFilter::Self = VotingBinaryImageFilter

Definition at line 55 of file sitkVotingBinaryImageFilter.h.

Constructor & Destructor Documentation

◆ ~VotingBinaryImageFilter()

virtual itk::simple::VotingBinaryImageFilter::~VotingBinaryImageFilter ( )

virtual

Destructor

◆ VotingBinaryImageFilter()

itk::simple::VotingBinaryImageFilter::VotingBinaryImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::VotingBinaryImageFilter::Execute ( const Image & image1 )

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >

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

private

◆ GetBackgroundValue()

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

inline

Get the value associated with the Foreground (or the object) on the binary input image and the Background .

Definition at line 119 of file sitkVotingBinaryImageFilter.h.

◆ GetBirthThreshold()

unsigned int itk::simple::VotingBinaryImageFilter::GetBirthThreshold ( ) const

inline

Birth threshold. Pixels that are OFF will turn ON when the number of neighbors ON is larger than the value defined in this threshold.

Definition at line 89 of file sitkVotingBinaryImageFilter.h.

◆ GetForegroundValue()

double itk::simple::VotingBinaryImageFilter::GetForegroundValue ( ) const

inline

Get the value associated with the Foreground (or the object) on the binary input image and the Background .

Definition at line 109 of file sitkVotingBinaryImageFilter.h.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 122 of file sitkVotingBinaryImageFilter.h.

◆ GetRadius()

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

inline

Get the radius of the neighborhood used to compute the median

Definition at line 79 of file sitkVotingBinaryImageFilter.h.

◆ GetSurvivalThreshold()

unsigned int itk::simple::VotingBinaryImageFilter::GetSurvivalThreshold ( ) const

inline

Survival threshold. Pixels that are ON will turn OFF when the number of neighbors ON is smaller than the value defined in this survival threshold.

Definition at line 99 of file sitkVotingBinaryImageFilter.h.

◆ SetBackgroundValue()

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

inline

Set the value associated with the Foreground (or the object) on the binary input image and the Background .

Definition at line 114 of file sitkVotingBinaryImageFilter.h.

◆ SetBirthThreshold()

Self& itk::simple::VotingBinaryImageFilter::SetBirthThreshold ( unsigned int BirthThreshold )

inline

Birth threshold. Pixels that are OFF will turn ON when the number of neighbors ON is larger than the value defined in this threshold.

Definition at line 84 of file sitkVotingBinaryImageFilter.h.

◆ SetForegroundValue()

Self& itk::simple::VotingBinaryImageFilter::SetForegroundValue ( double ForegroundValue )

inline

Set the value associated with the Foreground (or the object) on the binary input image and the Background .

Definition at line 104 of file sitkVotingBinaryImageFilter.h.

◆ SetRadius() [1/2]

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

inline

Set the radius of the neighborhood used to compute the median.

Definition at line 71 of file sitkVotingBinaryImageFilter.h.

◆ SetRadius() [2/2]

Self& itk::simple::VotingBinaryImageFilter::SetRadius ( unsigned int value )

inline

Set the values of the Radius vector all to value

Definition at line 74 of file sitkVotingBinaryImageFilter.h.

◆ SetSurvivalThreshold()

Self& itk::simple::VotingBinaryImageFilter::SetSurvivalThreshold ( unsigned int SurvivalThreshold )

inline

Survival threshold. Pixels that are ON will turn OFF when the number of neighbors ON is smaller than the value defined in this survival threshold.

Definition at line 94 of file sitkVotingBinaryImageFilter.h.

◆ ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 140 of file sitkVotingBinaryImageFilter.h.

Member Data Documentation

◆ m_BackgroundValue

double itk::simple::VotingBinaryImageFilter::m_BackgroundValue {0.0}

private

Definition at line 154 of file sitkVotingBinaryImageFilter.h.

◆ m_BirthThreshold

unsigned int itk::simple::VotingBinaryImageFilter::m_BirthThreshold {1u}

private

Definition at line 148 of file sitkVotingBinaryImageFilter.h.

◆ m_ForegroundValue

double itk::simple::VotingBinaryImageFilter::m_ForegroundValue {1.0}

private

Definition at line 152 of file sitkVotingBinaryImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::VotingBinaryImageFilter::m_MemberFactory

private

Definition at line 142 of file sitkVotingBinaryImageFilter.h.

◆ m_Radius

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

private

Definition at line 146 of file sitkVotingBinaryImageFilter.h.

◆ m_SurvivalThreshold

unsigned int itk::simple::VotingBinaryImageFilter::m_SurvivalThreshold {1u}

private

Definition at line 150 of file sitkVotingBinaryImageFilter.h.

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

sitkVotingBinaryImageFilter.h

Detailed Description

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ MemberFunctionType

◆ PixelIDTypeList

◆ Self

Constructor & Destructor Documentation

◆ ~VotingBinaryImageFilter()

◆ VotingBinaryImageFilter()

Member Function Documentation

◆ Execute()

◆ ExecuteInternal()

◆ GetBackgroundValue()

◆ GetBirthThreshold()

◆ GetForegroundValue()

◆ GetName()

◆ GetRadius()

◆ GetSurvivalThreshold()

◆ SetBackgroundValue()

◆ SetBirthThreshold()

◆ SetForegroundValue()

◆ SetRadius() [1/2]

◆ SetRadius() [2/2]

◆ SetSurvivalThreshold()

◆ ToString()

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_BackgroundValue

◆ m_BirthThreshold

◆ m_ForegroundValue

◆ m_MemberFactory

◆ m_Radius

◆ m_SurvivalThreshold