SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::RelabelLabelMapFilter Class Reference

This filter relabels the LabelObjects; the new labels are arranged consecutively with consideration for the background value. More...

#include <sitkRelabelLabelMapFilter.h>

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

Public Types

using PixelIDTypeList = LabelPixelIDTypeList
using Self = RelabelLabelMapFilter
- 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
 RelabelLabelMapFilter ()
SelfReverseOrderingOff ()
SelfReverseOrderingOn ()
SelfSetReverseOrdering (bool ReverseOrdering)
std::string ToString () const
virtual ~RelabelLabelMapFilter ()
- 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. More...
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 ProcessObject ()
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
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)

Private Attributes

bool m_InPlace {false}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
bool m_ReverseOrdering {true}


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. More...
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
- 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<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)

Detailed Description

This filter relabels the LabelObjects; the new labels are arranged consecutively with consideration for the background value.

This filter takes the LabelObjects from the input and reassigns them to the output by calling the PushLabelObject method, which by default, attempts to reorganize the labels consecutively. The user can assign an arbitrary value to the background; the filter will assign the labels consecutively by skipping the background value.

This implementation was taken from the Insight Journal paper: or

Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.
See also
ShapeLabelObject , RelabelComponentImageFilter
itk::simple::RelabelLabelMapFilter for the procedural interface
itk::RelabelLabelMapFilter for the Doxygen on the original ITK class.

Definition at line 47 of file sitkRelabelLabelMapFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 91 of file sitkRelabelLabelMapFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 59 of file sitkRelabelLabelMapFilter.h.

◆ Self

Definition at line 49 of file sitkRelabelLabelMapFilter.h.

Constructor & Destructor Documentation

◆ ~RelabelLabelMapFilter()

virtual itk::simple::RelabelLabelMapFilter::~RelabelLabelMapFilter ( )


◆ RelabelLabelMapFilter()

itk::simple::RelabelLabelMapFilter::RelabelLabelMapFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

Image itk::simple::RelabelLabelMapFilter::Execute ( const Image image1)

◆ Execute() [2/2]

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

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::RelabelLabelMapFilter::ExecuteInternal ( const Image image1)

◆ GetName()

std::string itk::simple::RelabelLabelMapFilter::GetName ( ) const

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 75 of file sitkRelabelLabelMapFilter.h.

◆ GetReverseOrdering()

bool itk::simple::RelabelLabelMapFilter::GetReverseOrdering ( ) const

Definition at line 72 of file sitkRelabelLabelMapFilter.h.

◆ ReverseOrderingOff()

Self& itk::simple::RelabelLabelMapFilter::ReverseOrderingOff ( )

Definition at line 68 of file sitkRelabelLabelMapFilter.h.

◆ ReverseOrderingOn()

Self& itk::simple::RelabelLabelMapFilter::ReverseOrderingOn ( )

Set the value of ReverseOrdering to true or false respectfully.

Definition at line 67 of file sitkRelabelLabelMapFilter.h.

◆ SetReverseOrdering()

Self& itk::simple::RelabelLabelMapFilter::SetReverseOrdering ( bool  ReverseOrdering)

Definition at line 64 of file sitkRelabelLabelMapFilter.h.

◆ ToString()

std::string itk::simple::RelabelLabelMapFilter::ToString ( ) const

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 95 of file sitkRelabelLabelMapFilter.h.

Member Data Documentation

◆ m_InPlace

bool itk::simple::RelabelLabelMapFilter::m_InPlace {false}

Definition at line 104 of file sitkRelabelLabelMapFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::RelabelLabelMapFilter::m_MemberFactory

Definition at line 97 of file sitkRelabelLabelMapFilter.h.

◆ m_ReverseOrdering

bool itk::simple::RelabelLabelMapFilter::m_ReverseOrdering {true}

Definition at line 101 of file sitkRelabelLabelMapFilter.h.

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