Label the connected components in a binary image and produce a collection of label objects. More...

#include <sitkBinaryImageToLabelMapFilter.h>

Inheritance diagram for itk::simple::BinaryImageToLabelMapFilter:

Collaboration diagram for itk::simple::BinaryImageToLabelMapFilter:

Public Types
typedef IntegerPixelIDTypeList	PixelIDTypeList

typedef BinaryImageToLabelMapFilter	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
	BinaryImageToLabelMapFilter ()

Image	Execute (const Image &image1)

Image	Execute (const Image &image1, bool fullyConnected, double inputForegroundValue, double outputBackgroundValue)

Self &	FullyConnectedOff ()

Self &	FullyConnectedOn ()

bool	GetFullyConnected () const

double	GetInputForegroundValue () const

std::string	GetName () const

double	GetOutputBackgroundValue () const

Self &	SetFullyConnected (bool FullyConnected)

Self &	SetInputForegroundValue (double InputForegroundValue)

Self &	SetOutputBackgroundValue (double OutputBackgroundValue)

std::string	ToString () const

	~BinaryImageToLabelMapFilter ()

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
bool	m_FullyConnected

double	m_InputForegroundValue

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

double	m_OutputBackgroundValue

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) throw ()

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

Label the connected components in a binary image and produce a collection of label objects.

BinaryImageToLabelMapFilter labels the objects in a binary image. Each distinct object is assigned a unique label. The final object labels start with 1 and are consecutive. Objects that are reached earlier by a raster order scan have a lower label.

The GetOutput() function of this class returns an itk::LabelMap .

This implementation was taken from the Insight Journal paper: https://hdl.handle.net/1926/584 or http://www.insight-journal.org/browse/publication/176

Author: Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

See also: ConnectedComponentImageFilter , LabelImageToLabelMapFilter , LabelMap , LabelObject

Wiki Examples:

All Examples

Label binary regions in an image
See also
itk::simple::BinaryImageToLabelMapFilter for the procedural interface

itk::BinaryImageToLabelMapFilter for the Doxygen on the original ITK class.

Definition at line 56 of file sitkBinaryImageToLabelMapFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 124 of file sitkBinaryImageToLabelMapFilter.h.

typedef IntegerPixelIDTypeList itk::simple::BinaryImageToLabelMapFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 68 of file sitkBinaryImageToLabelMapFilter.h.

typedef BinaryImageToLabelMapFilter itk::simple::BinaryImageToLabelMapFilter::Self

Definition at line 58 of file sitkBinaryImageToLabelMapFilter.h.

Constructor & Destructor Documentation

itk::simple::BinaryImageToLabelMapFilter::BinaryImageToLabelMapFilter ( )

Default Constructor that takes no arguments and initializes default parameters

itk::simple::BinaryImageToLabelMapFilter::~BinaryImageToLabelMapFilter ( )

Destructor

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::BinaryImageToLabelMapFilter::Execute	(	const Image &	image1,
		bool	fullyConnected,
		double	inputForegroundValue,
		double	outputBackgroundValue
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

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

private

Self& itk::simple::BinaryImageToLabelMapFilter::FullyConnectedOff ( )

inline

Definition at line 79 of file sitkBinaryImageToLabelMapFilter.h.

Self& itk::simple::BinaryImageToLabelMapFilter::FullyConnectedOn ( )

inline

Set the value of FullyConnected to true or false respectfully.

Definition at line 78 of file sitkBinaryImageToLabelMapFilter.h.

bool itk::simple::BinaryImageToLabelMapFilter::GetFullyConnected ( ) const

inline

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Definition at line 84 of file sitkBinaryImageToLabelMapFilter.h.

double itk::simple::BinaryImageToLabelMapFilter::GetInputForegroundValue ( ) const

inline

Set/Get the value to be consider "foreground" in the input image. Defaults to NumericTraits<InputPixelType>::max() .

Definition at line 94 of file sitkBinaryImageToLabelMapFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 106 of file sitkBinaryImageToLabelMapFilter.h.

double itk::simple::BinaryImageToLabelMapFilter::GetOutputBackgroundValue ( ) const

inline

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<OutputPixelType>::NonpositiveMin() .

Definition at line 104 of file sitkBinaryImageToLabelMapFilter.h.

Self& itk::simple::BinaryImageToLabelMapFilter::SetFullyConnected ( bool FullyConnected )

inline

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Definition at line 75 of file sitkBinaryImageToLabelMapFilter.h.

Self& itk::simple::BinaryImageToLabelMapFilter::SetInputForegroundValue ( double InputForegroundValue )

inline

Set/Get the value to be consider "foreground" in the input image. Defaults to NumericTraits<InputPixelType>::max() .

Definition at line 89 of file sitkBinaryImageToLabelMapFilter.h.

Self& itk::simple::BinaryImageToLabelMapFilter::SetOutputBackgroundValue ( double OutputBackgroundValue )

inline

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<OutputPixelType>::NonpositiveMin() .

Definition at line 99 of file sitkBinaryImageToLabelMapFilter.h.

std::string itk::simple::BinaryImageToLabelMapFilter::ToString ( ) const

virtual

Print ourselves out