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

Apply a colormap to a label image. More...

#include <sitkLabelToRGBImageFilter.h>

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

Public Types

using PixelIDTypeList = IntegerPixelIDTypeList
using Self = LabelToRGBImageFilter
- 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)
double GetBackgroundValue () const
std::vector< uint8_tGetColormap () const
std::string GetName () const
 LabelToRGBImageFilter ()
SelfSetBackgroundValue (double BackgroundValue)
SelfSetColormap (std::vector< uint8_t > Colormap)
std::string ToString () const
virtual ~LabelToRGBImageFilter ()
- 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

double m_BackgroundValue {0.0}
std::vector< uint8_tm_Colormap {std::vector<uint8_t>()}
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

Apply a colormap to a label image.

Apply a colormap to a label image. The set of colors is a good selection of distinct colors. The user can choose to use a background value. In that case, a gray pixel with the same intensity than the background label is produced.

This code was contributed in the Insight Journal paper: "The watershed transform in ITK - discussion and new developments" by Beare R., Lehmann G.

Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.
Richard Beare. Department of Medicine, Monash University, Melbourne, Australia.
See also
LabelMapToRGBImageFilter , LabelToRGBFunctor, ScalarToRGBPixelFunctor
itk::simple::LabelToRGB for the procedural interface
itk::LabelToRGBImageFilter for the Doxygen on the original ITK class.

Definition at line 55 of file sitkLabelToRGBImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 105 of file sitkLabelToRGBImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 67 of file sitkLabelToRGBImageFilter.h.

◆ Self

Definition at line 57 of file sitkLabelToRGBImageFilter.h.

Constructor & Destructor Documentation

◆ ~LabelToRGBImageFilter()

virtual itk::simple::LabelToRGBImageFilter::~LabelToRGBImageFilter ( )


◆ LabelToRGBImageFilter()

itk::simple::LabelToRGBImageFilter::LabelToRGBImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

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

◆ Execute() [2/2]

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ GetBackgroundValue()

double itk::simple::LabelToRGBImageFilter::GetBackgroundValue ( ) const

Set/Get the background value

Definition at line 78 of file sitkLabelToRGBImageFilter.h.

◆ GetColormap()

std::vector<uint8_t> itk::simple::LabelToRGBImageFilter::GetColormap ( ) const

Definition at line 86 of file sitkLabelToRGBImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 89 of file sitkLabelToRGBImageFilter.h.

◆ SetBackgroundValue()

Self& itk::simple::LabelToRGBImageFilter::SetBackgroundValue ( double  BackgroundValue)

Set/Get the background value

Definition at line 73 of file sitkLabelToRGBImageFilter.h.

◆ SetColormap()

Self& itk::simple::LabelToRGBImageFilter::SetColormap ( std::vector< uint8_t Colormap)

Definition at line 82 of file sitkLabelToRGBImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 109 of file sitkLabelToRGBImageFilter.h.

Member Data Documentation

◆ m_BackgroundValue

double itk::simple::LabelToRGBImageFilter::m_BackgroundValue {0.0}

Definition at line 115 of file sitkLabelToRGBImageFilter.h.

◆ m_Colormap

std::vector<uint8_t> itk::simple::LabelToRGBImageFilter::m_Colormap {std::vector<uint8_t>()}

Definition at line 117 of file sitkLabelToRGBImageFilter.h.

◆ m_InPlace

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

Definition at line 120 of file sitkLabelToRGBImageFilter.h.

◆ m_MemberFactory

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

Definition at line 111 of file sitkLabelToRGBImageFilter.h.

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