SimpleITK  2.0.0rc2.post23
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

using PixelIDTypeList = LabelPixelIDTypeList
 
using Self = LabelMapOverlayImageFilter
 
- 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 &labelMapImage, const Image &featureImage)
 
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
 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 *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 {std::vector<unsigned char>()}
 
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
 
double m_Opacity {0.5}
 

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 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 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 55 of file sitkLabelMapOverlayImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 103 of file sitkLabelMapOverlayImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 67 of file sitkLabelMapOverlayImageFilter.h.

◆ Self

Definition at line 57 of file sitkLabelMapOverlayImageFilter.h.

Constructor & Destructor Documentation

◆ ~LabelMapOverlayImageFilter()

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

Destructor

◆ LabelMapOverlayImageFilter()

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ DualExecuteInternal()

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

◆ Execute()

Image itk::simple::LabelMapOverlayImageFilter::Execute ( const Image labelMapImage,
const Image featureImage 
)

Execute the filter on the input image

◆ GetColormap()

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

Definition at line 87 of file sitkLabelMapOverlayImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 90 of file sitkLabelMapOverlayImageFilter.h.

◆ GetOpacity()

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 79 of file sitkLabelMapOverlayImageFilter.h.

◆ SetColormap()

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

Definition at line 83 of file sitkLabelMapOverlayImageFilter.h.

◆ SetOpacity()

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 74 of file sitkLabelMapOverlayImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::DualExecuteInternalAddressor< MemberFunctionType >

Definition at line 105 of file sitkLabelMapOverlayImageFilter.h.

Member Data Documentation

◆ m_Colormap

std::vector<unsigned char> itk::simple::LabelMapOverlayImageFilter::m_Colormap {std::vector<unsigned char>()}
private

Definition at line 116 of file sitkLabelMapOverlayImageFilter.h.

◆ m_DualMemberFactory

std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > itk::simple::LabelMapOverlayImageFilter::m_DualMemberFactory
private

Definition at line 109 of file sitkLabelMapOverlayImageFilter.h.

◆ m_Opacity

double itk::simple::LabelMapOverlayImageFilter::m_Opacity {0.5}
private

Definition at line 114 of file sitkLabelMapOverlayImageFilter.h.


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