SimpleITK  1.2.4
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::LabelOverlayImageFilter Class Reference

Apply a colormap to a label image and put it on top of the input image. More...

#include <sitkLabelOverlayImageFilter.h>

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

Public Types

typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef LabelOverlayImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 0 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &image, const Image &labelImage)
 
Image Execute (const Image &image, const Image &labelImage, double opacity, double backgroundValue, std::vector< uint8_t > colormap)
 
double GetBackgroundValue () const
 
std::vector< uint8_tGetColormap () const
 
std::string GetName () const
 
double GetOpacity () const
 
 LabelOverlayImageFilter ()
 
SelfSetBackgroundValue (double BackgroundValue)
 
SelfSetColormap (std::vector< uint8_t > Colormap)
 
SelfSetOpacity (double Opacity)
 
std::string ToString () const
 
virtual ~LabelOverlayImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 0 >
 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 *image, const Image *labelImage)
 

Private Member Functions

template<class TImageType1 , class TImageType2 >
Image DualExecuteInternal (const Image *image, const Image *labelImage)
 

Private Attributes

double m_BackgroundValue
 
std::vector< uint8_tm_Colormap
 
nsstd::auto_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
 
double m_Opacity
 

Friends

struct detail::DualExecuteInternalAddressor< 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< 0 >
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 and put it on top of the input image.

Apply a colormap to a label image and put it on top of the input image. The set of colors is a good selection of distinct colors. The opacity of the label image can be defined by the user. The user can also choose if the want to use a background and which label value is the background. A background label produce a gray pixel with the same intensity than the input one.

Author
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

This class was contributed to the Insight Journal https://hdl.handle.net/1926/172

See also
LabelToRGBImageFilter
LabelMapOverlayImageFilter , LabelOverlayFunctor
itk::simple::LabelOverlay for the procedural interface
itk::LabelOverlayImageFilter for the Doxygen on the original ITK class.

Definition at line 51 of file sitkLabelOverlayImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::LabelOverlayImageFilter::MemberFunctionType) (const Image *image, const Image *labelImage)
private

Setup for member function dispatching

Definition at line 111 of file sitkLabelOverlayImageFilter.h.

Define the pixels types supported by this filter

Definition at line 63 of file sitkLabelOverlayImageFilter.h.

Definition at line 53 of file sitkLabelOverlayImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::LabelOverlayImageFilter::~LabelOverlayImageFilter ( )
virtual

Destructor

itk::simple::LabelOverlayImageFilter::LabelOverlayImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

template<class TImageType1 , class TImageType2 >
Image itk::simple::LabelOverlayImageFilter::DualExecuteInternal ( const Image image,
const Image labelImage 
)
private
Image itk::simple::LabelOverlayImageFilter::Execute ( const Image image,
const Image labelImage 
)

Execute the filter on the input image

Image itk::simple::LabelOverlayImageFilter::Execute ( const Image image,
const Image labelImage,
double  opacity,
double  backgroundValue,
std::vector< uint8_t colormap 
)

Execute the filter on the input image with the given parameters

double itk::simple::LabelOverlayImageFilter::GetBackgroundValue ( ) const
inline

Set/Get the background value

Definition at line 85 of file sitkLabelOverlayImageFilter.h.

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

Definition at line 93 of file sitkLabelOverlayImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 95 of file sitkLabelOverlayImageFilter.h.

double itk::simple::LabelOverlayImageFilter::GetOpacity ( ) const
inline

Set/Get the opacity of the colored label image. The value must be between 0 and 1

Definition at line 75 of file sitkLabelOverlayImageFilter.h.

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

Set/Get the background value

Definition at line 80 of file sitkLabelOverlayImageFilter.h.

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

Definition at line 89 of file sitkLabelOverlayImageFilter.h.

Self& itk::simple::LabelOverlayImageFilter::SetOpacity ( double  Opacity)
inline

Set/Get the opacity of the colored label image. The value must be between 0 and 1

Definition at line 70 of file sitkLabelOverlayImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 113 of file sitkLabelOverlayImageFilter.h.

Member Data Documentation

double itk::simple::LabelOverlayImageFilter::m_BackgroundValue
private

Definition at line 123 of file sitkLabelOverlayImageFilter.h.

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

Definition at line 124 of file sitkLabelOverlayImageFilter.h.

nsstd::auto_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > itk::simple::LabelOverlayImageFilter::m_DualMemberFactory
private

Definition at line 117 of file sitkLabelOverlayImageFilter.h.

double itk::simple::LabelOverlayImageFilter::m_Opacity
private

Definition at line 122 of file sitkLabelOverlayImageFilter.h.


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