SimpleITK  1.3.0.dev165
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

typedef IntegerPixelIDTypeList PixelIDTypeList
 
typedef LabelToRGBImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &image1)
 
Image Execute (const Image &image1, double backgroundValue, std::vector< uint8_t > colormap)
 
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< 1 >
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
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
 

Private Types

typedef Image(Self::* MemberFunctionType) (const Image &image1)
 

Private Member Functions

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

Private Attributes

double m_BackgroundValue
 
std::vector< uint8_tm_Colormap
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 

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 void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
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...
 
- 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) SITK_NOEXCEPT
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
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 TImageType >
static Image CastITKToImage (TImageType *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)
 
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. https://hdl.handle.net/1926/202 http://www.insight-journal.org/browse/publication/92

Author
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
LabelOverlayImageFilter
LabelMapToRGBImageFilter , LabelToRGBFunctor, ScalarToRGBPixelFunctor
itk::simple::LabelToRGB for the procedural interface
itk::LabelToRGBImageFilter for the Doxygen on the original ITK class.

Definition at line 52 of file sitkLabelToRGBImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::LabelToRGBImageFilter::MemberFunctionType) (const Image &image1)
private

Setup for member function dispatching

Definition at line 103 of file sitkLabelToRGBImageFilter.h.

Define the pixels types supported by this filter

Definition at line 64 of file sitkLabelToRGBImageFilter.h.

Definition at line 54 of file sitkLabelToRGBImageFilter.h.

Constructor & Destructor Documentation

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

Destructor

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::LabelToRGBImageFilter::Execute ( const Image image1,
double  backgroundValue,
std::vector< uint8_t colormap 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::LabelToRGBImageFilter::ExecuteInternal ( const Image image1)
private
double itk::simple::LabelToRGBImageFilter::GetBackgroundValue ( ) const
inline

Set/Get the background value

Definition at line 76 of file sitkLabelToRGBImageFilter.h.

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

Definition at line 84 of file sitkLabelToRGBImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 86 of file sitkLabelToRGBImageFilter.h.

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

Set/Get the background value

Definition at line 71 of file sitkLabelToRGBImageFilter.h.

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

Definition at line 80 of file sitkLabelToRGBImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 107 of file sitkLabelToRGBImageFilter.h.

Member Data Documentation

double itk::simple::LabelToRGBImageFilter::m_BackgroundValue
private

Definition at line 113 of file sitkLabelToRGBImageFilter.h.

std::vector<uint8_t> itk::simple::LabelToRGBImageFilter::m_Colormap
private

Definition at line 114 of file sitkLabelToRGBImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::LabelToRGBImageFilter::m_MemberFactory
private

Definition at line 109 of file sitkLabelToRGBImageFilter.h.


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