SimpleITK  
itk::simple::LabelUniqueLabelMapFilter Class Reference

Make sure that the objects are not overlapping. More...

#include <sitkLabelUniqueLabelMapFilter.h>

+ Inheritance diagram for itk::simple::LabelUniqueLabelMapFilter:
+ Collaboration diagram for itk::simple::LabelUniqueLabelMapFilter:

Detailed Description

Make sure that the objects are not overlapping.

AttributeUniqueLabelMapFilter search the overlapping zones in the overlapping objects and keeps only a single object on all the pixels of the image. The object to keep is selected according to their label.

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
AttributeLabelObject
itk::simple::LabelUniqueLabelMap for the procedural interface
itk::LabelUniqueLabelMapFilter for the Doxygen on the original ITK class.

Definition at line 51 of file sitkLabelUniqueLabelMapFilter.h.

Public Types

using PixelIDTypeList = LabelPixelIDTypeList
 
using Self = LabelUniqueLabelMapFilter
 
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
 
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject
 

Public Member Functions

Image Execute (const Image &image1)
 
Image Execute (Image &&image1)
 
std::string GetName () const
 
bool GetReverseOrdering () const
 
 LabelUniqueLabelMapFilter ()
 
void ReverseOrderingOff ()
 
void ReverseOrderingOn ()
 
void SetReverseOrdering (bool ReverseOrdering)
 
std::string ToString () const
 
virtual ~LabelUniqueLabelMapFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event.
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event.
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution.
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event.
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands.
 
virtual ~ProcessObject ()
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
virtual bool GetDebug () const
 
virtual void SetDebug (bool debugFlag)
 
virtual void SetNumberOfThreads (unsigned int n)
 
virtual unsigned int GetNumberOfThreads () const
 
virtual void SetNumberOfWorkUnits (unsigned int n)
 
virtual unsigned int GetNumberOfWorkUnits () const
 

Private Types

using MemberFunctionType = Image (Self::*)(const Image &image1)
 

Private Member Functions

template<class TImageType>
Image ExecuteInternal (const Image &image1)
 

Static Private Member Functions

static const detail::MemberFunctionFactory< MemberFunctionType > & GetMemberFunctionFactory ()
 

Private Attributes

bool m_InPlace {false}
 
bool m_ReverseOrdering { false }
 

Friends

struct detail::MemberFunctionAddressor< MemberFunctionType >
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
 
static void GlobalDefaultDebugOff ()
 
static void GlobalDefaultDebugOn ()
 
static void SetGlobalDefaultDebug (bool debugFlag)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces.
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces.
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces.
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces.
 
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects.
 
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects.
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects.
 
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
 
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
NonCopyableoperator= (const NonCopyable &)=delete
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType>
static void FixNonZeroIndex (TImageType *img)
 
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType>
static TImageType::ConstPointer CastImageToITK (const Image &img)
 
template<class TPixelType, unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)
 
template<class TImageType>
static Image CastITKToImage (TImageType *img)
 
static const itk::EventObjectGetITKEventObject (EventEnum e)
 
template<typename T>
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)
 

Member Typedef Documentation

◆ MemberFunctionType

Setup for member function dispatching

Definition at line 101 of file sitkLabelUniqueLabelMapFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 63 of file sitkLabelUniqueLabelMapFilter.h.

◆ Self

Constructor & Destructor Documentation

◆ ~LabelUniqueLabelMapFilter()

virtual itk::simple::LabelUniqueLabelMapFilter::~LabelUniqueLabelMapFilter ( )
virtual

Destructor

◆ LabelUniqueLabelMapFilter()

itk::simple::LabelUniqueLabelMapFilter::LabelUniqueLabelMapFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

Image itk::simple::LabelUniqueLabelMapFilter::Execute ( const Image & image1)

◆ Execute() [2/2]

Image itk::simple::LabelUniqueLabelMapFilter::Execute ( Image && image1)

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType>
Image itk::simple::LabelUniqueLabelMapFilter::ExecuteInternal ( const Image & image1)
private

◆ GetMemberFunctionFactory()

static const detail::MemberFunctionFactory< MemberFunctionType > & itk::simple::LabelUniqueLabelMapFilter::GetMemberFunctionFactory ( )
staticprivate

◆ GetName()

std::string itk::simple::LabelUniqueLabelMapFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 86 of file sitkLabelUniqueLabelMapFilter.h.

◆ GetReverseOrdering()

bool itk::simple::LabelUniqueLabelMapFilter::GetReverseOrdering ( ) const
inline

Definition at line 82 of file sitkLabelUniqueLabelMapFilter.h.

References m_ReverseOrdering.

◆ ReverseOrderingOff()

void itk::simple::LabelUniqueLabelMapFilter::ReverseOrderingOff ( )
inline

Definition at line 78 of file sitkLabelUniqueLabelMapFilter.h.

References SetReverseOrdering().

◆ ReverseOrderingOn()

void itk::simple::LabelUniqueLabelMapFilter::ReverseOrderingOn ( )
inline

Set the value of ReverseOrdering to true or false respectfully.

Definition at line 76 of file sitkLabelUniqueLabelMapFilter.h.

References SetReverseOrdering().

◆ SetReverseOrdering()

void itk::simple::LabelUniqueLabelMapFilter::SetReverseOrdering ( bool ReverseOrdering)
inline

Definition at line 71 of file sitkLabelUniqueLabelMapFilter.h.

References m_ReverseOrdering.

Referenced by ReverseOrderingOff(), and ReverseOrderingOn().

◆ ToString()

std::string itk::simple::LabelUniqueLabelMapFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 102 of file sitkLabelUniqueLabelMapFilter.h.

References ExecuteInternal().

Member Data Documentation

◆ m_InPlace

bool itk::simple::LabelUniqueLabelMapFilter::m_InPlace {false}
private

Definition at line 115 of file sitkLabelUniqueLabelMapFilter.h.

◆ m_ReverseOrdering

bool itk::simple::LabelUniqueLabelMapFilter::m_ReverseOrdering { false }
private

Definition at line 107 of file sitkLabelUniqueLabelMapFilter.h.

Referenced by GetReverseOrdering(), and SetReverseOrdering().


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