#include <itkLabelMapMaskImageFilter.h>

Detailed Description

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

Mask and image with a LabelMap.

LabelMapMaskImageFilter mask the content of an input image according to the content of the input LabelMap. The masked pixel of the input image are set to the BackgroundValue. LabelMapMaskImageFilter can keep the input image for one label only, with Negated = false (the default) or it can mask the input image for a single label, when Negated equals true. In Both cases, the label is set with SetLabel().

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://doi.org/10.54294/q6auw4

See also: LabelMapToBinaryImageFilter, LabelMapToLabelImageFilter

Definition at line 47 of file itkLabelMapMaskImageFilter.h.

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

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

Public Types
using	ConstPointer = SmartPointer<const Self>

using	IndexType = typename OutputImageType::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	LabelType = typename LabelObjectType::LabelType

using	LengthType = typename LabelObjectType::LengthType

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	RegionType = typename OutputImageType::RegionType

using	Self = LabelMapMaskImageFilter

using	SizeType = typename OutputImageType::SizeType

using	Superclass = LabelMapFilter<TInputImage, TOutputImage>

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

using	InputImageConstPointer

using	InputImagePixelType

using	InputImagePointer

using	InputImageRegionType

using	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

using	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

const OutputImageType *	GetFeatureImage ()

const char *	GetNameOfClass () const override

void	SetFeatureImage (const TOutputImage *input)

void	SetInput1 (const TInputImage *input)

void	SetInput2 (const TOutputImage *input)


virtual void	SetBackgroundValue (OutputImagePixelType _arg)

virtual OutputImagePixelType	GetBackgroundValue () const


virtual void	SetLabel (InputImagePixelType _arg)

virtual InputImagePixelType	GetLabel () const


virtual void	SetNegated (bool _arg)

virtual const bool &	GetNegated () const

virtual void	NegatedOn ()

virtual void	NegatedOff ()


virtual void	SetCrop (bool _arg)

virtual const bool &	GetCrop () const

virtual void	CropOn ()

virtual void	CropOff ()


virtual void	SetCropBorder (SizeType _arg)

virtual const SizeType &	GetCropBorder () 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 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 (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, TOutputImage >
static Pointer	New ()

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

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

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

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

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

static Pointer	New ()

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

static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::LabelMapFilter< TInputImage, TOutputImage >
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	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override

void	EnlargeOutputRequestedRegion (DataObject *output) override

void	GenerateData () override

void	GenerateInputRequestedRegion () override

void	GenerateOutputInformation () override

	LabelMapMaskImageFilter ()

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

void	SuperclassDynamicTGD (const OutputImageRegionType &outputRegion)

void	ThreadedProcessLabelObject (LabelObjectType *labelObject) override

	~LabelMapMaskImageFilter () override=default

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

void	BeforeThreadedGenerateData () override

virtual InputImageType *	GetLabelMap ()

	LabelMapFilter ()

void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType) override

	~LabelMapFilter () override=default

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

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

	ImageToImageFilter ()

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

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

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

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

bool	m_Crop { false }

SizeType	m_CropBorder {}

TimeStamp	m_CropTimeStamp {}

InputImagePixelType	m_Label {}

bool	m_Negated { false }

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

using	OutputToInputRegionCopierType

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::LabelMapFilter< TInputImage, TOutputImage >
std::mutex	m_LabelObjectContainerLock {}

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::LabelMapMaskImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 56 of file itkLabelMapMaskImageFilter.h.

◆ IndexType

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::IndexType = typename OutputImageType::IndexType

Definition at line 73 of file itkLabelMapMaskImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 62 of file itkLabelMapMaskImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 64 of file itkLabelMapMaskImageFilter.h.

◆ InputImagePointer

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 61 of file itkLabelMapMaskImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 63 of file itkLabelMapMaskImageFilter.h.

◆ InputImageType

template<typename TInputImage, typename TOutputImage>

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

Some convenient type alias.

Definition at line 59 of file itkLabelMapMaskImageFilter.h.

◆ LabelObjectType

template<typename TInputImage, typename TOutputImage>

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

Definition at line 65 of file itkLabelMapMaskImageFilter.h.

◆ LabelType

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::LabelType = typename LabelObjectType::LabelType

Definition at line 66 of file itkLabelMapMaskImageFilter.h.

◆ LengthType

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::LengthType = typename LabelObjectType::LengthType

Definition at line 67 of file itkLabelMapMaskImageFilter.h.

◆ OutputImageConstPointer

template<typename TInputImage, typename TOutputImage>

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

Definition at line 70 of file itkLabelMapMaskImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage, typename TOutputImage>

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

Definition at line 72 of file itkLabelMapMaskImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage, typename TOutputImage>

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

Definition at line 69 of file itkLabelMapMaskImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage, typename TOutputImage>

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

Definition at line 71 of file itkLabelMapMaskImageFilter.h.

◆ OutputImageType

template<typename TInputImage, typename TOutputImage>

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

Definition at line 60 of file itkLabelMapMaskImageFilter.h.

◆ Pointer

template<typename TInputImage, typename TOutputImage>

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

Definition at line 55 of file itkLabelMapMaskImageFilter.h.

◆ RegionType

template<typename TInputImage, typename TOutputImage>

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

Definition at line 75 of file itkLabelMapMaskImageFilter.h.

◆ Self

template<typename TInputImage, typename TOutputImage>

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

Standard class type aliases.

Definition at line 53 of file itkLabelMapMaskImageFilter.h.

◆ SizeType

template<typename TInputImage, typename TOutputImage>

using itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SizeType = typename OutputImageType::SizeType

Definition at line 74 of file itkLabelMapMaskImageFilter.h.

◆ Superclass

template<typename TInputImage, typename TOutputImage>

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

Definition at line 54 of file itkLabelMapMaskImageFilter.h.

Constructor & Destructor Documentation

◆ LabelMapMaskImageFilter()

template<typename TInputImage, typename TOutputImage>

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

protected

◆ ~LabelMapMaskImageFilter()

template<typename TInputImage, typename TOutputImage>

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

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage, typename TOutputImage>

virtual::itk::LightObject::Pointer itk::LabelMapMaskImageFilter< 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::LabelMapFilter< TInputImage, TOutputImage >.

◆ CropOff()

template<typename TInputImage, typename TOutputImage>

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::CropOff ( )

virtual

Set/Get whether the image size should be adjusted to the masked image or not.

◆ CropOn()

template<typename TInputImage, typename TOutputImage>

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::CropOn ( )

virtual

Set/Get whether the image size should be adjusted to the masked image or not.

◆ DynamicThreadedGenerateData()

template<typename TInputImage, typename TOutputImage>

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

overrideprotectedvirtual

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::LabelMapFilter< TInputImage, TOutputImage >.

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage, typename TOutputImage>

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

overrideprotectedvirtual

LabelMapMaskImageFilter will produce the entire output.

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

◆ GenerateData()

template<typename TInputImage, typename TOutputImage>

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

overrideprotectedvirtual

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

See also: ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage, typename TOutputImage>

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

overrideprotectedvirtual

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

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

◆ GenerateOutputInformation()

template<typename TInputImage, typename TOutputImage>

void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( )

overrideprotectedvirtual

Generate the information describing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

◆ GetBackgroundValue()

template<typename TInputImage, typename TOutputImage>

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

virtual

Set/Get the value used as "background" in the output image. Defaults to PixelType{}.

◆ GetCrop()

template<typename TInputImage, typename TOutputImage>

virtual const bool & itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetCrop ( ) const

virtual

Set/Get whether the image size should be adjusted to the masked image or not.

◆ GetCropBorder()

template<typename TInputImage, typename TOutputImage>

virtual const SizeType & itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetCropBorder ( ) const

virtual

Set/Get the border added to the mask before the crop. The default is 0 on all the axes.

◆ GetFeatureImage()

template<typename TInputImage, typename TOutputImage>

const OutputImageType * itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetFeatureImage ( )

inline

Get the feature image

Definition at line 99 of file itkLabelMapMaskImageFilter.h.

◆ GetLabel()

template<typename TInputImage, typename TOutputImage>

virtual InputImagePixelType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetLabel ( ) const

virtual

The label to mask or to not mask, depending on the value of the Negated ivar.

◆ GetNameOfClass()

template<typename TInputImage, typename TOutputImage>

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

overridevirtual

See also: LightObject::GetNameOfClass()

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

◆ GetNegated()

template<typename TInputImage, typename TOutputImage>

virtual const bool & itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetNegated ( ) const

virtual

Set/Get whether the Label should be masked or not.

◆ NegatedOff()

template<typename TInputImage, typename TOutputImage>

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::NegatedOff ( )

virtual

Set/Get whether the Label should be masked or not.

◆ NegatedOn()

template<typename TInputImage, typename TOutputImage>

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::NegatedOn ( )

virtual

Set/Get whether the Label should be masked or not.

◆ New()

template<typename TInputImage, typename TOutputImage>

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

static

Standard New method.

◆ PrintSelf()

template<typename TInputImage, typename TOutputImage>

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

overrideprotectedvirtual

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

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

◆ SetBackgroundValue()

template<typename TInputImage, typename TOutputImage>

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

virtual

Set/Get the value used as "background" in the output image. Defaults to PixelType{}.

◆ SetCrop()

template<typename TInputImage, typename TOutputImage>

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetCrop ( bool _arg )

virtual

Set/Get whether the image size should be adjusted to the masked image or not.

◆ SetCropBorder()

template<typename TInputImage, typename TOutputImage>

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetCropBorder ( SizeType _arg )

virtual

Set/Get the border added to the mask before the crop. The default is 0 on all the axes.

◆ SetFeatureImage()

template<typename TInputImage, typename TOutputImage>

void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetFeatureImage ( const TOutputImage * input )

inline

Set the feature image

Definition at line 91 of file itkLabelMapMaskImageFilter.h.

◆ SetInput1()

template<typename TInputImage, typename TOutputImage>

void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetInput1 ( const TInputImage * input )

inline

Set the input image

Definition at line 106 of file itkLabelMapMaskImageFilter.h.

◆ SetInput2()

template<typename TInputImage, typename TOutputImage>

void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetInput2 ( const TOutputImage * input )

inline

Set the feature image

Definition at line 113 of file itkLabelMapMaskImageFilter.h.

◆ SetLabel()

template<typename TInputImage, typename TOutputImage>

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetLabel ( InputImagePixelType _arg )

virtual

The label to mask or to not mask, depending on the value of the Negated ivar.

◆ SetNegated()

template<typename TInputImage, typename TOutputImage>

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetNegated ( bool _arg )

virtual

Set/Get whether the Label should be masked or not.

◆ SuperclassDynamicTGD()

template<typename TInputImage, typename TOutputImage>

void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SuperclassDynamicTGD ( const OutputImageRegionType & outputRegion )

inlineprotected

Definition at line 182 of file itkLabelMapMaskImageFilter.h.

◆ ThreadedProcessLabelObject()

template<typename TInputImage, typename TOutputImage>

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

overrideprotectedvirtual

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

Member Data Documentation

◆ ImageDimension

template<typename TInputImage, typename TOutputImage>

unsigned int itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::ImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 81 of file itkLabelMapMaskImageFilter.h.

◆ InputImageDimension

template<typename TInputImage, typename TOutputImage>

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

staticconstexpr

ImageDimension constants

Definition at line 79 of file itkLabelMapMaskImageFilter.h.

◆ m_BackgroundValue

template<typename TInputImage, typename TOutputImage>

OutputImagePixelType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_BackgroundValue {}

private

Definition at line 195 of file itkLabelMapMaskImageFilter.h.

◆ m_Crop

template<typename TInputImage, typename TOutputImage>

bool itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_Crop { false }

private

Definition at line 197 of file itkLabelMapMaskImageFilter.h.

◆ m_CropBorder

template<typename TInputImage, typename TOutputImage>

SizeType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_CropBorder {}

private

Definition at line 198 of file itkLabelMapMaskImageFilter.h.

◆ m_CropTimeStamp

template<typename TInputImage, typename TOutputImage>

TimeStamp itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_CropTimeStamp {}

private

Definition at line 200 of file itkLabelMapMaskImageFilter.h.

◆ m_Label

template<typename TInputImage, typename TOutputImage>

InputImagePixelType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_Label {}

private

Definition at line 194 of file itkLabelMapMaskImageFilter.h.

◆ m_Negated

template<typename TInputImage, typename TOutputImage>

bool itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_Negated { false }

private

Definition at line 196 of file itkLabelMapMaskImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage, typename TOutputImage>

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

staticconstexpr

Definition at line 80 of file itkLabelMapMaskImageFilter.h.

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

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

◆ LabelType

◆ LengthType

◆ OutputImageConstPointer

◆ OutputImagePixelType

◆ OutputImagePointer

◆ OutputImageRegionType

◆ OutputImageType

◆ Pointer

◆ RegionType

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ LabelMapMaskImageFilter()

◆ ~LabelMapMaskImageFilter()

Member Function Documentation

◆ CreateAnother()

◆ CropOff()

◆ CropOn()

◆ DynamicThreadedGenerateData()

◆ EnlargeOutputRequestedRegion()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GenerateOutputInformation()

◆ GetBackgroundValue()

◆ GetCrop()

◆ GetCropBorder()

◆ GetFeatureImage()

◆ GetLabel()

◆ GetNameOfClass()

◆ GetNegated()

◆ NegatedOff()

◆ NegatedOn()

◆ New()

◆ PrintSelf()

◆ SetBackgroundValue()

◆ SetCrop()

◆ SetCropBorder()

◆ SetFeatureImage()

◆ SetInput1()

◆ SetInput2()

◆ SetLabel()

◆ SetNegated()

◆ SuperclassDynamicTGD()

◆ ThreadedProcessLabelObject()

Member Data Documentation

◆ ImageDimension

◆ InputImageDimension

◆ m_BackgroundValue

◆ m_Crop

◆ m_CropBorder

◆ m_CropTimeStamp

◆ m_Label

◆ m_Negated

◆ OutputImageDimension