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

#include <sitkRelabelComponentImageFilter.h>

Inheritance diagram for itk::simple::RelabelComponentImageFilter:

Collaboration diagram for itk::simple::RelabelComponentImageFilter:

Public Types
typedef IntegerPixelIDTypeList	PixelIDTypeList

typedef RelabelComponentImageFilter	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
Image	Execute (const Image &image1)

Image	Execute (const Image &image1, uint64_t minimumObjectSize, bool sortByObjectSize)

uint64_t	GetMinimumObjectSize () const

std::string	GetName () const

uint32_t	GetNumberOfObjects () const

uint32_t	GetOriginalNumberOfObjects () const

std::vector< float >	GetSizeOfObjectsInPhysicalUnits () const

std::vector< uint64_t >	GetSizeOfObjectsInPixels () const

bool	GetSortByObjectSize () const

	RelabelComponentImageFilter ()

Self &	SetMinimumObjectSize (uint64_t MinimumObjectSize)

Self &	SetSortByObjectSize (bool SortByObjectSize)

Self &	SortByObjectSizeOff ()

Self &	SortByObjectSizeOn ()

std::string	ToString () const

virtual	~RelabelComponentImageFilter ()

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
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

uint64_t	m_MinimumObjectSize

uint32_t	m_NumberOfObjects

uint32_t	m_OriginalNumberOfObjects

std::vector< float >	m_SizeOfObjectsInPhysicalUnits

std::vector< uint64_t >	m_SizeOfObjectsInPixels

bool	m_SortByObjectSize

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::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT

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::EventObject &	GetITKEventObject (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

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. If two labels have the same size their initial order is kept. The sorting by size can be disabled using SetSortByObjectSize.

Label #0 is assumed to be the background and 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 pixels 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; itk::simple::RelabelComponent for the procedural interface; itk::RelabelComponentImageFilter for the Doxygen on the original ITK class.

Definition at line 54 of file sitkRelabelComponentImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 143 of file sitkRelabelComponentImageFilter.h.

typedef IntegerPixelIDTypeList itk::simple::RelabelComponentImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 66 of file sitkRelabelComponentImageFilter.h.

typedef RelabelComponentImageFilter itk::simple::RelabelComponentImageFilter::Self

Definition at line 56 of file sitkRelabelComponentImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::RelabelComponentImageFilter::~RelabelComponentImageFilter ( )

virtual

Destructor

itk::simple::RelabelComponentImageFilter::RelabelComponentImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::RelabelComponentImageFilter::Execute ( const Image & image1 )

Execute the filter on the input image

Image itk::simple::RelabelComponentImageFilter::Execute	(	const Image &	image1,
		uint64_t	minimumObjectSize,
		bool	sortByObjectSize
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

Image itk::simple::RelabelComponentImageFilter::ExecuteInternal ( const Image & image1 )

private

uint64_t itk::simple::RelabelComponentImageFilter::GetMinimumObjectSize ( ) const

inline

Get the caller-defined minimum size of an object in pixels. If the caller has not set the minimum, 0 will be returned, which is to be interpreted as meaning that no minimum exists, and all objects in the original label map will be passed through to the output.

Definition at line 78 of file sitkRelabelComponentImageFilter.h.

std::string itk::simple::RelabelComponentImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 126 of file sitkRelabelComponentImageFilter.h.

uint32_t itk::simple::RelabelComponentImageFilter::GetNumberOfObjects ( ) const

inline

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

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 99 of file sitkRelabelComponentImageFilter.h.

uint32_t itk::simple::RelabelComponentImageFilter::GetOriginalNumberOfObjects ( ) const

inline

Get the original number of objects in the image before small objects were discarded. This information is only valid after the filter has executed. If the caller has not specified a minimum object size, OriginalNumberOfObjects is the same as NumberOfObjects.

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 107 of file sitkRelabelComponentImageFilter.h.

std::vector<float> itk::simple::RelabelComponentImageFilter::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.

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 115 of file sitkRelabelComponentImageFilter.h.

std::vector<uint64_t> itk::simple::RelabelComponentImageFilter::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.

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 123 of file sitkRelabelComponentImageFilter.h.

bool itk::simple::RelabelComponentImageFilter::GetSortByObjectSize ( ) const

inline

Controls whether the object labels are sorted by size. If false, initial order of labels is kept.

Definition at line 92 of file sitkRelabelComponentImageFilter.h.

Self& itk::simple::RelabelComponentImageFilter::SetMinimumObjectSize ( uint64_t MinimumObjectSize )

inline

Set the minimum size in pixels for an object. All objects smaller than this size will be discarded and will not appear in the output label map. NumberOfObjects will count only the objects whose pixel counts are greater than or equal to the minimum size. Call GetOriginalNumberOfObjects to find out how many objects were present in the original label map.

Definition at line 73 of file sitkRelabelComponentImageFilter.h.

Self& itk::simple::RelabelComponentImageFilter::SetSortByObjectSize ( bool SortByObjectSize )

inline

Controls whether the object labels are sorted by size. If false, initial order of labels is kept.

Definition at line 83 of file sitkRelabelComponentImageFilter.h.

Self& itk::simple::RelabelComponentImageFilter::SortByObjectSizeOff ( )

inline

Definition at line 87 of file sitkRelabelComponentImageFilter.h.

Self& itk::simple::RelabelComponentImageFilter::SortByObjectSizeOn ( )

inline

Set the value of SortByObjectSize to true or false respectfully.

Definition at line 86 of file sitkRelabelComponentImageFilter.h.