itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage > Class Template Reference

A generic connected components filter that labels the objects in an artibitrary image. More...

#include <itkConnectedComponentFunctorImageFilter.h>

Inheritance diagram for itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >:

[legend]Collaboration diagram for itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >:

[legend]List of all members.

Public Types
typedef ConnectedComponentFunctorImageFilter	Self
typedef ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >	Superclass
typedef Superclass::InputImagePointer	InputImagePointer
typedef TOutputImage::PixelType	OutputPixelType
typedef TOutputImage::InternalPixelType	OutputInternalPixelType
typedef TInputImage::PixelType	InputPixelType
typedef TInputImage::InternalPixelType	InputInternalPixelType
typedef TFunctor	FunctorType
typedef TInputImage	InputImageType
typedef TMaskImage	MaskImageType
typedef TOutputImage	OutputImageType
typedef TInputImage::IndexType	IndexType
typedef TInputImage::SizeType	SizeType
typedef TOutputImage::RegionType	RegionType
typedef std::list< IndexType >	ListType
typedef MaskImageType::Pointer	MaskImagePointer
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
Public Member Functions
	itkStaticConstMacro (ImageDimension, unsigned int, TOutputImage::ImageDimension)
virtual const char *	GetNameOfClass () const
FunctorType &	GetFunctor ()
const FunctorType &	GetFunctor () const
void	SetFunctor (const FunctorType &functor)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ConnectedComponentFunctorImageFilter ()
virtual	~ConnectedComponentFunctorImageFilter ()
	ConnectedComponentFunctorImageFilter (const Self &)
void	GenerateData ()
Protected Attributes
FunctorType	m_Functor

---

Detailed Description

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage>
class itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >

A generic connected components filter that labels the objects in an artibitrary image.

ConnectedComponentFunctorImageFilter labels the objects in an arbitrary image. Each distinct object is assigned a unique label. The filter makes three passes through the image. The first pass initializes the output. The second pass labels each foreground pixel such that all the pixels associated with an object either have the same label or have had their labels entered into a equivalency table. The third pass through the image flattens the equivalency table such that all pixels for an object have the same label.

The functor specifies the criteria to join neighboring pixels. For example a simple intensity threshold difference might be used for scalar imagery.

The final object labels are in no particular order (and some object labels may not be used on the final objects). You can reorder the labels such that object labels are consecutive and sorted based on object size by passing the output of this filter to a RelabelComponentImageFilter.

See also:

ImageToImageFilter

Definition at line 54 of file itkConnectedComponentFunctorImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef SmartPointer<const Self> itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::ConstPointer

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Reimplemented in itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >, and itk::VectorConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 98 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef TFunctor itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::FunctorType

Image typedef support Definition at line 83 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef TInputImage::IndexType itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::IndexType

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 87 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef Superclass::InputImagePointer itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::InputImagePointer

Types from the Superclass Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 67 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef TInputImage itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::InputImageType

Image typedef support Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 84 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef TInputImage::InternalPixelType itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::InputInternalPixelType

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 76 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef TInputImage::PixelType itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::InputPixelType

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Reimplemented in itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 75 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef std::list<IndexType> itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::ListType

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 90 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef MaskImageType::Pointer itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::MaskImagePointer

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 92 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef TMaskImage itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::MaskImageType

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 85 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef TOutputImage itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::OutputImageType

Some convenient typedefs. Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 86 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef TOutputImage::InternalPixelType itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::OutputInternalPixelType

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 74 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef TOutputImage::PixelType itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::OutputPixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same. Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 73 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef SmartPointer<Self> itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::Pointer

Smart pointer typedef support Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Reimplemented in itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >, and itk::VectorConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 97 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef TOutputImage::RegionType itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::RegionType

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 89 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef ConnectedComponentFunctorImageFilter itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::Self

Standard "Self" & Superclass typedef. Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Reimplemented in itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >, and itk::VectorConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 61 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef TInputImage::SizeType itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::SizeType

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 88 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> typedef ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage > itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::Superclass

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Reimplemented in itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >, and itk::VectorConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Definition at line 62 of file itkConnectedComponentFunctorImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::ConnectedComponentFunctorImageFilter (   )  [inline, protected]

Definition at line 132 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> virtual itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::~ConnectedComponentFunctorImageFilter (   )  [inline, protected, virtual]

Definition at line 133 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::ConnectedComponentFunctorImageFilter (  const Self &   )  [inline, protected]

Definition at line 134 of file itkConnectedComponentFunctorImageFilter.h.

---

Member Function Documentation

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> void itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::GenerateData (   )  [protected, virtual]

Standard pipeline method. Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> const FunctorType& itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::GetFunctor (   )  const [inline]

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.) Definition at line 115 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> FunctorType& itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::GetFunctor (   )  [inline]

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.) Definition at line 114 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> virtual const char* itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods) Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Reimplemented in itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >, and itk::VectorConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TOutputImage::ImageDimension  )

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> Pointer itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >. Reimplemented in itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >, and itk::VectorConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> void itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::SetFunctor (  const FunctorType &  functor  )  [inline]

Set the functor object. This replaces the current Functor with a copy of the specified Functor. This allows the user to specify a functor that has ivars set differently than the default functor. This method requires an operator!=() be defined on the functor (or the compiler's default implementation of operator!=() being appropriate). Definition at line 124 of file itkConnectedComponentFunctorImageFilter.h.

---

Member Data Documentation

template<class TInputImage, class TOutputImage, class TFunctor, class TMaskImage = TInputImage> FunctorType itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, TFunctor, TMaskImage >::m_Functor [protected]

Definition at line 136 of file itkConnectedComponentFunctorImageFilter.h.

---

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

• itkConnectedComponentFunctorImageFilter.h

---