itk::RelabelComponentImageFilter< TInputImage, TOutputImage > Class Template Reference

Relabel the components in an image such that consecutive labels are used. More...

#include <itkRelabelComponentImageFilter.h>

Inheritance diagram for itk::RelabelComponentImageFilter< TInputImage, TOutputImage >:

[legend]Collaboration diagram for itk::RelabelComponentImageFilter< TInputImage, TOutputImage >:

[legend]List of all members.

Public Types
typedef RelabelComponentImageFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef Superclass::InputImagePointer	InputImagePointer
typedef TOutputImage::PixelType	OutputPixelType
typedef TOutputImage::InternalPixelType	OutputInternalPixelType
typedef TInputImage::PixelType	InputPixelType
typedef TInputImage::InternalPixelType	InputInternalPixelType
typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef TInputImage::IndexType	IndexType
typedef TInputImage::SizeType	SizeType
typedef TOutputImage::RegionType	RegionType
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
Public Member Functions
	itkStaticConstMacro (ImageDimension, unsigned int, TOutputImage::ImageDimension)
virtual const char *	GetClassName () const
virtual unsigned long	GetNumberOfObjects ()
const std::vector< unsigned long > &	GetSizeOfObjectsInPixels () const
const std::vector< unsigned long > &	GetSizeOfObjectsInPhysicalUnits () const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	RelabelComponentImageFilter ()
virtual	~RelabelComponentImageFilter ()
	RelabelComponentImageFilter (const Self &)
void	GenerateData ()
void	GenerateInputRequestedRegion ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<class TInputImage, class TOutputImage = TInputImage>
class itk::RelabelComponentImageFilter< TInputImage, TOutputImage >

Relabel the components in an image such that consecutive labels are used.

RelabelComponentImageFilter remaps the labels associated with the objects in an image (as from the output of ConnectedComponentImageFilter) such that the label numbers are consecutive with no gaps between the label numbers used. By default, the relabling will also sort the labels based on the size of the object: the largest object will have label #1, the second largest will have label #2, etc.

Label #0 is assumed to be background is left unaltered by the relabeling.

RelabelComponentImageFilter is typically used on the output of the ConnectedComponentImageFilter for those applications that want to extract the largest object or the "k" largest objects. Any particular object can be extracted from the relabeled output using a BinaryThresholdImageFilter. A group of objects can be extracted from the relabled output using a ThresholdImageFilter.

Once all the objects are relabeled, the application can query the number of objects and the size of each object. Object sizes are returned in a vector. The size of the background is not calculated. So the size of object #1 is GetSizeOfObjectsInPixels()[0], the size of object #2 is GetSizeOfObjectsInPixels()[1], etc.

See also:

ConnectedComponentImageFilter, BinaryThresholdImageFilter, ThresholdImageFilter

Definition at line 60 of file itkRelabelComponentImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage, class TOutputImage = TInputImage> typedef SmartPointer<const Self> itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 99 of file itkRelabelComponentImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage> typedef TInputImage::IndexType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::IndexType

Definition at line 91 of file itkRelabelComponentImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage> typedef Superclass::InputImagePointer itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::InputImagePointer

Types from the Superclass Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 73 of file itkRelabelComponentImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage> typedef TInputImage itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::InputImageType

Image typedef support Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 89 of file itkRelabelComponentImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage> typedef TInputImage::InternalPixelType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::InputInternalPixelType

Definition at line 82 of file itkRelabelComponentImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage> typedef TInputImage::PixelType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::InputPixelType

Definition at line 81 of file itkRelabelComponentImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage> typedef TOutputImage itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs. Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 90 of file itkRelabelComponentImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage> typedef TOutputImage::InternalPixelType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::OutputInternalPixelType

Definition at line 80 of file itkRelabelComponentImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage> typedef TOutputImage::PixelType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::OutputPixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same. Definition at line 79 of file itkRelabelComponentImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage> typedef SmartPointer<Self> itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::Pointer

Smart pointer typedef support Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 98 of file itkRelabelComponentImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage> typedef TOutputImage::RegionType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::RegionType

Definition at line 93 of file itkRelabelComponentImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage> typedef RelabelComponentImageFilter itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::Self

Standard "Self" & Superclass typedef. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 67 of file itkRelabelComponentImageFilter.h. Referenced by itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::RelabelComponentImageFilter().

template<class TInputImage, class TOutputImage = TInputImage> typedef TInputImage::SizeType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::SizeType

Definition at line 92 of file itkRelabelComponentImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage> typedef ImageToImageFilter< TInputImage, TOutputImage > itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 68 of file itkRelabelComponentImageFilter.h.

---

Constructor & Destructor Documentation

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

Definition at line 132 of file itkRelabelComponentImageFilter.h.

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

Definition at line 135 of file itkRelabelComponentImageFilter.h.

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

Definition at line 136 of file itkRelabelComponentImageFilter.h. References itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::Self.

---

Member Function Documentation

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

Standard pipeline method. Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage = TInputImage> void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion (   )  [protected, virtual]

RelabelComponentImageFilter needs the entire input. Therefore it must provide an implementation GenerateInputRequestedRegion(). See also: ProcessObject::GenerateInputRequestedRegion(). Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage = TInputImage> virtual const char* itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetClassName (   )  const [virtual]

Run-time type information (and related methods) Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage, class TOutputImage = TInputImage> virtual unsigned long itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetNumberOfObjects (   )  [virtual]

Get the number of objects in the image. This information is only valid after the filter has executed.

template<class TInputImage, class TOutputImage = TInputImage> const std::vector<unsigned long>& itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetSizeOfObjectsInPhysicalUnits (   )  const [inline]

Get the size of each object in physical space (in units of pixel size). This information is only valid after the filter has executed. Size of the background is not calculated. Size of object #1 is GetSizeOfObjectsInPhysicalUnits()[0]. Size of object #2 is GetSizeOfObjectsInPhysicalUnits()[1]. Etc. Definition at line 128 of file itkRelabelComponentImageFilter.h.

template<class TInputImage, class TOutputImage = TInputImage> const std::vector<unsigned long>& itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetSizeOfObjectsInPixels (   )  const [inline]

Get the size of each object in pixels. This information is only valid after the filter has executed. Size of the background is not calculated. Size of object #1 is GetSizeOfObjectsInPixels()[0]. Size of object #2 is GetSizeOfObjectsInPixels()[1]. Etc. Definition at line 120 of file itkRelabelComponentImageFilter.h.

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

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

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TInputImage, class TOutputImage = TInputImage> void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Standard printself method Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

---

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

• itkRelabelComponentImageFilter.h

---