#include <otbRelabelComponentImageFilter.h>

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

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

Public Types
typedef Superclass::InputImagePointer	InputImagePointer

typedef RelabelComponentImageFilter	Self

typedef itk::RelabelComponentImageFilter< TInputImage, TOutputImage >	Superclass

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 itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

typedef unsigned long int	LabelType

typedef unsigned long int	ObjectSizeType

static const unsigned int	ImageDimension = TOutputImage::ImageDimension

static const unsigned int	InputImageDimension = TInputImage::ImageDimension

virtual const char *	GetNameOfClass () const

virtual ::itk::LightObject::Pointer	CreateAnother (void) const

static Pointer	New ()

	RelabelComponentImageFilter ()

virtual	~RelabelComponentImageFilter ()

void	GenerateInputRequestedRegion ()

void	EnlargeOutputRequestedRegion (itk::DataObject *)

	RelabelComponentImageFilter (const Self &)=delete

void	operator= (const Self &)=delete

Detailed Description

template<class TInputImage, class TOutputImage>
class otb::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

Definition at line 80 of file otbRelabelComponentImageFilter.h.