#include <itkAggregateLabelMapFilter.h>

Inheritance diagram for itk::AggregateLabelMapFilter< TImage >:

Collaboration diagram for itk::AggregateLabelMapFilter< TImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	ImageConstPointer = typename ImageType::ConstPointer

using	ImagePointer = typename ImageType::Pointer

using	ImageType = TImage

using	IndexType = typename ImageType::IndexType

using	LabelObjectType = typename ImageType::LabelObjectType

using	PixelType = typename ImageType::PixelType

using	Pointer = SmartPointer< Self >

using	Self = AggregateLabelMapFilter

using	Superclass = InPlaceLabelMapFilter< TImage >

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

using	IndexType = typename InputImageType::IndexType

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TImage

using	LabelObjectType = typename InputImageType::LabelObjectType

using	PixelType = typename InputImageType::PixelType

using	Pointer = SmartPointer< Self >

using	RegionType = typename InputImageType::RegionType

using	Self = InPlaceLabelMapFilter

using	Superclass = LabelMapFilter< TImage, TImage >

using	TOutputImage = TImage

Public Types inherited from itk::LabelMapFilter< TImage, TImage >
using	ConstPointer = SmartPointer< const Self >

using	LabelObjectType = typename InputImageType::LabelObjectType

using	OutputImageConstPointer = typename OutputImageType::ConstPointer

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TImage

using	Pointer = SmartPointer< Self >

using	Self = LabelMapFilter

using	Superclass = ImageToImageFilter< TImage, TImage >

Public Types inherited from itk::ImageToImageFilter< TImage, TImage >
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 = TImage

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TImage >

Public Types inherited from itk::ImageSource< TImage >
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 = TImage

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
virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::InPlaceLabelMapFilter< TImage >
bool	CanRunInPlace () const

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace ()

virtual void	InPlaceOn ()

Public Member Functions inherited from itk::LabelMapFilter< TImage, TImage >
void	EnlargeOutputRequestedRegion (DataObject *) override

void	GenerateInputRequestedRegion () override

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

const InputImageType *	GetInput (unsigned int idx) const

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 TImage *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< TImage >
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 const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

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

unsigned long	AddObserver (const EventObject &event, Command *) 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

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)

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 void	Delete ()

virtual int	GetReferenceCount () const

	itkTypeMacroNoParent (LightObject)

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

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::InPlaceLabelMapFilter< TImage >
static Pointer	New ()

Static Public Member Functions inherited from itk::LabelMapFilter< TImage, TImage >
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TImage, TImage >
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 = TImage::ImageDimension

Static Public Attributes inherited from itk::InPlaceLabelMapFilter< TImage >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::LabelMapFilter< TImage, TImage >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TImage, TImage >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TImage >
static constexpr unsigned int	OutputImageDimension

Protected Member Functions
	AggregateLabelMapFilter ()=default

void	GenerateData () override

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

	~AggregateLabelMapFilter () override=default

Protected Member Functions inherited from itk::InPlaceLabelMapFilter< TImage >
void	AllocateOutputs () override

InputImageType *	GetLabelMap () override

	InPlaceLabelMapFilter ()=default

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

	~InPlaceLabelMapFilter () override=default

Protected Member Functions inherited from itk::LabelMapFilter< TImage, TImage >
void	AfterThreadedGenerateData () override

void	BeforeThreadedGenerateData () override

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

	LabelMapFilter ()

void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType) override

virtual void	ThreadedProcessLabelObject (LabelObjectType *labelObject)

	~LabelMapFilter () override=default

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

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

	ImageToImageFilter ()

void	VerifyInputInformation () ITKv5_CONST override

	~ImageToImageFilter () override=default

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

Protected Member Functions inherited from itk::ImageSource< TImage >
void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

	~ImageSource () override=default

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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

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	VerifyPreconditions () ITKv5_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

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	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TImage, TImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

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

Static Protected Member Functions inherited from itk::ImageSource< TImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::LabelMapFilter< TImage, TImage >
std::mutex	m_LabelObjectContainerLock

Protected Attributes inherited from itk::ImageSource< TImage >
bool	m_DynamicMultiThreading

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

bool	m_Updating {}

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

Detailed Description

template<typename TImage>
class itk::AggregateLabelMapFilter< TImage >

Collapses all labels into the first label.

This filter takes a label map as input and visits the pixels of all labels and assigns them to the first label of the label map. At the end of the execution of this filter, the map will contain a single filter.

This implementation was taken from the Insight Journal paper: https://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: ShapeLabelObject, RelabelComponentImageFilter

Definition at line 44 of file itkAggregateLabelMapFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TImage >

using itk::AggregateLabelMapFilter< TImage >::ConstPointer = SmartPointer<const Self>

Definition at line 53 of file itkAggregateLabelMapFilter.h.

◆ ImageConstPointer

template<typename TImage >

using itk::AggregateLabelMapFilter< TImage >::ImageConstPointer = typename ImageType::ConstPointer

Definition at line 58 of file itkAggregateLabelMapFilter.h.

◆ ImagePointer

template<typename TImage >

using itk::AggregateLabelMapFilter< TImage >::ImagePointer = typename ImageType::Pointer

Definition at line 57 of file itkAggregateLabelMapFilter.h.

◆ ImageType

template<typename TImage >

using itk::AggregateLabelMapFilter< TImage >::ImageType = TImage

Some convenient type alias.

Definition at line 56 of file itkAggregateLabelMapFilter.h.

◆ IndexType

template<typename TImage >

using itk::AggregateLabelMapFilter< TImage >::IndexType = typename ImageType::IndexType

Definition at line 60 of file itkAggregateLabelMapFilter.h.

◆ LabelObjectType

template<typename TImage >

using itk::AggregateLabelMapFilter< TImage >::LabelObjectType = typename ImageType::LabelObjectType

Definition at line 61 of file itkAggregateLabelMapFilter.h.

◆ PixelType

template<typename TImage >

using itk::AggregateLabelMapFilter< TImage >::PixelType = typename ImageType::PixelType

Definition at line 59 of file itkAggregateLabelMapFilter.h.

◆ Pointer

template<typename TImage >

using itk::AggregateLabelMapFilter< TImage >::Pointer = SmartPointer<Self>

Definition at line 52 of file itkAggregateLabelMapFilter.h.

◆ Self

template<typename TImage >

using itk::AggregateLabelMapFilter< TImage >::Self = AggregateLabelMapFilter

Standard class type aliases.

Definition at line 50 of file itkAggregateLabelMapFilter.h.

◆ Superclass

template<typename TImage >

using itk::AggregateLabelMapFilter< TImage >::Superclass = InPlaceLabelMapFilter<TImage>

Definition at line 51 of file itkAggregateLabelMapFilter.h.

Constructor & Destructor Documentation

◆ AggregateLabelMapFilter()

template<typename TImage >

itk::AggregateLabelMapFilter< TImage >::AggregateLabelMapFilter ( )

protecteddefault

◆ ~AggregateLabelMapFilter()

template<typename TImage >

itk::AggregateLabelMapFilter< TImage >::~AggregateLabelMapFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

template<typename TImage >

void itk::AggregateLabelMapFilter< TImage >::GenerateData ( )

overrideprotectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

◆ GetNameOfClass()

template<typename TImage >

virtual const char* itk::AggregateLabelMapFilter< TImage >::GetNameOfClass ( ) const

virtual

Runtime information support.

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

◆ New()

template<typename TImage >

static Pointer itk::AggregateLabelMapFilter< TImage >::New ( )

static

Standard New method.

◆ PrintSelf()

template<typename TImage >

void itk::AggregateLabelMapFilter< TImage >::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::ProcessObject.

Member Data Documentation

◆ ImageDimension

template<typename TImage >

constexpr unsigned int itk::AggregateLabelMapFilter< TImage >::ImageDimension = TImage::ImageDimension

staticconstexpr

ImageDimension constants

Definition at line 64 of file itkAggregateLabelMapFilter.h.

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

itkAggregateLabelMapFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

template<typename TImage> class itk::AggregateLabelMapFilter< TImage >

Member Typedef Documentation

◆ ConstPointer

◆ ImageConstPointer

◆ ImagePointer

◆ ImageType

◆ IndexType

◆ LabelObjectType

◆ PixelType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ AggregateLabelMapFilter()

◆ ~AggregateLabelMapFilter()

Member Function Documentation

◆ GenerateData()

◆ GetNameOfClass()

◆ New()

◆ PrintSelf()

Member Data Documentation

◆ ImageDimension

template<typename TImage>
class itk::AggregateLabelMapFilter< TImage >