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:

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://doi.org/10.54294/q6auw4

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

See also: ConnectedComponentImageFilter , LabelImageToLabelMapFilter , LabelMap , LabelObject; itk::simple::BinaryImageToLabelMapFilter for the procedural interface; itk::BinaryImageToLabelMapFilter for the Doxygen on the original ITK class.

Definition at line 50 of file sitkBinaryImageToLabelMapFilter.h.

Public Types
using	PixelIDTypeList = IntegerPixelIDTypeList

using	Self = BinaryImageToLabelMapFilter

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
	BinaryImageToLabelMapFilter ()

Image	Execute (const Image &image1)

Self &	FullyConnectedOff ()

Self &	FullyConnectedOn ()

bool	GetFullyConnected () const

double	GetInputForegroundValue () const

std::string	GetName () const

uint64_t	GetNumberOfObjects () const

double	GetOutputBackgroundValue () const

Self &	SetFullyConnected (bool FullyConnected)

Self &	SetInputForegroundValue (double InputForegroundValue)

Self &	SetOutputBackgroundValue (double OutputBackgroundValue)

std::string	ToString () const

virtual	~BinaryImageToLabelMapFilter ()

Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event. More...

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

virtual void	SetNumberOfWorkUnits (unsigned int n)

virtual unsigned int	GetNumberOfWorkUnits () const

Private Types
using	MemberFunctionType = Image(Self::*)(const Image &image1)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1)

Private Attributes
bool	m_FullyConnected {false}

double	m_InputForegroundValue {1.0}

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

uint64_t	m_NumberOfObjects {0}

double	m_OutputBackgroundValue {0.0}

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 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...

static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects. More...

static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects. More...

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects. More...

Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)

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) noexcept

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default

	NonCopyable (const NonCopyable &)=delete

NonCopyable &	operator= (const NonCopyable &)=delete

Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
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 TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType >
static Image	CastITKToImage (TImageType *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)

Member Typedef Documentation

◆ MemberFunctionType

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

private

Setup for member function dispatching

Definition at line 122 of file sitkBinaryImageToLabelMapFilter.h.

◆ PixelIDTypeList

using itk::simple::BinaryImageToLabelMapFilter::PixelIDTypeList = IntegerPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 62 of file sitkBinaryImageToLabelMapFilter.h.

◆ Self

using itk::simple::BinaryImageToLabelMapFilter::Self = BinaryImageToLabelMapFilter

Definition at line 52 of file sitkBinaryImageToLabelMapFilter.h.

Constructor & Destructor Documentation

◆ ~BinaryImageToLabelMapFilter()

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

virtual

Destructor

◆ BinaryImageToLabelMapFilter()

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >

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

private

◆ FullyConnectedOff()

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

inline

Definition at line 72 of file sitkBinaryImageToLabelMapFilter.h.

◆ FullyConnectedOn()

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

inline

Set the value of FullyConnected to true or false respectfully.

Definition at line 71 of file sitkBinaryImageToLabelMapFilter.h.

◆ GetFullyConnected()

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 77 of file sitkBinaryImageToLabelMapFilter.h.

◆ GetInputForegroundValue()

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 87 of file sitkBinaryImageToLabelMapFilter.h.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 108 of file sitkBinaryImageToLabelMapFilter.h.

◆ GetNumberOfObjects()

uint64_t itk::simple::BinaryImageToLabelMapFilter::GetNumberOfObjects ( ) const

inline

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 104 of file sitkBinaryImageToLabelMapFilter.h.

◆ GetOutputBackgroundValue()

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 97 of file sitkBinaryImageToLabelMapFilter.h.

◆ SetFullyConnected()

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 68 of file sitkBinaryImageToLabelMapFilter.h.