SimpleITK  
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ConnectedComponentImageFilter Class Reference

Label the objects in a binary image. More...

#include <sitkConnectedComponentImageFilter.h>

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

Detailed Description

Label the objects in a binary image.

ConnectedComponentImageFilter labels the objects in a binary image (non-zero pixels are considered to be objects, zero-valued pixels are considered to be background). Each distinct object is assigned a unique label. The filter experiments with some improvements to the existing implementation, and is based on run length encoding along raster lines. If the output background value is set to zero (the default), the final object labels start with 1 and are consecutive. If the output background is set to a non-zero value (by calling the SetBackgroundValue() routine of the filter), the final labels start at 0, and remain consecutive except for skipping the background value as needed. Objects that are reached earlier by a raster order scan have a lower label. This is different to the behaviour of the original connected component image filter which did not produce consecutive labels or impose any particular ordering.

After the filter is executed, ObjectCount holds the number of connected components.

See also
ImageToImageFilter
itk::simple::ConnectedComponent for the procedural interface
itk::ConnectedComponentImageFilter for the Doxygen on the original ITK class.

Definition at line 45 of file sitkConnectedComponentImageFilter.h.

Public Types

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

Public Member Functions

 ConnectedComponentImageFilter ()
 
Image Execute (const Image &image)
 
Image Execute (const Image &image, const Image &maskImage)
 
SelfFullyConnectedOff ()
 
SelfFullyConnectedOn ()
 
bool GetFullyConnected () const
 
std::string GetName () const
 
uint32_t GetObjectCount () const
 
SelfSetFullyConnected (bool FullyConnected)
 
std::string ToString () const
 
virtual ~ConnectedComponentImageFilter ()
 
- 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 *image, const Image *maskImage)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image *image, const Image *maskImage)
 

Private Attributes

bool m_FullyConnected {false}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
uint32_t m_ObjectCount {0u}
 

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<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::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)
 

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::ConnectedComponentImageFilter::MemberFunctionType = Image (Self::*)( const Image * image, const Image * maskImage )
private

Setup for member function dispatching

Definition at line 98 of file sitkConnectedComponentImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 57 of file sitkConnectedComponentImageFilter.h.

◆ Self

Definition at line 47 of file sitkConnectedComponentImageFilter.h.

Constructor & Destructor Documentation

◆ ~ConnectedComponentImageFilter()

virtual itk::simple::ConnectedComponentImageFilter::~ConnectedComponentImageFilter ( )
virtual

Destructor

◆ ConnectedComponentImageFilter()

itk::simple::ConnectedComponentImageFilter::ConnectedComponentImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

Image itk::simple::ConnectedComponentImageFilter::Execute ( const Image image)

◆ Execute() [2/2]

Image itk::simple::ConnectedComponentImageFilter::Execute ( const Image image,
const Image maskImage 
)

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::ConnectedComponentImageFilter::ExecuteInternal ( const Image image,
const Image maskImage 
)
private

◆ FullyConnectedOff()

Self& itk::simple::ConnectedComponentImageFilter::FullyConnectedOff ( )
inline

Definition at line 67 of file sitkConnectedComponentImageFilter.h.

◆ FullyConnectedOn()

Self& itk::simple::ConnectedComponentImageFilter::FullyConnectedOn ( )
inline

Set the value of FullyConnected to true or false respectfully.

Definition at line 66 of file sitkConnectedComponentImageFilter.h.

◆ GetFullyConnected()

bool itk::simple::ConnectedComponentImageFilter::GetFullyConnected ( ) const
inline

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Definition at line 72 of file sitkConnectedComponentImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 83 of file sitkConnectedComponentImageFilter.h.

◆ GetObjectCount()

uint32_t itk::simple::ConnectedComponentImageFilter::GetObjectCount ( ) const
inline

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 79 of file sitkConnectedComponentImageFilter.h.

◆ SetFullyConnected()

Self& itk::simple::ConnectedComponentImageFilter::SetFullyConnected ( bool  FullyConnected)
inline

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Definition at line 63 of file sitkConnectedComponentImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 102 of file sitkConnectedComponentImageFilter.h.

Member Data Documentation

◆ m_FullyConnected

bool itk::simple::ConnectedComponentImageFilter::m_FullyConnected {false}
private

Definition at line 108 of file sitkConnectedComponentImageFilter.h.

◆ m_MemberFactory

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

Definition at line 104 of file sitkConnectedComponentImageFilter.h.

◆ m_ObjectCount

uint32_t itk::simple::ConnectedComponentImageFilter::m_ObjectCount {0u}
private

Definition at line 111 of file sitkConnectedComponentImageFilter.h.


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