#include <itkConnectedComponentImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TInputImage>
class itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >

Label the objects in a binary image.

ConnectedComponentImageFilter labels the objects in a binary image (non-zero pixels are considered to be objects, zero-valued pixels are considered to be background). Each distinct object is assigned a unique label. The filter experiments with some improvements to the existing implementation, and is based on run length encoding along raster lines. If the output background value is set to zero (the default), the final object labels start with 1 and are consecutive. If the output background is set to a non-zero value (by calling the SetBackgroundValue() routine of the filter), the final labels start at 0, and remain consecutive except for skipping the background value as needed. Objects that are reached earlier by a raster order scan have a lower label. This is different to the behaviour of the original connected component image filter which did not produce consecutive labels or impose any particular ordering.

After the filter is executed, ObjectCount holds the number of connected components.

See also: ImageToImageFilter

ITK Sphinx Examples:

<a href=
<a href=
<a href=

Definition at line 57 of file itkConnectedComponentImageFilter.h.

Inheritance diagram for itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >:

Collaboration diagram for itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	IndexType = typename TInputImage::IndexType

using	InputImageType = TInputImage

using	InputInternalPixelType = typename TInputImage::InternalPixelType

using	InputPixelType = typename TInputImage::PixelType

using	LabelType = IdentifierType

using	ListType = std::list< IndexType >

using	MaskImagePointer = typename MaskImageType::Pointer

using	MaskImageType = TMaskImage

using	MaskPixelType = typename TMaskImage::PixelType

using	OffsetType = typename TInputImage::OffsetType

using	OutputImagePixelType = typename TOutputImage::PixelType

using	OutputImageType = TOutputImage

using	OutputIndexType = typename TOutputImage::IndexType

using	OutputInternalPixelType = typename TOutputImage::InternalPixelType

using	OutputOffsetType = typename TOutputImage::OffsetType

using	OutputPixelType = typename TOutputImage::PixelType

using	OutputSizeType = typename TOutputImage::SizeType

using	Pointer = SmartPointer< Self >

using	RegionType = typename TOutputImage::RegionType

using	Self = ConnectedComponentImageFilter

using	SizeType = typename TInputImage::SizeType

using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TOutputImage >

Public Types inherited from itk::ImageSource< TOutputImage >
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

Public Types inherited from itk::ProcessObject
using	ConstPointer = SmartPointer< const Self >

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
const char *	GetNameOfClass () const override

virtual const LabelType &	GetObjectCount () const

	itkGetInputMacro (MaskImage, MaskImageType)

	itkSetInputMacro (MaskImage, MaskImageType)


virtual void	SetFullyConnected (bool _arg)

virtual const bool &	GetFullyConnected () const

virtual void	FullyConnectedOn ()


virtual void	SetBackgroundValue (OutputImagePixelType _arg)

virtual OutputImagePixelType	GetBackgroundValue () const

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
const char *	GetNameOfClass () const override

OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

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

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TOutputImage::ImageDimension

static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Types
using	ConsecutiveVectorType = typename ScanlineFunctions::ConsecutiveVectorType

using	InternalLabelType = typename ScanlineFunctions::InternalLabelType

using	LineEncodingConstIterator = typename ScanlineFunctions::LineEncodingConstIterator

using	LineEncodingIterator = typename ScanlineFunctions::LineEncodingIterator

using	LineEncodingType = typename ScanlineFunctions::LineEncodingType

using	LineMapType = typename ScanlineFunctions::LineMapType

using	OffsetVectorConstIterator = typename ScanlineFunctions::OffsetVectorConstIterator

using	OffsetVectorType = typename ScanlineFunctions::OffsetVectorType

using	OutSizeType = typename ScanlineFunctions::OutSizeType

using	RunLength = typename ScanlineFunctions::RunLength

using	ScanlineFunctions = ScanlineFilterCommon< TInputImage, TOutputImage >

using	UnionFindType = typename ScanlineFunctions::UnionFindType

using	WorkUnitData = typename ScanlineFunctions::WorkUnitData

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Protected Types inherited from itk::ScanlineFilterCommon< TInputImage, TOutputImage >
using	CompareLinesCallback = std::function< void(const LineEncodingConstIterator &currentRun, const LineEncodingConstIterator &neighborRun, OffsetValueType oStart, OffsetValueType oLast)>

using	ConsecutiveVectorType = std::vector< OutputPixelType >

using	InternalLabelType = SizeValueType

using	LineEncodingConstIterator = typename LineEncodingType::const_iterator

using	LineEncodingIterator = typename LineEncodingType::iterator

using	LineEncodingType = std::vector< RunLength >

using	LineMapType = std::vector< LineEncodingType >

using	OffsetVectorConstIterator = typename OffsetVectorType::const_iterator

using	OffsetVectorType = std::vector< OffsetValueType >

using	OutSizeType = typename TOutputImage::RegionType::SizeType

using	UnionFindType = std::vector< InternalLabelType >

using	ConstPointer = SmartPointer< const Self >

using	EnclosingFilter = ImageToImageFilter< TInputImage, TOutputImage >

using	IndexType = typename TInputImage::IndexType

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageType = TInputImage

using	InputPixelType = typename TInputImage::PixelType

using	OffsetType = typename TInputImage::OffsetType

using	OutputImagePixelType = typename TOutputImage::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageType = TOutputImage

using	OutputIndexType = typename TOutputImage::IndexType

using	OutputOffsetType = typename TOutputImage::OffsetType

using	OutputPixelType = typename TOutputImage::PixelType

using	OutputRegionType = typename TOutputImage::RegionType

using	OutputSizeType = typename TOutputImage::SizeType

using	Pointer = SmartPointer< Self >

using	RegionType = OutputRegionType

using	Self = ScanlineFilterCommon

using	SizeType = typename TInputImage::SizeType

Protected Member Functions
	ConnectedComponentImageFilter ()

void	DynamicThreadedGenerateData (const RegionType &) override

void	EnlargeOutputRequestedRegion (DataObject *) override

void	GenerateData () override

void	GenerateInputRequestedRegion () override

void	PrintSelf (std::ostream &os, Indent indent) const override

void	ThreadedWriteOutput (const RegionType &)

	~ConnectedComponentImageFilter () override=default

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

void	PrintSelf (std::ostream &os, Indent indent) const override

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Member Functions inherited from itk::ScanlineFilterCommon< TInputImage, TOutputImage >
bool	CheckNeighbors (const OutputIndexType &A, const OutputIndexType &B) const

void	CompareLines (const LineEncodingType &current, const LineEncodingType &Neighbour, bool sameLineOffset, bool labelCompare, OutputPixelType background, CompareLinesCallback callback)

void	ComputeEquivalence (const SizeValueType workUnitResultsIndex, bool strictlyLess)

SizeValueType	CreateConsecutive (OutputPixelType backgroundValue)

WorkUnitData	CreateWorkUnitData (const RegionType &outputRegionForThread)

SizeValueType	IndexToLinearIndex (const IndexType &index) const

void	InitUnion (InternalLabelType numberOfLabels)

void	LinkLabels (const InternalLabelType label1, const InternalLabelType label2)

InternalLabelType	LookupSet (const InternalLabelType label)

void	SetupLineOffsets (bool wholeNeighborhood)

void	Register () const

	ScanlineFilterCommon (EnclosingFilter *enclosingFilter)

void	UnRegister () const noexcept

	~ScanlineFilterCommon ()=default

Private Attributes
OutputPixelType	m_BackgroundValue {}

TInputImage::ConstPointer	m_Input {}

LabelType	m_ObjectCount = 0

Additional Inherited Members
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Static Protected Member Functions inherited from itk::ScanlineFilterCommon< TInputImage, TOutputImage >
static Pointer	New ()

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Protected Attributes inherited from itk::ScanlineFilterCommon< TInputImage, TOutputImage >
ConsecutiveVectorType	m_Consecutive

WeakPointer< EnclosingFilter >	m_EnclosingFilter

bool	m_FullyConnected

LineMapType	m_LineMap

OffsetVectorType	m_LineOffsets

std::mutex	m_Mutex

std::atomic< SizeValueType >	m_NumberOfLabels

UnionFindType	m_UnionFind

std::deque< WorkUnitData >	m_WorkUnitResults

Static Protected Attributes inherited from itk::ScanlineFilterCommon< TInputImage, TOutputImage >
static constexpr unsigned int	ImageDimension = TOutputImage::ImageDimension

static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Member Typedef Documentation

◆ ConsecutiveVectorType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::ConsecutiveVectorType = typename ScanlineFunctions::ConsecutiveVectorType

protected

Definition at line 197 of file itkConnectedComponentImageFilter.h.

◆ ConstPointer

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::ConstPointer = SmartPointer<const Self>

Definition at line 113 of file itkConnectedComponentImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::IndexType = typename TInputImage::IndexType

Definition at line 95 of file itkConnectedComponentImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::InputImageType = TInputImage

Image type alias support

Definition at line 93 of file itkConnectedComponentImageFilter.h.

◆ InputInternalPixelType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::InputInternalPixelType = typename TInputImage::InternalPixelType

Definition at line 84 of file itkConnectedComponentImageFilter.h.

◆ InputPixelType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::InputPixelType = typename TInputImage::PixelType

Definition at line 83 of file itkConnectedComponentImageFilter.h.

◆ InternalLabelType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::InternalLabelType = typename ScanlineFunctions::InternalLabelType

protected

Definition at line 187 of file itkConnectedComponentImageFilter.h.

◆ LabelType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::LabelType = IdentifierType

Type used as identifier of the different component labels.

Definition at line 137 of file itkConnectedComponentImageFilter.h.

◆ LineEncodingConstIterator

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::LineEncodingConstIterator = typename ScanlineFunctions::LineEncodingConstIterator

protected

Definition at line 192 of file itkConnectedComponentImageFilter.h.

◆ LineEncodingIterator

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::LineEncodingIterator = typename ScanlineFunctions::LineEncodingIterator

protected

Definition at line 191 of file itkConnectedComponentImageFilter.h.

◆ LineEncodingType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::LineEncodingType = typename ScanlineFunctions::LineEncodingType

protected

Definition at line 190 of file itkConnectedComponentImageFilter.h.

◆ LineMapType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::LineMapType = typename ScanlineFunctions::LineMapType

protected

Definition at line 195 of file itkConnectedComponentImageFilter.h.

◆ ListType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::ListType = std::list<IndexType>

Definition at line 106 of file itkConnectedComponentImageFilter.h.

◆ MaskImagePointer

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskImagePointer = typename MaskImageType::Pointer

Definition at line 107 of file itkConnectedComponentImageFilter.h.

◆ MaskImageType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskImageType = TMaskImage

Definition at line 94 of file itkConnectedComponentImageFilter.h.

◆ MaskPixelType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskPixelType = typename TMaskImage::PixelType

Definition at line 85 of file itkConnectedComponentImageFilter.h.

◆ OffsetType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OffsetType = typename TInputImage::OffsetType

Definition at line 97 of file itkConnectedComponentImageFilter.h.

◆ OffsetVectorConstIterator

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OffsetVectorConstIterator = typename ScanlineFunctions::OffsetVectorConstIterator

protected

Definition at line 194 of file itkConnectedComponentImageFilter.h.

◆ OffsetVectorType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OffsetVectorType = typename ScanlineFunctions::OffsetVectorType

protected

Definition at line 193 of file itkConnectedComponentImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputImagePixelType = typename TOutputImage::PixelType

Definition at line 104 of file itkConnectedComponentImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputImageType = TOutputImage

Definition at line 99 of file itkConnectedComponentImageFilter.h.

◆ OutputIndexType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputIndexType = typename TOutputImage::IndexType

Definition at line 101 of file itkConnectedComponentImageFilter.h.

◆ OutputInternalPixelType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputInternalPixelType = typename TOutputImage::InternalPixelType

Definition at line 82 of file itkConnectedComponentImageFilter.h.

◆ OutputOffsetType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputOffsetType = typename TOutputImage::OffsetType

Definition at line 103 of file itkConnectedComponentImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputPixelType = typename TOutputImage::PixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 81 of file itkConnectedComponentImageFilter.h.

◆ OutputSizeType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputSizeType = typename TOutputImage::SizeType

Definition at line 102 of file itkConnectedComponentImageFilter.h.

◆ OutSizeType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OutSizeType = typename ScanlineFunctions::OutSizeType

protected

Definition at line 188 of file itkConnectedComponentImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::Pointer = SmartPointer<Self>

Smart pointer type alias support

Definition at line 112 of file itkConnectedComponentImageFilter.h.

◆ RegionType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::RegionType = typename TOutputImage::RegionType

Definition at line 100 of file itkConnectedComponentImageFilter.h.

◆ RunLength

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::RunLength = typename ScanlineFunctions::RunLength

protected

Definition at line 189 of file itkConnectedComponentImageFilter.h.

◆ ScanlineFunctions

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::ScanlineFunctions = ScanlineFilterCommon<TInputImage, TOutputImage>

protected

Definition at line 185 of file itkConnectedComponentImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::Self = ConnectedComponentImageFilter

Standard "Self" & Superclass typedef.

Definition at line 67 of file itkConnectedComponentImageFilter.h.

◆ SizeType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::SizeType = typename TInputImage::SizeType

Definition at line 96 of file itkConnectedComponentImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 68 of file itkConnectedComponentImageFilter.h.

◆ UnionFindType

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::UnionFindType = typename ScanlineFunctions::UnionFindType

protected

Definition at line 196 of file itkConnectedComponentImageFilter.h.

◆ WorkUnitData

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

using itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::WorkUnitData = typename ScanlineFunctions::WorkUnitData

protected

Definition at line 198 of file itkConnectedComponentImageFilter.h.

Constructor & Destructor Documentation

◆ ConnectedComponentImageFilter()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::ConnectedComponentImageFilter ( )

protected

◆ ~ConnectedComponentImageFilter()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::~ConnectedComponentImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::DynamicThreadedGenerateData ( const RegionType & )

overrideprotected

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::EnlargeOutputRequestedRegion ( DataObject * )

overrideprotectedvirtual

ConnectedComponentImageFilter will produce all of the output. Therefore it must provide an implementation of EnlargeOutputRequestedRegion().

See also: ProcessObject::EnlargeOutputRequestedRegion()

Reimplemented from itk::ProcessObject.

◆ FullyConnectedOn()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

virtual void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::FullyConnectedOn ( )

virtual

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.

◆ GenerateData()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::GenerateData ( )

overrideprotectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.

See also: ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

ConnectedComponentImageFilter needs the entire input. Therefore it must provide an implementation GenerateInputRequestedRegion().

See also: ProcessObject::GenerateInputRequestedRegion().

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

◆ GetBackgroundValue()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

virtual OutputImagePixelType itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::GetBackgroundValue ( ) const

virtual

Set the pixel intensity to be used for background (non-object) regions of the image in the output. Note that this does NOT set the background value to be used in the input image.

◆ GetFullyConnected()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

virtual const bool & itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::GetFullyConnected ( ) const

virtual

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.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

const char * itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::GetNameOfClass ( ) const

overridevirtual

Run-time type information (and related methods)

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

◆ GetObjectCount()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

virtual const LabelType & itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::GetObjectCount ( ) const

virtual

◆ itkGetInputMacro()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::itkGetInputMacro	(	MaskImage	,
		MaskImageType
	)

◆ itkSetInputMacro()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::itkSetInputMacro	(	MaskImage	,
		MaskImageType
	)

◆ New()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

static Pointer itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

◆ SetBackgroundValue()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

virtual void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::SetBackgroundValue ( OutputImagePixelType _arg )

virtual

Set the pixel intensity to be used for background (non-object) regions of the image in the output. Note that this does NOT set the background value to be used in the input image.

◆ SetFullyConnected()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

virtual void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::SetFullyConnected ( bool _arg )

virtual

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.

◆ ThreadedWriteOutput()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::ThreadedWriteOutput ( const RegionType & )

protected

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

constexpr unsigned int itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::ImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 86 of file itkConnectedComponentImageFilter.h.

◆ InputImageDimension

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

constexpr unsigned int itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::InputImageDimension = TInputImage::ImageDimension

staticconstexpr

Definition at line 88 of file itkConnectedComponentImageFilter.h.

◆ m_BackgroundValue

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

OutputPixelType itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::m_BackgroundValue {}

private

Definition at line 201 of file itkConnectedComponentImageFilter.h.

◆ m_Input

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

TInputImage::ConstPointer itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::m_Input {}

private

Definition at line 204 of file itkConnectedComponentImageFilter.h.

◆ m_ObjectCount

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

LabelType itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::m_ObjectCount = 0

private

Definition at line 202 of file itkConnectedComponentImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TInputImage>

constexpr unsigned int itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 87 of file itkConnectedComponentImageFilter.h.

The documentation for this class was generated from the following file:

itkConnectedComponentImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConsecutiveVectorType

◆ ConstPointer

◆ IndexType

◆ InputImageType

◆ InputInternalPixelType

◆ InputPixelType

◆ InternalLabelType

◆ LabelType

◆ LineEncodingConstIterator

◆ LineEncodingIterator

◆ LineEncodingType

◆ LineMapType

◆ ListType

◆ MaskImagePointer

◆ MaskImageType

◆ MaskPixelType

◆ OffsetType

◆ OffsetVectorConstIterator

◆ OffsetVectorType

◆ OutputImagePixelType

◆ OutputImageType

◆ OutputIndexType

◆ OutputInternalPixelType

◆ OutputOffsetType

◆ OutputPixelType

◆ OutputSizeType

◆ OutSizeType

◆ Pointer

◆ RegionType

◆ RunLength

◆ ScanlineFunctions

◆ Self

◆ SizeType

◆ Superclass

◆ UnionFindType

◆ WorkUnitData

Constructor & Destructor Documentation

◆ ConnectedComponentImageFilter()

◆ ~ConnectedComponentImageFilter()

Member Function Documentation

◆ DynamicThreadedGenerateData()

◆ EnlargeOutputRequestedRegion()

◆ FullyConnectedOn()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GetBackgroundValue()

◆ GetFullyConnected()

◆ GetNameOfClass()

◆ GetObjectCount()

◆ itkGetInputMacro()

◆ itkSetInputMacro()

◆ New()

◆ PrintSelf()

◆ SetBackgroundValue()

◆ SetFullyConnected()

◆ ThreadedWriteOutput()

Member Data Documentation

◆ ImageDimension

◆ InputImageDimension

◆ m_BackgroundValue

◆ m_Input

◆ m_ObjectCount

◆ OutputImageDimension