SimpleITK  1.1.0.dev270
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:

Public Types

typedef IntegerPixelIDTypeList PixelIDTypeList
 
typedef ConnectedComponentImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

 ConnectedComponentImageFilter ()
 
Image Execute (const Image &image1)
 
Image Execute (const Image &image1, bool fullyConnected)
 
SelfFullyConnectedOff ()
 
SelfFullyConnectedOn ()
 
bool GetFullyConnected () const
 
std::string GetName () const
 
uint32_t GetObjectCount () const
 
SelfSetFullyConnected (bool FullyConnected)
 
std::string ToString () const
 
 ~ConnectedComponentImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 1 >
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
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
 

Private Types

typedef Image(Self::* MemberFunctionType) (const Image &image1)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1)
 

Private Attributes

bool m_FullyConnected
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
uint32_t m_ObjectCount
 

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 void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
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...
 
- 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) throw ()
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
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 TImageType >
static Image CastITKToImage (TImageType *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)
 
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

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. The final object labels start with 1 and are consecutive. 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
Wiki Examples:

Definition at line 52 of file sitkConnectedComponentImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::ConnectedComponentImageFilter::MemberFunctionType) (const Image &image1)
private

Setup for member function dispatching

Definition at line 108 of file sitkConnectedComponentImageFilter.h.

Define the pixels types supported by this filter

Definition at line 64 of file sitkConnectedComponentImageFilter.h.

Definition at line 54 of file sitkConnectedComponentImageFilter.h.

Constructor & Destructor Documentation

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

Default Constructor that takes no arguments and initializes default parameters

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

Destructor

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::ConnectedComponentImageFilter::Execute ( const Image image1,
bool  fullyConnected 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::ConnectedComponentImageFilter::ExecuteInternal ( const Image image1)
private
Self& itk::simple::ConnectedComponentImageFilter::FullyConnectedOff ( )
inline

Definition at line 75 of file sitkConnectedComponentImageFilter.h.

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

Set the value of FullyConnected to true or false respectfully.

Definition at line 74 of file sitkConnectedComponentImageFilter.h.

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 80 of file sitkConnectedComponentImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 90 of file sitkConnectedComponentImageFilter.h.

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 87 of file sitkConnectedComponentImageFilter.h.

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 71 of file sitkConnectedComponentImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 113 of file sitkConnectedComponentImageFilter.h.

Member Data Documentation

bool itk::simple::ConnectedComponentImageFilter::m_FullyConnected
private

Definition at line 119 of file sitkConnectedComponentImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ConnectedComponentImageFilter::m_MemberFactory
private

Definition at line 115 of file sitkConnectedComponentImageFilter.h.

uint32_t itk::simple::ConnectedComponentImageFilter::m_ObjectCount
private

Definition at line 121 of file sitkConnectedComponentImageFilter.h.


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