#include <itkLabelMapFilter.h>

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename Superclass::InputImageConstPointer

using	InputImagePixelType = typename Superclass::InputImagePixelType

using	InputImagePointer = typename Superclass::InputImagePointer

using	InputImageRegionType = typename Superclass::InputImageRegionType

using	InputImageType = typename Superclass::InputImageType

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

using	Pointer = SmartPointer< Self >

using	Self = LabelMapFilter

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	OutputImagePixelType = typename Superclass::OutputImagePixelType

using	OutputImageRegionType = typename Superclass::OutputImageRegionType

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 ::itk::LightObject::Pointer	CreateAnother () const

void	EnlargeOutputRequestedRegion (DataObject *) override

void	GenerateInputRequestedRegion () override

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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 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 >
OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

OutputImageType *	GetOutput (unsigned int idx)

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

virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

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	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

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

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

MultiThreaderType *	GetMultiThreader () const

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	PrepareOutputs ()

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

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

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

Static Public Member Functions
static Pointer	New ()

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

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static double	GetGlobalDefaultCoordinateTolerance ()

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

void	BeforeThreadedGenerateData () override

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

virtual InputImageType *	GetLabelMap ()

	LabelMapFilter ()

void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType) override

virtual void	ThreadedProcessLabelObject (LabelObjectType *labelObject)

	~LabelMapFilter () override=default

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
	ImageToImageFilter ()

	~ImageToImageFilter () override=default

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

void	VerifyInputInformation () ITKv5_CONST override

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

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

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

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

	~ImageSource () override=default

void	GenerateData () override

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual void	AllocateOutputs ()

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

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

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

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

	~ProcessObject () override

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

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

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

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	AddInput (DataObject *input)

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

virtual void	SetPrimaryInput (DataObject *object)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

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

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

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetPrimaryOutput (DataObject *object)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

virtual void	AddOutput (DataObject *output)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

virtual void	VerifyPreconditions () ITKv5_CONST

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual void	GenerateOutputInformation ()

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	CacheInputReleaseDataFlags ()

virtual void	RestoreInputReleaseDataFlags ()

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

	~Object () override

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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

Protected Attributes
std::mutex	m_LabelObjectContainerLock

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

Protected Attributes inherited from itk::ProcessObject
bool	m_Updating

TimeStamp	m_OutputInformationMTime

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

Private Attributes
InputImageType::Iterator	m_LabelObjectIterator

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
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Detailed Description

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

Base class for filters that take an image as input and overwrite that image as the output.

LabelMapFilter is the base class for all process objects whose are using a LabelMapFilter as input. It manage several threads, and run a method ThreadedGenerateData() for each object in the LabelMapFilter. With that class, the developer doesn't need to take care of iterating over all the objects in the image, or to manage by hand the threads.

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

This implementation was taken from the Insight Journal paper: https://www.insight-journal.org/browse/publication/176

See also: LabelMapToBinaryImageFilter, LabelMapToLabelImageFilter

Definition at line 57 of file itkLabelMapFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage, typename TOutputImage>

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

Definition at line 66 of file itkLabelMapFilter.h.

◆ InputImageConstPointer

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename Superclass::InputImageConstPointer

Definition at line 77 of file itkLabelMapFilter.h.

◆ InputImagePixelType

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapFilter< TInputImage, TOutputImage >::InputImagePixelType = typename Superclass::InputImagePixelType

Definition at line 79 of file itkLabelMapFilter.h.

◆ InputImagePointer

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapFilter< TInputImage, TOutputImage >::InputImagePointer = typename Superclass::InputImagePointer

Definition at line 76 of file itkLabelMapFilter.h.

◆ InputImageRegionType

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapFilter< TInputImage, TOutputImage >::InputImageRegionType = typename Superclass::InputImageRegionType

Definition at line 78 of file itkLabelMapFilter.h.

◆ InputImageType

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapFilter< TInputImage, TOutputImage >::InputImageType = typename Superclass::InputImageType

Some convenient type alias.

Definition at line 75 of file itkLabelMapFilter.h.

◆ LabelObjectType

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapFilter< TInputImage, TOutputImage >::LabelObjectType = typename InputImageType::LabelObjectType

Definition at line 80 of file itkLabelMapFilter.h.

◆ OutputImageConstPointer

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapFilter< TInputImage, TOutputImage >::OutputImageConstPointer = typename OutputImageType::ConstPointer

Definition at line 84 of file itkLabelMapFilter.h.

◆ OutputImagePixelType

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapFilter< TInputImage, TOutputImage >::OutputImagePixelType = typename OutputImageType::PixelType

Definition at line 86 of file itkLabelMapFilter.h.

◆ OutputImagePointer

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 83 of file itkLabelMapFilter.h.

◆ OutputImageRegionType

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 85 of file itkLabelMapFilter.h.

◆ OutputImageType

template<typename TInputImage, typename TOutputImage>

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

Definition at line 82 of file itkLabelMapFilter.h.

◆ Pointer

template<typename TInputImage, typename TOutputImage>

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

Definition at line 65 of file itkLabelMapFilter.h.

◆ Self

template<typename TInputImage, typename TOutputImage>

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

Standard class type aliases.

Definition at line 63 of file itkLabelMapFilter.h.

◆ Superclass

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 64 of file itkLabelMapFilter.h.

Constructor & Destructor Documentation

◆ LabelMapFilter()

template<typename TInputImage, typename TOutputImage>

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

protected

◆ ~LabelMapFilter()

template<typename TInputImage, typename TOutputImage>

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

overrideprotecteddefault

Member Function Documentation

◆ AfterThreadedGenerateData()

template<typename TInputImage, typename TOutputImage>

void itk::LabelMapFilter< TInputImage, TOutputImage >::AfterThreadedGenerateData ( )

overrideprotectedvirtual

If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::ShapeLabelMapFilter< TImage, Image< TImage::PixelType, TImage::ImageDimension > >.

◆ BeforeThreadedGenerateData()

template<typename TInputImage, typename TOutputImage>

void itk::LabelMapFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )

overrideprotectedvirtual

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::ShapeLabelMapFilter< TImage, Image< TImage::PixelType, TImage::ImageDimension > >, itk::LabelMapToRGBImageFilter< TInputImage, TOutputImage >, and itk::LabelMapToLabelImageFilter< TInputImage, TOutputImage >.

◆ CreateAnother()

template<typename TInputImage, typename TOutputImage>

virtual::itk::LightObject::Pointer itk::LabelMapFilter< TInputImage, TOutputImage >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

Reimplemented in itk::ObjectByObjectLabelMapFilter< TInputImage, TOutputImage, TInputFilter, TOutputFilter, TInternalInputImage, TInternalOutputImage >, itk::ShapeLabelMapFilter< TImage, Image< TImage::PixelType, TImage::ImageDimension > >, itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >, itk::LabelMapToRGBImageFilter< TInputImage, TOutputImage >, itk::LabelMapToLabelImageFilter< TInputImage, TOutputImage >, and itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >.

◆ DynamicThreadedGenerateData()

template<typename TInputImage, typename TOutputImage>

void itk::LabelMapFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType & outputRegionForThread )

overrideprotectedvirtual

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

anotherFilter->SetInput( someFilter->GetOutput() );

anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

image = someFilter->GetOutput();

image->Update();

someFilter->Update();

image = someFilter->GetOutput();

(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >, and itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >.

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage, typename TOutputImage>

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

overridevirtual

LabelMapFilter will produce the entire output.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >, and itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage, typename TOutputImage>

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

overridevirtual

LabelMapFilter requires the entire input to be available. Thus, it needs to provide an implementation of GenerateInputRequestedRegion().

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

Reimplemented in itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >, and itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >.

◆ GetLabelMap()

template<typename TInputImage, typename TOutputImage>

virtual InputImageType* itk::LabelMapFilter< TInputImage, TOutputImage >::GetLabelMap ( )

inlineprotectedvirtual

Return the label collection image to use. This method may be overloaded if the label collection image to use is not the input image.

Reimplemented in itk::LabelMapContourOverlayImageFilter< TLabelMap, TFeatureImage, TOutputImage >, itk::InPlaceLabelMapFilter< TInputImage >, and itk::InPlaceLabelMapFilter< TImage >.

Definition at line 130 of file itkLabelMapFilter.h.

◆ GetNameOfClass()

template<typename TInputImage, typename TOutputImage>

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

virtual

Run-time type information (and related methods).

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

◆ New()

template<typename TInputImage, typename TOutputImage>

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

static

Standard New method.

◆ ThreadedGenerateData()

template<typename TInputImage, typename TOutputImage>

void itk::LabelMapFilter< TInputImage, TOutputImage >::ThreadedGenerateData	(	const OutputImageRegionType &	region,
		ThreadIdType	threadId
	)

inlineoverrideprotectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.

See also: GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 117 of file itkLabelMapFilter.h.

◆ ThreadedProcessLabelObject()

template<typename TInputImage, typename TOutputImage>

virtual void itk::LabelMapFilter< TInputImage, TOutputImage >::ThreadedProcessLabelObject ( LabelObjectType * labelObject )

protectedvirtual

Reimplemented in itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >, itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >, itk::ShapeLabelMapFilter< TImage, Image< TImage::PixelType, TImage::ImageDimension > >, itk::LabelMapToRGBImageFilter< TInputImage, TOutputImage >, itk::ChangeRegionLabelMapFilter< TInputImage >, and itk::LabelMapToLabelImageFilter< TInputImage, TOutputImage >.

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage, typename TOutputImage>

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

staticconstexpr

ImageDimension constants

Definition at line 89 of file itkLabelMapFilter.h.

◆ m_LabelObjectContainerLock

template<typename TInputImage, typename TOutputImage>

std::mutex itk::LabelMapFilter< TInputImage, TOutputImage >::m_LabelObjectContainerLock

protected

Definition at line 135 of file itkLabelMapFilter.h.

◆ m_LabelObjectIterator

template<typename TInputImage, typename TOutputImage>

InputImageType::Iterator itk::LabelMapFilter< TInputImage, TOutputImage >::m_LabelObjectIterator

private

Definition at line 138 of file itkLabelMapFilter.h.

◆ OutputImageDimension

template<typename TInputImage, typename TOutputImage>

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

staticconstexpr

Definition at line 90 of file itkLabelMapFilter.h.

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

itkLabelMapFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ InputImageConstPointer

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageRegionType

◆ InputImageType

◆ LabelObjectType

◆ OutputImageConstPointer

◆ OutputImagePixelType

◆ OutputImagePointer

◆ OutputImageRegionType

◆ OutputImageType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ LabelMapFilter()

◆ ~LabelMapFilter()

Member Function Documentation

◆ AfterThreadedGenerateData()

◆ BeforeThreadedGenerateData()

◆ CreateAnother()

◆ DynamicThreadedGenerateData()

◆ EnlargeOutputRequestedRegion()

◆ GenerateInputRequestedRegion()

◆ GetLabelMap()

◆ GetNameOfClass()

◆ New()

◆ ThreadedGenerateData()

◆ ThreadedProcessLabelObject()

Member Data Documentation

◆ InputImageDimension

◆ m_LabelObjectContainerLock

◆ m_LabelObjectIterator

◆ OutputImageDimension

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