#include <itkRelabelComponentImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::RelabelComponentImageFilter< TInputImage, TOutputImage >

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

RelabelComponentImageFilter remaps the labels associated with the objects in an image (as from the output of ConnectedComponentImageFilter) such that the label numbers are consecutive with no gaps between the label numbers used. By default, the relabeling will also sort the labels based on the size of the object: the largest object will have label #1, the second largest will have label #2, etc. If two labels have the same size their initial order is kept. The sorting by size can be disabled using SetSortByObjectSize.

Label #0 is assumed to be the background and is left unaltered by the relabeling.

RelabelComponentImageFilter is typically used on the output of the ConnectedComponentImageFilter for those applications that want to extract the largest object or the "k" largest objects. Any particular object can be extracted from the relabeled output using a BinaryThresholdImageFilter. A group of objects can be extracted from the relabeled output using a ThresholdImageFilter.

Once all the objects are relabeled, the application can query the number of objects and the size of each object. Object sizes are returned in a vector. The size of the background is not calculated. So the size of object #1 is GetSizeOfObjectsInPixels()[0], the size of object #2 is GetSizeOfObjectsInPixels()[1], etc.

If user sets a minimum object size, all objects with fewer pixels than the minimum will be discarded, so that the number of objects reported will be only those remaining. The GetOriginalNumberOfObjects method can be called to find out how many objects were present before the small ones were discarded.

RelabelComponentImageFilter can be run as an "in place" filter, where it will overwrite its output. The default is run out of place (or generate a separate output). "In place" operation can be controlled via methods in the superclass, InPlaceImageFilter::InPlaceOn() and InPlaceImageFilter::InPlaceOff().

See also: ConnectedComponentImageFilter, BinaryThresholdImageFilter, ThresholdImageFilter

ITK Sphinx Examples:

<a href=
<a href=

Definition at line 81 of file itkRelabelComponentImageFilter.h.

Inheritance diagram for itk::RelabelComponentImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::RelabelComponentImageFilter< TInputImage, TOutputImage >:

Classes
struct	RelabelComponentObjectType

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

using	ObjectSizeInPhysicalUnitsContainerType = std::vector< float >

using	ObjectSizeInPixelsContainerType = std::vector< ObjectSizeType >

using	ObjectSizeType = SizeValueType

using	OutputImageType = TOutputImage

using	OutputInternalPixelType = typename TOutputImage::InternalPixelType

using	OutputPixelType = typename TOutputImage::PixelType

using	Pointer = SmartPointer< Self >

using	RegionType = typename TOutputImage::RegionType

using	Self = RelabelComponentImageFilter

using	SizeType = typename TInputImage::SizeType

using	Superclass = InPlaceImageFilter< TInputImage, TOutputImage >

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

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
virtual ObjectSizeType	GetMinimumObjectSize () const

const char *	GetNameOfClass () const override

virtual SizeValueType	GetNumberOfObjects () const

virtual SizeValueType	GetOriginalNumberOfObjects () const

const ObjectSizeInPhysicalUnitsContainerType &	GetSizeOfObjectsInPhysicalUnits () const

const ObjectSizeInPixelsContainerType &	GetSizeOfObjectsInPixels () const

virtual void	SetMinimumObjectSize (ObjectSizeType _arg)


virtual void	SetNumberOfObjectsToPrint (SizeValueType _arg)

virtual const SizeValueType &	GetNumberOfObjectsToPrint () const


virtual void	SetSortByObjectSize (bool _arg)

virtual bool	GetSortByObjectSize () const

virtual void	SortByObjectSizeOn ()


ObjectSizeType	GetSizeOfObjectInPixels (LabelType obj) const


float	GetSizeOfObjectInPhysicalUnits (LabelType obj) const

Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	CanRunInPlace () const

const char *	GetNameOfClass () const override

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

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 Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

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 Member Functions
void	GenerateData () override

void	GenerateInputRequestedRegion () override

void	ParallelComputeLabels (const RegionType &inputRegionForThread)

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

	RelabelComponentImageFilter ()

	~RelabelComponentImageFilter () override=default

Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()=default

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

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

void	AllocateOutputs () override

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

Private Types
using	MapType = std::map< LabelType, RelabelComponentObjectType >

Private Attributes
ObjectSizeType	m_MinimumObjectSize { 0 }

std::mutex	m_Mutex {}

SizeValueType	m_NumberOfObjects { 0 }

SizeValueType	m_NumberOfObjectsToPrint { 10 }

SizeValueType	m_OriginalNumberOfObjects { 0 }

MapType	m_SizeMap {}

ObjectSizeInPhysicalUnitsContainerType	m_SizeOfObjectsInPhysicalUnits {}

ObjectSizeInPixelsContainerType	m_SizeOfObjectsInPixels {}

bool	m_SortByObjectSize { true }

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

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

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)

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

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >

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

Definition at line 121 of file itkRelabelComponentImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage >

using itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::IndexType = typename TInputImage::IndexType

Definition at line 113 of file itkRelabelComponentImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >

using itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Image type alias support

Definition at line 111 of file itkRelabelComponentImageFilter.h.

◆ InputInternalPixelType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 104 of file itkRelabelComponentImageFilter.h.

◆ InputPixelType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 103 of file itkRelabelComponentImageFilter.h.

◆ LabelType

template<typename TInputImage , typename TOutputImage >

using itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::LabelType = InputPixelType

Type used as identifier for the different component labels.

Definition at line 134 of file itkRelabelComponentImageFilter.h.

◆ MapType

template<typename TInputImage , typename TOutputImage >

using itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::MapType = std::map<LabelType, RelabelComponentObjectType>

private

Definition at line 295 of file itkRelabelComponentImageFilter.h.

◆ ObjectSizeInPhysicalUnitsContainerType

template<typename TInputImage , typename TOutputImage >

using itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::ObjectSizeInPhysicalUnitsContainerType = std::vector<float>

Definition at line 144 of file itkRelabelComponentImageFilter.h.

◆ ObjectSizeInPixelsContainerType

template<typename TInputImage , typename TOutputImage >

using itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::ObjectSizeInPixelsContainerType = std::vector<ObjectSizeType>

Definition at line 143 of file itkRelabelComponentImageFilter.h.

◆ ObjectSizeType

template<typename TInputImage , typename TOutputImage >

using itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::ObjectSizeType = SizeValueType

Type used to count number of pixels in objects.

Definition at line 137 of file itkRelabelComponentImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >

using itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 112 of file itkRelabelComponentImageFilter.h.

◆ OutputInternalPixelType

template<typename TInputImage , typename TOutputImage >

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

Definition at line 102 of file itkRelabelComponentImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TOutputImage >

using itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::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 101 of file itkRelabelComponentImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >

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

Smart pointer type alias support

Definition at line 120 of file itkRelabelComponentImageFilter.h.

◆ RegionType

template<typename TInputImage , typename TOutputImage >

using itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::RegionType = typename TOutputImage::RegionType

Definition at line 115 of file itkRelabelComponentImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >

using itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::Self = RelabelComponentImageFilter

Standard "Self" & Superclass typedef.

Definition at line 89 of file itkRelabelComponentImageFilter.h.

◆ SizeType

template<typename TInputImage , typename TOutputImage >

using itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::SizeType = typename TInputImage::SizeType

Definition at line 114 of file itkRelabelComponentImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >

using itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::Superclass = InPlaceImageFilter<TInputImage, TOutputImage>

Definition at line 90 of file itkRelabelComponentImageFilter.h.

Constructor & Destructor Documentation

◆ RelabelComponentImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::RelabelComponentImageFilter ( )

protected

◆ ~RelabelComponentImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::~RelabelComponentImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GenerateData ( )

overrideprotectedvirtual

Standard pipeline method.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage >

void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

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

See also: ProcessObject::GenerateInputRequestedRegion().

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

◆ GetMinimumObjectSize()

template<typename TInputImage , typename TOutputImage >

virtual ObjectSizeType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetMinimumObjectSize ( ) const

virtual

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

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >

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

overridevirtual

Run-time type information (and related methods)

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

◆ GetNumberOfObjects()

template<typename TInputImage , typename TOutputImage >

virtual SizeValueType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetNumberOfObjects ( ) const

virtual

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

◆ GetNumberOfObjectsToPrint()

template<typename TInputImage , typename TOutputImage >

virtual const SizeValueType & itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetNumberOfObjectsToPrint ( ) const

virtual

Get/Set the number of objects enumerated and described when the filter is printed.

◆ GetOriginalNumberOfObjects()

template<typename TInputImage , typename TOutputImage >

virtual SizeValueType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetOriginalNumberOfObjects ( ) const

virtual

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

◆ GetSizeOfObjectInPhysicalUnits()

template<typename TInputImage , typename TOutputImage >

float itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetSizeOfObjectInPhysicalUnits ( LabelType obj ) const

inline

Get the size of a particular object in physical space (in units of pixel size). This information is only valid after the filter has executed. Size of the background (object #0) is not calculated.

Definition at line 228 of file itkRelabelComponentImageFilter.h.

◆ GetSizeOfObjectInPixels()

template<typename TInputImage , typename TOutputImage >

ObjectSizeType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetSizeOfObjectInPixels ( LabelType obj ) const

inline

Get the size of a particular object in pixels. This information is only valid after the filter has executed. Size of the background (object #0) is not calculated.

Definition at line 211 of file itkRelabelComponentImageFilter.h.

◆ GetSizeOfObjectsInPhysicalUnits()

template<typename TInputImage , typename TOutputImage >

const ObjectSizeInPhysicalUnitsContainerType & itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetSizeOfObjectsInPhysicalUnits ( ) const

inline

Get the size of each object in physical space (in units of pixel size). This information is only valid after the filter has executed. Size of the background is not calculated. Size of object #1 is GetSizeOfObjectsInPhysicalUnits()[0]. Size of object #2 is GetSizeOfObjectsInPhysicalUnits()[1]. Etc.

Definition at line 200 of file itkRelabelComponentImageFilter.h.

◆ GetSizeOfObjectsInPixels()

template<typename TInputImage , typename TOutputImage >

const ObjectSizeInPixelsContainerType & itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetSizeOfObjectsInPixels ( ) const

inline

Get the size of each object in pixels. This information is only valid after the filter has executed. Size of the background is not calculated. Size of object #1 is GetSizeOfObjectsInPixels()[0]. Size of object #2 is GetSizeOfObjectsInPixels()[1]. Etc.

Definition at line 187 of file itkRelabelComponentImageFilter.h.

◆ GetSortByObjectSize()

template<typename TInputImage , typename TOutputImage >

virtual bool itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::GetSortByObjectSize ( ) const

virtual

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

◆ New()

template<typename TInputImage , typename TOutputImage >

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

static

Method for creation through the object factory.

◆ ParallelComputeLabels()

template<typename TInputImage , typename TOutputImage >

void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::ParallelComputeLabels ( const RegionType & inputRegionForThread )

protected

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >

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

overrideprotectedvirtual

Standard printself method

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

◆ SetMinimumObjectSize()

template<typename TInputImage , typename TOutputImage >

virtual void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::SetMinimumObjectSize ( ObjectSizeType _arg )

virtual

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

◆ SetNumberOfObjectsToPrint()

template<typename TInputImage , typename TOutputImage >

virtual void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::SetNumberOfObjectsToPrint ( SizeValueType _arg )

virtual

Get/Set the number of objects enumerated and described when the filter is printed.

◆ SetSortByObjectSize()

template<typename TInputImage , typename TOutputImage >

virtual void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::SetSortByObjectSize ( bool _arg )

virtual

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

◆ SortByObjectSizeOn()

template<typename TInputImage , typename TOutputImage >

virtual void itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::SortByObjectSizeOn ( )

virtual

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

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage >

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

staticconstexpr

Definition at line 105 of file itkRelabelComponentImageFilter.h.

◆ InputImageDimension

template<typename TInputImage , typename TOutputImage >

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

staticconstexpr

Definition at line 106 of file itkRelabelComponentImageFilter.h.

◆ m_MinimumObjectSize

template<typename TInputImage , typename TOutputImage >

ObjectSizeType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_MinimumObjectSize { 0 }

private

Definition at line 290 of file itkRelabelComponentImageFilter.h.

◆ m_Mutex

template<typename TInputImage , typename TOutputImage >

std::mutex itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_Mutex {}

private

Definition at line 293 of file itkRelabelComponentImageFilter.h.

◆ m_NumberOfObjects

template<typename TInputImage , typename TOutputImage >

SizeValueType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_NumberOfObjects { 0 }

private

Definition at line 287 of file itkRelabelComponentImageFilter.h.

◆ m_NumberOfObjectsToPrint

template<typename TInputImage , typename TOutputImage >

SizeValueType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_NumberOfObjectsToPrint { 10 }

private

Definition at line 288 of file itkRelabelComponentImageFilter.h.

◆ m_OriginalNumberOfObjects

template<typename TInputImage , typename TOutputImage >

SizeValueType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_OriginalNumberOfObjects { 0 }

private

Definition at line 289 of file itkRelabelComponentImageFilter.h.

◆ m_SizeMap

template<typename TInputImage , typename TOutputImage >

MapType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_SizeMap {}

private

Definition at line 296 of file itkRelabelComponentImageFilter.h.

◆ m_SizeOfObjectsInPhysicalUnits

template<typename TInputImage , typename TOutputImage >

ObjectSizeInPhysicalUnitsContainerType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_SizeOfObjectsInPhysicalUnits {}

private

Definition at line 299 of file itkRelabelComponentImageFilter.h.

◆ m_SizeOfObjectsInPixels

template<typename TInputImage , typename TOutputImage >

ObjectSizeInPixelsContainerType itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_SizeOfObjectsInPixels {}

private

Definition at line 298 of file itkRelabelComponentImageFilter.h.

◆ m_SortByObjectSize

template<typename TInputImage , typename TOutputImage >

bool itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::m_SortByObjectSize { true }

private

Definition at line 291 of file itkRelabelComponentImageFilter.h.

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

itkRelabelComponentImageFilter.h

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ IndexType

◆ InputImageType

◆ InputInternalPixelType

◆ InputPixelType

◆ LabelType

◆ MapType

◆ ObjectSizeInPhysicalUnitsContainerType

◆ ObjectSizeInPixelsContainerType

◆ ObjectSizeType

◆ OutputImageType

◆ OutputInternalPixelType

◆ OutputPixelType

◆ Pointer

◆ RegionType

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ RelabelComponentImageFilter()

◆ ~RelabelComponentImageFilter()

Member Function Documentation

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GetMinimumObjectSize()

◆ GetNameOfClass()

◆ GetNumberOfObjects()

◆ GetNumberOfObjectsToPrint()

◆ GetOriginalNumberOfObjects()

◆ GetSizeOfObjectInPhysicalUnits()

◆ GetSizeOfObjectInPixels()

◆ GetSizeOfObjectsInPhysicalUnits()

◆ GetSizeOfObjectsInPixels()

◆ GetSortByObjectSize()

◆ New()

◆ ParallelComputeLabels()

◆ PrintSelf()

◆ SetMinimumObjectSize()

◆ SetNumberOfObjectsToPrint()

◆ SetSortByObjectSize()

◆ SortByObjectSizeOn()

Member Data Documentation

◆ ImageDimension

◆ InputImageDimension

◆ m_MinimumObjectSize

◆ m_Mutex

◆ m_NumberOfObjects

◆ m_NumberOfObjectsToPrint

◆ m_OriginalNumberOfObjects

◆ m_SizeMap

◆ m_SizeOfObjectsInPhysicalUnits

◆ m_SizeOfObjectsInPixels

◆ m_SortByObjectSize