SimpleITK  1.3.0.dev466
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::LabelMapOverlayImageFilter Class Reference

Apply a colormap to a label map and superimpose it on an image. More...

#include <sitkLabelMapOverlayImageFilter.h>

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

Public Types

typedef LabelPixelIDTypeList PixelIDTypeList
 
typedef LabelMapOverlayImageFilter 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 &labelMapImage, const Image &featureImage)
 
Image Execute (const Image &labelMapImage, const Image &featureImage, double opacity, std::vector< unsigned char > colormap)
 
std::vector< unsigned char > GetColormap () const
 
std::string GetName () const
 
double GetOpacity () const
 
 LabelMapOverlayImageFilter ()
 
SelfSetColormap (std::vector< unsigned char > Colormap)
 
SelfSetOpacity (double Opacity)
 
std::string ToString () const
 
virtual ~LabelMapOverlayImageFilter ()
 
- 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 *labelMapImage, const Image *featureImage)
 

Private Member Functions

template<class TImageType1 , class TImageType2 >
Image DualExecuteInternal (const Image *labelMapImage, const Image *featureImage)
 

Private Attributes

std::vector< unsigned char > m_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 map and superimpose it on an image.

Apply a colormap to a label map and put it on top of the feature image. The feature image is typically the image from which the labeling was produced. Use the SetInput function to set the LabelMap , and the SetFeatureImage function to set the feature image.

The set of colors is a good selection of distinct colors. The opacity of the label map can be defined by the user. 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 implementation was taken from the Insight Journal paper: https://hdl.handle.net/1926/584 or http://www.insight-journal.org/browse/publication/176

See also
LabelOverlayImageFilter , LabelOverlayFunctor
LabelMapToRGBImageFilter , LabelMapToBinaryImageFilter , LabelMapToLabelImageFilter
itk::simple::LabelMapOverlay for the procedural interface
itk::LabelMapOverlayImageFilter for the Doxygen on the original ITK class.

Definition at line 53 of file sitkLabelMapOverlayImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::LabelMapOverlayImageFilter::MemberFunctionType) (const Image *labelMapImage, const Image *featureImage)
private

Setup for member function dispatching

Definition at line 103 of file sitkLabelMapOverlayImageFilter.h.

Define the pixels types supported by this filter

Definition at line 65 of file sitkLabelMapOverlayImageFilter.h.

Definition at line 55 of file sitkLabelMapOverlayImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::LabelMapOverlayImageFilter::~LabelMapOverlayImageFilter ( )
virtual

Destructor

itk::simple::LabelMapOverlayImageFilter::LabelMapOverlayImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

template<class TImageType1 , class TImageType2 >
Image itk::simple::LabelMapOverlayImageFilter::DualExecuteInternal ( const Image labelMapImage,
const Image featureImage 
)
private
Image itk::simple::LabelMapOverlayImageFilter::Execute ( const Image labelMapImage,
const Image featureImage 
)

Execute the filter on the input image

Image itk::simple::LabelMapOverlayImageFilter::Execute ( const Image labelMapImage,
const Image featureImage,
double  opacity,
std::vector< unsigned char >  colormap 
)

Execute the filter on the input image with the given parameters

std::vector<unsigned char> itk::simple::LabelMapOverlayImageFilter::GetColormap ( ) const
inline

Definition at line 85 of file sitkLabelMapOverlayImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 87 of file sitkLabelMapOverlayImageFilter.h.

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

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

Definition at line 77 of file sitkLabelMapOverlayImageFilter.h.

Self& itk::simple::LabelMapOverlayImageFilter::SetColormap ( std::vector< unsigned char >  Colormap)
inline

Definition at line 81 of file sitkLabelMapOverlayImageFilter.h.

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

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

Definition at line 72 of file sitkLabelMapOverlayImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 105 of file sitkLabelMapOverlayImageFilter.h.

Member Data Documentation

std::vector<unsigned char> itk::simple::LabelMapOverlayImageFilter::m_Colormap
private

Definition at line 115 of file sitkLabelMapOverlayImageFilter.h.

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

Definition at line 109 of file sitkLabelMapOverlayImageFilter.h.

double itk::simple::LabelMapOverlayImageFilter::m_Opacity
private

Definition at line 114 of file sitkLabelMapOverlayImageFilter.h.


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