#include <itkInPlaceLabelMapFilter.h>

Detailed Description

template<typename TInputImage>
class itk::InPlaceLabelMapFilter< TInputImage >

Base class for filters that takes an image as input and overwrites that image as the output.

InPlaceLabelMapFilter is the base class for all process objects whose output image data is constructed by overwriting the input image data. In other words, the output bulk data is the same block of memory as the input bulk data. This filter provides the mechanisms for in place image processing while maintaining general pipeline mechanics. InPlaceLabelMapFilters use less memory than standard ImageToImageFilters because the input buffer is reused as the output buffer. However, this benefit does not come without a cost. Since the filter overwrites its input, the ownership of the bulk data is transitioned from the input data object to the output data object. When a data object has multiple consumers with one of the consumers being an in place filter, the in place filter effectively destroys the bulk data for the data object. Upstream filters will then have to re-execute to regenerate the data object's bulk data for the remaining consumers.

Since an InPlaceLabelMapFilter reuses the input bulk data memory for the output bulk data memory, the input image type must match the output image type. If the input and output image types are not identical, the filter reverts to a traditional ImageToImageFilter behaviour where an output image is allocated. In place operation can also be controlled (when the input and output image type match) via the methods InPlaceOn() and InPlaceOff().

Subclasses of InPlaceLabelMapFilter must take extra care in how they manage memory using (and perhaps overriding) the implementations of ReleaseInputs() and AllocateOutputs() provided here.

This code was contributed in the Insight Journal paper: "Label object representation and manipulation with ITK" by Lehmann G. https://doi.org/10.54294/q6auw4

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

See also: LabelMapToBinaryImageFilter, LabelMapToLabelImageFilter

Definition at line 83 of file itkInPlaceLabelMapFilter.h.

Inheritance diagram for itk::InPlaceLabelMapFilter< TInputImage >:

Collaboration diagram for itk::InPlaceLabelMapFilter< TInputImage >:

Public Types
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 = TInputImage

using	LabelObjectType = typename InputImageType::LabelObjectType

using	OutputImagePixelType

using	OutputImagePointer

using	OutputImageRegionType

using	OutputImageType

using	PixelType = typename InputImageType::PixelType

using	Pointer = SmartPointer<Self>

using	RegionType = typename InputImageType::RegionType

using	Self = InPlaceLabelMapFilter

using	Superclass = LabelMapFilter<TInputImage, TInputImage>

using	TOutputImage = TInputImage

Public Types inherited from itk::LabelMapFilter< TInputImage, TInputImage >
using	ConstPointer

using	ConstPointer

typedef typename InputImageType::ConstPointer	InputImageConstPointer

using	InputImageConstPointer

typedef typename InputImageType::PixelType	InputImagePixelType

using	InputImagePixelType

typedef typename InputImageType::Pointer	InputImagePointer

using	InputImagePointer

typedef typename InputImageType::RegionType	InputImageRegionType

using	InputImageRegionType

typedef TInputImage	InputImageType

using	InputImageType

using	LabelObjectType

using	LabelObjectType

using	OutputImageConstPointer

using	OutputImageConstPointer

using	OutputImagePixelType

using	OutputImagePixelType

using	OutputImagePointer

using	OutputImagePointer

using	OutputImageRegionType

using	OutputImageRegionType

using	OutputImageType

using	OutputImageType

using	Pointer

using	Pointer

using	Self

using	Self

using	Superclass

using	Superclass

Public Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
using	ConstPointer

using	InputImageConstPointer

using	InputImagePixelType

using	InputImagePointer

using	InputImageRegionType

using	InputImageType

typedef typename OutputImageType::PixelType	OutputImagePixelType

using	OutputImagePixelType

typedef typename OutputImageType::RegionType	OutputImageRegionType

using	OutputImageRegionType

using	Pointer

using	Self

using	Superclass

Public Types inherited from itk::ImageSource< TInputImage >
using	ConstPointer

using	DataObjectIdentifierType

using	DataObjectPointer

using	DataObjectPointerArraySizeType

using	OutputImagePixelType

using	OutputImagePointer

using	OutputImageRegionType

using	OutputImageType

using	Pointer

using	Self

using	Superclass

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
bool	CanRunInPlace () const

virtual::itk::LightObject::Pointer	CreateAnother () const

const char *	GetNameOfClass () const override


virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace ()

virtual void	InPlaceOn ()

virtual void	InPlaceOff ()

Public Member Functions inherited from itk::LabelMapFilter< TInputImage, TInputImage >
virtual::itk::LightObject::Pointer	CreateAnother () const

virtual::itk::LightObject::Pointer	CreateAnother () const

void	EnlargeOutputRequestedRegion (DataObject *output) override

void	EnlargeOutputRequestedRegion (DataObject *output) override

void	GenerateInputRequestedRegion () override

void	GenerateInputRequestedRegion () override

const char *	GetNameOfClass () const override

const char *	GetNameOfClass () const override

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

const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopBackInput () override

void	PopFrontInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (const InputImageType *input)

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

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

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TInputImage >
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	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

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

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

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 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::LabelMapFilter< TInputImage, TInputImage >
static Pointer	New ()

static Pointer	New ()

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

static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (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	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

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

static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

static constexpr unsigned int	OutputImageDimension

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

static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

static constexpr unsigned int	OutputImageDimension

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

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

void	AfterThreadedGenerateData () override

void	BeforeThreadedGenerateData () override

void	BeforeThreadedGenerateData () override

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

	LabelMapFilter ()

	LabelMapFilter ()

void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType) override

void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType) override

virtual void	ThreadedProcessLabelObject (LabelObjectType *labelObject)

virtual void	ThreadedProcessLabelObject (LabelObjectType *labelObject)

	~LabelMapFilter () override=default

	~LabelMapFilter () override=default

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

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

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

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

	ImageToImageFilter ()

	ImageToImageFilter ()

void	VerifyInputInformation () const override

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

	~ImageToImageFilter () override=default

Protected Member Functions inherited from itk::ImageSource< TInputImage >
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 ()

virtual void	DynamicMultiThreadingOff ()

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

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

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

Private Attributes
bool	m_InPlace { true }

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
using	InputToOutputRegionCopierType

using	OutputToInputRegionCopierType

Static Protected Member Functions inherited from itk::ImageSource< TInputImage >
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::LabelMapFilter< TInputImage, TInputImage >
std::mutex	m_LabelObjectContainerLock

std::mutex	m_LabelObjectContainerLock

Protected Attributes inherited from itk::ImageSource< TInputImage >
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 {}

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage>

using itk::InPlaceLabelMapFilter< TInputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 92 of file itkInPlaceLabelMapFilter.h.

◆ IndexType

template<typename TInputImage>

using itk::InPlaceLabelMapFilter< TInputImage >::IndexType = typename InputImageType::IndexType

Definition at line 115 of file itkInPlaceLabelMapFilter.h.

◆ InputImageConstPointer

template<typename TInputImage>

using itk::InPlaceLabelMapFilter< TInputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 109 of file itkInPlaceLabelMapFilter.h.

◆ InputImagePixelType

template<typename TInputImage>

using itk::InPlaceLabelMapFilter< TInputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 111 of file itkInPlaceLabelMapFilter.h.

◆ InputImagePointer

template<typename TInputImage>

using itk::InPlaceLabelMapFilter< TInputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 108 of file itkInPlaceLabelMapFilter.h.

◆ InputImageRegionType

template<typename TInputImage>

using itk::InPlaceLabelMapFilter< TInputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 110 of file itkInPlaceLabelMapFilter.h.

◆ InputImageType

template<typename TInputImage>

using itk::InPlaceLabelMapFilter< TInputImage >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 107 of file itkInPlaceLabelMapFilter.h.

◆ LabelObjectType

template<typename TInputImage>

using itk::InPlaceLabelMapFilter< TInputImage >::LabelObjectType = typename InputImageType::LabelObjectType

Definition at line 112 of file itkInPlaceLabelMapFilter.h.

◆ OutputImagePixelType

template<typename TInputImage>

using itk::LabelMapFilter< TInputImage, TInputImage >::OutputImagePixelType

Definition at line 86 of file itkLabelMapFilter.h.

◆ OutputImagePointer

template<typename TInputImage>

using itk::LabelMapFilter< TInputImage, TInputImage >::OutputImagePointer

Definition at line 83 of file itkLabelMapFilter.h.

◆ OutputImageRegionType

template<typename TInputImage>

using itk::LabelMapFilter< TInputImage, TInputImage >::OutputImageRegionType

Definition at line 85 of file itkLabelMapFilter.h.

◆ OutputImageType

template<typename TInputImage>

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

Definition at line 82 of file itkLabelMapFilter.h.

◆ PixelType

template<typename TInputImage>

using itk::InPlaceLabelMapFilter< TInputImage >::PixelType = typename InputImageType::PixelType

Definition at line 114 of file itkInPlaceLabelMapFilter.h.

◆ Pointer

template<typename TInputImage>

using itk::InPlaceLabelMapFilter< TInputImage >::Pointer = SmartPointer<Self>

Definition at line 91 of file itkInPlaceLabelMapFilter.h.

◆ RegionType

template<typename TInputImage>

using itk::InPlaceLabelMapFilter< TInputImage >::RegionType = typename InputImageType::RegionType

Definition at line 116 of file itkInPlaceLabelMapFilter.h.

◆ Self

template<typename TInputImage>

using itk::InPlaceLabelMapFilter< TInputImage >::Self = InPlaceLabelMapFilter

Standard class type aliases.

Definition at line 89 of file itkInPlaceLabelMapFilter.h.

◆ Superclass

template<typename TInputImage>

using itk::InPlaceLabelMapFilter< TInputImage >::Superclass = LabelMapFilter<TInputImage, TInputImage>

Definition at line 90 of file itkInPlaceLabelMapFilter.h.

◆ TOutputImage

template<typename TInputImage>

using itk::InPlaceLabelMapFilter< TInputImage >::TOutputImage = TInputImage

Definition at line 118 of file itkInPlaceLabelMapFilter.h.

Constructor & Destructor Documentation

◆ InPlaceLabelMapFilter()

template<typename TInputImage>

itk::InPlaceLabelMapFilter< TInputImage >::InPlaceLabelMapFilter ( )

protecteddefault

◆ ~InPlaceLabelMapFilter()

template<typename TInputImage>

itk::InPlaceLabelMapFilter< TInputImage >::~InPlaceLabelMapFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ AllocateOutputs()

template<typename TInputImage>

void itk::InPlaceLabelMapFilter< TInputImage >::AllocateOutputs ( )

overrideprotectedvirtual

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Since InPlaceLabelMapFilter's can use an overwritten version of the input for its output, the output buffer should not be allocated. When possible, we graft the input to the filter to the output. If an InPlaceFilter has multiple outputs, then it would need to override this method to graft one of its outputs and allocate the remaining. If a filter is threaded (i.e. it provides an implementation of ThreadedGenerateData()), this method is called automatically. If an InPlaceFilter is not threaded (i.e. it provides an implementation of GenerateData()), then this method (or equivalent) must be called in GenerateData().

Reimplemented from itk::ImageSource< TInputImage >.

Referenced by itk::ShapeKeepNObjectsLabelMapFilter< LabelMapType >::TemplatedGenerateData(), itk::ShapeOpeningLabelMapFilter< LabelMapType >::TemplatedGenerateData(), and itk::ShapeRelabelLabelMapFilter< LabelMapType >::TemplatedGenerateData().

◆ CanRunInPlace()

template<typename TInputImage>

bool itk::InPlaceLabelMapFilter< TInputImage >::CanRunInPlace ( ) const

inline

Can the filter run in place? To do so, the filter's first input and output must have the same dimension and pixel type. This method can be used in conjunction with the InPlace ivar to determine whether a particular use of the filter is really running in place. Some filters may be able to optimize their operation if the InPlace is true and CanRunInPlace is true.

Definition at line 138 of file itkInPlaceLabelMapFilter.h.

◆ CreateAnother()

template<typename TInputImage>

virtual::itk::LightObject::Pointer itk::InPlaceLabelMapFilter< TInputImage >::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::LightObject.

◆ GetInPlace()

template<typename TInputImage>

virtual bool itk::InPlaceLabelMapFilter< TInputImage >::GetInPlace ( )

virtual

In place operation can be turned on and off. This only has an effect when the input and output image type match.

◆ GetLabelMap()

template<typename TInputImage>

InputImageType * itk::InPlaceLabelMapFilter< TInputImage >::GetLabelMap ( )

inlineoverrideprotectedvirtual

Return the output label collection image, instead of the input as in the default implementation

Reimplemented from itk::LabelMapFilter< TInputImage, TInputImage >.

Definition at line 174 of file itkInPlaceLabelMapFilter.h.

◆ GetNameOfClass()

template<typename TInputImage>

const char * itk::InPlaceLabelMapFilter< TInputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

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

◆ InPlaceOff()

template<typename TInputImage>

virtual void itk::InPlaceLabelMapFilter< TInputImage >::InPlaceOff ( )

virtual

In place operation can be turned on and off. This only has an effect when the input and output image type match.

◆ InPlaceOn()

template<typename TInputImage>

virtual void itk::InPlaceLabelMapFilter< TInputImage >::InPlaceOn ( )

virtual

In place operation can be turned on and off. This only has an effect when the input and output image type match.

◆ New()

template<typename TInputImage>

static Pointer itk::InPlaceLabelMapFilter< TInputImage >::New ( )

static

Standard New method.

◆ PrintSelf()

template<typename TInputImage>

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

overrideprotectedvirtual

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

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

◆ SetInPlace()

template<typename TInputImage>

virtual void itk::InPlaceLabelMapFilter< TInputImage >::SetInPlace ( bool _arg )

virtual

In place operation can be turned on and off. This only has an effect when the input and output image type match.

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage>

unsigned int itk::InPlaceLabelMapFilter< TInputImage >::InputImageDimension = TInputImage::ImageDimension

staticconstexpr

ImageDimension constants

Definition at line 121 of file itkInPlaceLabelMapFilter.h.

◆ m_InPlace

template<typename TInputImage>

bool itk::InPlaceLabelMapFilter< TInputImage >::m_InPlace { true }

private

Definition at line 180 of file itkInPlaceLabelMapFilter.h.

◆ OutputImageDimension

template<typename TInputImage>

unsigned int itk::InPlaceLabelMapFilter< TInputImage >::OutputImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 122 of file itkInPlaceLabelMapFilter.h.

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

itkInPlaceLabelMapFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ IndexType

◆ InputImageConstPointer

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageRegionType

◆ InputImageType

◆ LabelObjectType

◆ OutputImagePixelType

◆ OutputImagePointer

◆ OutputImageRegionType

◆ OutputImageType

◆ PixelType

◆ Pointer

◆ RegionType

◆ Self

◆ Superclass

◆ TOutputImage

Constructor & Destructor Documentation

◆ InPlaceLabelMapFilter()

◆ ~InPlaceLabelMapFilter()

Member Function Documentation

◆ AllocateOutputs()

◆ CanRunInPlace()

◆ CreateAnother()

◆ GetInPlace()

◆ GetLabelMap()

◆ GetNameOfClass()

◆ InPlaceOff()

◆ InPlaceOn()

◆ New()

◆ PrintSelf()

◆ SetInPlace()

Member Data Documentation

◆ InputImageDimension

◆ m_InPlace

◆ OutputImageDimension