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

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = LabelOverlayImageFilter
 
- 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 &image, const Image &labelImage)
 
Image Execute (Image &&image, const Image &labelImage)
 
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
 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 *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 {0.0}
 
std::vector< uint8_tm_Colormap {std::vector<uint8_t>()}
 
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
 
bool m_InPlace {false}
 
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 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 53 of file sitkLabelOverlayImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 113 of file sitkLabelOverlayImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 65 of file sitkLabelOverlayImageFilter.h.

◆ Self

Definition at line 55 of file sitkLabelOverlayImageFilter.h.

Constructor & Destructor Documentation

◆ ~LabelOverlayImageFilter()

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

Destructor

◆ LabelOverlayImageFilter()

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ DualExecuteInternal()

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

◆ Execute() [1/2]

Image itk::simple::LabelOverlayImageFilter::Execute ( const Image image,
const Image labelImage 
)

◆ Execute() [2/2]

Image itk::simple::LabelOverlayImageFilter::Execute ( Image &&  image,
const Image labelImage 
)

Execute the filter on the input image

◆ GetBackgroundValue()

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

Set/Get the background value

Definition at line 87 of file sitkLabelOverlayImageFilter.h.

◆ GetColormap()

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

Definition at line 95 of file sitkLabelOverlayImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 98 of file sitkLabelOverlayImageFilter.h.

◆ GetOpacity()

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 77 of file sitkLabelOverlayImageFilter.h.

◆ SetBackgroundValue()

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

Set/Get the background value

Definition at line 82 of file sitkLabelOverlayImageFilter.h.

◆ SetColormap()

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

Definition at line 91 of file sitkLabelOverlayImageFilter.h.

◆ SetOpacity()

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 72 of file sitkLabelOverlayImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::DualExecuteInternalAddressor< MemberFunctionType >

Definition at line 115 of file sitkLabelOverlayImageFilter.h.

Member Data Documentation

◆ m_BackgroundValue

double itk::simple::LabelOverlayImageFilter::m_BackgroundValue {0.0}
private

Definition at line 126 of file sitkLabelOverlayImageFilter.h.

◆ m_Colormap

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

Definition at line 128 of file sitkLabelOverlayImageFilter.h.

◆ m_DualMemberFactory

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

Definition at line 119 of file sitkLabelOverlayImageFilter.h.

◆ m_InPlace

bool itk::simple::LabelOverlayImageFilter::m_InPlace {false}
private

Definition at line 131 of file sitkLabelOverlayImageFilter.h.

◆ m_Opacity

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

Definition at line 124 of file sitkLabelOverlayImageFilter.h.


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