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

Merges several Label Maps. More...

#include <sitkMergeLabelMapFilter.h>

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

Public Types

enum  MethodType {
  Keep,
  Aggregate,
  Pack,
  Strict
}
 
using PixelIDTypeList = LabelPixelIDTypeList
 
using Self = MergeLabelMapFilter
 
- 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 (const Image &image1, const Image &image2)
 
Image Execute (const Image &image1, const Image &image2, const Image &image3)
 
Image Execute (const Image &image1, const Image &image2, const Image &image3, const Image &image4)
 
Image Execute (const Image &image1, const Image &image2, const Image &image3, const Image &image4, const Image &image5)
 
Image Execute (const std::vector< Image > &images)
 
MethodType GetMethod () const
 
std::string GetName () const
 
 MergeLabelMapFilter ()
 
SelfSetMethod (MethodType Method)
 
std::string ToString () const
 
virtual ~MergeLabelMapFilter ()
 
- 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 std::vector< Image > &)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const std::vector< Image > &images)
 

Private Attributes

bool m_InPlace {false}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
MethodType m_Method {itk::simple::MergeLabelMapFilter::Keep}
 

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

Merges several Label Maps.

This filter takes one or more input Label Map and merges them.

SetMethod() can be used to change how the filter manage the labels from the different label maps. KEEP (0): MergeLabelMapFilter do its best to keep the label unchanged, but if a label is already used in a previous label map, a new label is assigned. AGGREGATE (1): If the same label is found several times in the label maps, the label objects with the same label are merged. PACK (2): MergeLabelMapFilter relabel all the label objects by order of processing. No conflict can occur. STRICT (3): MergeLabelMapFilter keeps the labels unchanged and raises an exception if the same label is found in several images.

This implementation was taken from the Insight Journal paper: https://hdl.handle.net/1926/584 or http://www.insight-journal.org/browse/publication/176

Author
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.
See also
ShapeLabelObject , RelabelComponentImageFilter
itk::simple::MergeLabelMapFilter for the procedural interface

Definition at line 52 of file sitkMergeLabelMapFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::MergeLabelMapFilter::MemberFunctionType = Image (Self::*)( const std::vector<Image> & )
private

Setup for member function dispatching

Definition at line 105 of file sitkMergeLabelMapFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 67 of file sitkMergeLabelMapFilter.h.

◆ Self

Definition at line 56 of file sitkMergeLabelMapFilter.h.

Member Enumeration Documentation

◆ MethodType

Enumerator
Keep 
Aggregate 
Pack 
Strict 

Definition at line 72 of file sitkMergeLabelMapFilter.h.

Constructor & Destructor Documentation

◆ ~MergeLabelMapFilter()

virtual itk::simple::MergeLabelMapFilter::~MergeLabelMapFilter ( )
virtual

Destructor

◆ MergeLabelMapFilter()

itk::simple::MergeLabelMapFilter::MergeLabelMapFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/6]

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

◆ Execute() [2/6]

Image itk::simple::MergeLabelMapFilter::Execute ( const Image image1,
const Image image2 
)

◆ Execute() [3/6]

Image itk::simple::MergeLabelMapFilter::Execute ( const Image image1,
const Image image2,
const Image image3 
)

◆ Execute() [4/6]

Image itk::simple::MergeLabelMapFilter::Execute ( const Image image1,
const Image image2,
const Image image3,
const Image image4 
)

◆ Execute() [5/6]

Image itk::simple::MergeLabelMapFilter::Execute ( const Image image1,
const Image image2,
const Image image3,
const Image image4,
const Image image5 
)

◆ Execute() [6/6]

Image itk::simple::MergeLabelMapFilter::Execute ( const std::vector< Image > &  images)

Execute the filter on the input images

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::MergeLabelMapFilter::ExecuteInternal ( const std::vector< Image > &  images)
private

◆ GetMethod()

MethodType itk::simple::MergeLabelMapFilter::GetMethod ( ) const
inline

Set/Get the method used to merge the label maps

Definition at line 82 of file sitkMergeLabelMapFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 85 of file sitkMergeLabelMapFilter.h.

◆ SetMethod()

Self& itk::simple::MergeLabelMapFilter::SetMethod ( MethodType  Method)
inline

Set/Get the method used to merge the label maps

Definition at line 77 of file sitkMergeLabelMapFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 110 of file sitkMergeLabelMapFilter.h.

Member Data Documentation

◆ m_InPlace

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

Definition at line 118 of file sitkMergeLabelMapFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::MergeLabelMapFilter::m_MemberFactory
private

Definition at line 112 of file sitkMergeLabelMapFilter.h.

◆ m_Method

MethodType itk::simple::MergeLabelMapFilter::m_Method {itk::simple::MergeLabelMapFilter::Keep}
private

Definition at line 115 of file sitkMergeLabelMapFilter.h.


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