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

Replace the label Ids of selected LabelObjects with new label Ids. More...

#include <sitkChangeLabelLabelMapFilter.h>

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

Public Types

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

Public Member Functions

 ChangeLabelLabelMapFilter ()
Image Execute (const Image &image1)
Image Execute (Image &&image1)
std::map< double, double > GetChangeMap () const
std::string GetName () const
SelfSetChangeMap (std::map< double, double > ChangeMap)
std::string ToString () const
virtual ~ChangeLabelLabelMapFilter ()
- 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

std::map< double, double > m_ChangeMap {std::map<double,double>()}
bool m_InPlace {false}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory


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

Replace the label Ids of selected LabelObjects with new label Ids.

This filter takes as input a label map and a list of pairs of Label Ids, to produce as output a new label map where the label Ids have been replaced according to the pairs in the list.

Labels that are relabeled to the same label Id are automatically merged and optimized into a single LabelObject . The background label can also be changed. Any object relabeled to the output background will automatically be removed.

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 , ChangeLabelImageFilter
itk::simple::ChangeLabelLabelMapFilter for the procedural interface
itk::ChangeLabelLabelMapFilter for the Doxygen on the original ITK class.

Definition at line 51 of file sitkChangeLabelLabelMapFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 91 of file sitkChangeLabelLabelMapFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 63 of file sitkChangeLabelLabelMapFilter.h.

◆ Self

Definition at line 53 of file sitkChangeLabelLabelMapFilter.h.

Constructor & Destructor Documentation

◆ ~ChangeLabelLabelMapFilter()

virtual itk::simple::ChangeLabelLabelMapFilter::~ChangeLabelLabelMapFilter ( )


◆ ChangeLabelLabelMapFilter()

itk::simple::ChangeLabelLabelMapFilter::ChangeLabelLabelMapFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

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

◆ Execute() [2/2]

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetChangeMap()

std::map<double,double> itk::simple::ChangeLabelLabelMapFilter::GetChangeMap ( ) const

Definition at line 72 of file sitkChangeLabelLabelMapFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 75 of file sitkChangeLabelLabelMapFilter.h.

◆ SetChangeMap()

Self& itk::simple::ChangeLabelLabelMapFilter::SetChangeMap ( std::map< double, double >  ChangeMap)

Definition at line 68 of file sitkChangeLabelLabelMapFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 95 of file sitkChangeLabelLabelMapFilter.h.

Member Data Documentation

◆ m_ChangeMap

std::map<double,double> itk::simple::ChangeLabelLabelMapFilter::m_ChangeMap {std::map<double,double>()}

Definition at line 100 of file sitkChangeLabelLabelMapFilter.h.

◆ m_InPlace

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

Definition at line 103 of file sitkChangeLabelLabelMapFilter.h.

◆ m_MemberFactory

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

Definition at line 97 of file sitkChangeLabelLabelMapFilter.h.

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