#include <itkRelabelComponentImageFilter.h>

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

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

Classes
struct	RelabelComponentObjectType
class	RelabelComponentSizeInPixelsComparator
Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage::IndexType	IndexType
typedef Superclass::InputImagePointer	InputImagePointer
typedef TInputImage	InputImageType
typedef IdentifierType	LabelType
typedef std::vector< float >	ObjectSizeInPhysicalUnitsContainerType
typedef std::vector < ObjectSizeType >	ObjectSizeInPixelsContainerType
typedef SizeValueType	ObjectSizeType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef TOutputImage::RegionType	RegionType
typedef RelabelComponentImageFilter	Self
typedef TInputImage::SizeType	SizeType
typedef InPlaceImageFilter < TInputImage, TOutputImage >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual ObjectSizeType	GetMinimumObjectSize () const
virtual const char *	GetNameOfClass () const
virtual LabelType	GetNumberOfObjects () const
virtual LabelType	GetOriginalNumberOfObjects () const
const ObjectSizeInPhysicalUnitsContainerType &	GetSizeOfObjectsInPhysicalUnits () const
const ObjectSizeInPixelsContainerType &	GetSizeOfObjectsInPixels () const
virtual void	SetMinimumObjectSize (ObjectSizeType _arg)
	typedef (Concept::EqualityComparable< InputPixelType >) InputEqualityComparableCheck
	typedef (Concept::Convertible< LabelType, InputPixelType >) UnsignedLongConvertibleToInputCheck
	typedef (Concept::Convertible< OutputPixelType, LabelType >) OutputLongConvertibleToUnsignedLongCheck
	typedef (Concept::Convertible< InputPixelType, OutputPixelType >) InputConvertibleToOutputCheck
	typedef (Concept::SameDimension< InputImageDimension, ImageDimension >) SameDimensionCheck

virtual void	SetNumberOfObjectsToPrint (LabelType _arg)
virtual const LabelType &	GetNumberOfObjectsToPrint ()

ObjectSizeType	GetSizeOfObjectInPixels (LabelType obj) const

float	GetSizeOfObjectInPhysicalUnits (LabelType obj) const
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
void	GenerateData ()
void	GenerateInputRequestedRegion ()
void	PrintSelf (std::ostream &os, Indent indent) const
	RelabelComponentImageFilter ()
virtual	~RelabelComponentImageFilter ()
Private Member Functions
void	operator= (const Self &)
	RelabelComponentImageFilter (const Self &)
Private Attributes
ObjectSizeType	m_MinimumObjectSize
LabelType	m_NumberOfObjects
LabelType	m_NumberOfObjectsToPrint
LabelType	m_OriginalNumberOfObjects
ObjectSizeInPhysicalUnitsContainerType	m_SizeOfObjectsInPhysicalUnits
ObjectSizeInPixelsContainerType	m_SizeOfObjectsInPixels
typedef TOutputImage::PixelType	OutputPixelType
typedef TOutputImage::InternalPixelType	OutputInternalPixelType
typedef TInputImage::PixelType	InputPixelType
typedef TInputImage::InternalPixelType	InputInternalPixelType
static const unsigned int	ImageDimension = TOutputImage::ImageDimension
static const unsigned int	InputImageDimension = TInputImage::ImageDimension

Detailed Description

template<class TInputImage, class TOutputImage>
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 relabeling 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.

If user sets a minimum object size, all objects with fewer pixelss than the minimum will be discarded, so that the number of objects reported will be only those remaining. The GetOriginalNumberOfObjects method can be called to find out how many objects were present before the small ones were discarded.

RelabelComponentImageFilter can be run as an "in place" filter, where it will overwrite its output. The default is run out of place (or generate a separate output). "In place" operation can be controlled via methods in the superclass, InPlaceImageFilter::InPlaceOn() and InPlaceImageFilter::InPlaceOff().

See also:: ConnectedComponentImageFilter, BinaryThresholdImageFilter, ThresholdImageFilter

Wiki Examples:

All Examples

Assign contiguous labels to connected regions of an image

Definition at line 79 of file itkRelabelComponentImageFilter.h.