SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::LabelMapContourOverlayImageFilter Class Reference

Apply a colormap to the contours (outlines) of each object in a label map and superimpose it on top of the feature image. More...

#include <sitkLabelMapContourOverlayImageFilter.h>

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

Public Types

enum  ContourTypeType {
  PLAIN,
  CONTOUR,
  SLICE_CONTOUR
}
 
using PixelIDTypeList = LabelPixelIDTypeList
 
enum  PriorityType {
  HIGH_LABEL_ON_TOP,
  LOW_LABEL_ON_TOP
}
 
using Self = LabelMapContourOverlayImageFilter
 
- 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< uint8_tGetColormap () const
 
std::vector< unsigned int > GetContourThickness () const
 
ContourTypeType GetContourType () const
 
std::vector< unsigned int > GetDilationRadius () const
 
std::string GetName () const
 
double GetOpacity () const
 
PriorityType GetPriority () const
 
unsigned int GetSliceDimension () const
 
 LabelMapContourOverlayImageFilter ()
 
SelfSetColormap (std::vector< uint8_t > Colormap)
 
SelfSetContourThickness (std::vector< unsigned int > ContourThickness)
 
SelfSetContourType (ContourTypeType ContourType)
 
SelfSetDilationRadius (std::vector< unsigned int > DilationRadius)
 
SelfSetDilationRadius (unsigned int value)
 
SelfSetOpacity (double Opacity)
 
SelfSetPriority (PriorityType Priority)
 
SelfSetSliceDimension (unsigned int SliceDimension)
 
std::string ToString () const
 
virtual ~LabelMapContourOverlayImageFilter ()
 
- 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< uint8_tm_Colormap {std::vector<uint8_t>()}
 
std::vector< unsigned int > m_ContourThickness {std::vector<unsigned int>(3, 1)}
 
ContourTypeType m_ContourType {itk::simple::LabelMapContourOverlayImageFilter::CONTOUR}
 
std::vector< unsigned int > m_DilationRadius {std::vector<unsigned int>(3, 1)}
 
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
 
double m_Opacity {0.5}
 
PriorityType m_Priority {itk::simple::LabelMapContourOverlayImageFilter::HIGH_LABEL_ON_TOP}
 
unsigned int m_SliceDimension {0u}
 

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 the contours (outlines) of each object in a label map and superimpose 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.

Apply a colormap to a label map 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 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
LabelMapOverlayImageFilter , LabelOverlayImageFilter , LabelOverlayFunctor
LabelMapToBinaryImageFilter , LabelMapToLabelImageFilter ,
itk::simple::LabelMapContourOverlay for the procedural interface
itk::LabelMapContourOverlayImageFilter for the Doxygen on the original ITK class.

Definition at line 55 of file sitkLabelMapContourOverlayImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 162 of file sitkLabelMapContourOverlayImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 67 of file sitkLabelMapContourOverlayImageFilter.h.

◆ Self

Definition at line 57 of file sitkLabelMapContourOverlayImageFilter.h.

Member Enumeration Documentation

◆ ContourTypeType

Enumerator
PLAIN 
CONTOUR 
SLICE_CONTOUR 

Definition at line 114 of file sitkLabelMapContourOverlayImageFilter.h.

◆ PriorityType

Enumerator
HIGH_LABEL_ON_TOP 
LOW_LABEL_ON_TOP 

Definition at line 128 of file sitkLabelMapContourOverlayImageFilter.h.

Constructor & Destructor Documentation

◆ ~LabelMapContourOverlayImageFilter()

virtual itk::simple::LabelMapContourOverlayImageFilter::~LabelMapContourOverlayImageFilter ( )
virtual

Destructor

◆ LabelMapContourOverlayImageFilter()

itk::simple::LabelMapContourOverlayImageFilter::LabelMapContourOverlayImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ DualExecuteInternal()

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

◆ Execute()

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

Execute the filter on the input image

◆ GetColormap()

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

Definition at line 146 of file sitkLabelMapContourOverlayImageFilter.h.

◆ GetContourThickness()

std::vector<unsigned int> itk::simple::LabelMapContourOverlayImageFilter::GetContourThickness ( ) const
inline

Set/Get the contour thickness - 1 by default.

Definition at line 102 of file sitkLabelMapContourOverlayImageFilter.h.

◆ GetContourType()

ContourTypeType itk::simple::LabelMapContourOverlayImageFilter::GetContourType ( ) const
inline

Set/Get the overlay type - CONTOUR is used by default.

Definition at line 126 of file sitkLabelMapContourOverlayImageFilter.h.

◆ GetDilationRadius()

std::vector<unsigned int> itk::simple::LabelMapContourOverlayImageFilter::GetDilationRadius ( ) const
inline

Set/Get the object dilation radius - 0 by default.

Definition at line 92 of file sitkLabelMapContourOverlayImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 149 of file sitkLabelMapContourOverlayImageFilter.h.

◆ GetOpacity()

double itk::simple::LabelMapContourOverlayImageFilter::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 sitkLabelMapContourOverlayImageFilter.h.

◆ GetPriority()

PriorityType itk::simple::LabelMapContourOverlayImageFilter::GetPriority ( ) const
inline

Set/Get the object priority - HIGH_LABEL_ON_TOP by default.

Definition at line 138 of file sitkLabelMapContourOverlayImageFilter.h.

◆ GetSliceDimension()

unsigned int itk::simple::LabelMapContourOverlayImageFilter::GetSliceDimension ( ) const
inline

Set/Get the slice dimension - defaults to image dimension - 1.

Definition at line 112 of file sitkLabelMapContourOverlayImageFilter.h.

◆ SetColormap()

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

Definition at line 142 of file sitkLabelMapContourOverlayImageFilter.h.

◆ SetContourThickness()

Self& itk::simple::LabelMapContourOverlayImageFilter::SetContourThickness ( std::vector< unsigned int >  ContourThickness)
inline

Set/Get the contour thickness - 1 by default.

Definition at line 97 of file sitkLabelMapContourOverlayImageFilter.h.

◆ SetContourType()

Self& itk::simple::LabelMapContourOverlayImageFilter::SetContourType ( ContourTypeType  ContourType)
inline

Set/Get the overlay type - CONTOUR is used by default.

Definition at line 120 of file sitkLabelMapContourOverlayImageFilter.h.

◆ SetDilationRadius() [1/2]

Self& itk::simple::LabelMapContourOverlayImageFilter::SetDilationRadius ( std::vector< unsigned int >  DilationRadius)
inline

Set/Get the object dilation radius - 0 by default.

Definition at line 84 of file sitkLabelMapContourOverlayImageFilter.h.

◆ SetDilationRadius() [2/2]

Self& itk::simple::LabelMapContourOverlayImageFilter::SetDilationRadius ( unsigned int  value)
inline

Set the values of the DilationRadius vector all to value

Definition at line 87 of file sitkLabelMapContourOverlayImageFilter.h.

◆ SetOpacity()

Self& itk::simple::LabelMapContourOverlayImageFilter::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 sitkLabelMapContourOverlayImageFilter.h.

◆ SetPriority()

Self& itk::simple::LabelMapContourOverlayImageFilter::SetPriority ( PriorityType  Priority)
inline

Set/Get the object priority - HIGH_LABEL_ON_TOP by default.

Definition at line 133 of file sitkLabelMapContourOverlayImageFilter.h.

◆ SetSliceDimension()

Self& itk::simple::LabelMapContourOverlayImageFilter::SetSliceDimension ( unsigned int  SliceDimension)
inline

Set/Get the slice dimension - defaults to image dimension - 1.

Definition at line 107 of file sitkLabelMapContourOverlayImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::DualExecuteInternalAddressor< MemberFunctionType >

Definition at line 164 of file sitkLabelMapContourOverlayImageFilter.h.

Member Data Documentation

◆ m_Colormap

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

Definition at line 184 of file sitkLabelMapContourOverlayImageFilter.h.

◆ m_ContourThickness

std::vector<unsigned int> itk::simple::LabelMapContourOverlayImageFilter::m_ContourThickness {std::vector<unsigned int>(3, 1)}
private

Definition at line 176 of file sitkLabelMapContourOverlayImageFilter.h.

◆ m_ContourType

ContourTypeType itk::simple::LabelMapContourOverlayImageFilter::m_ContourType {itk::simple::LabelMapContourOverlayImageFilter::CONTOUR}
private

Definition at line 180 of file sitkLabelMapContourOverlayImageFilter.h.

◆ m_DilationRadius

std::vector<unsigned int> itk::simple::LabelMapContourOverlayImageFilter::m_DilationRadius {std::vector<unsigned int>(3, 1)}
private

Definition at line 174 of file sitkLabelMapContourOverlayImageFilter.h.

◆ m_DualMemberFactory

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

Definition at line 168 of file sitkLabelMapContourOverlayImageFilter.h.

◆ m_Opacity

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

Definition at line 172 of file sitkLabelMapContourOverlayImageFilter.h.

◆ m_Priority

PriorityType itk::simple::LabelMapContourOverlayImageFilter::m_Priority {itk::simple::LabelMapContourOverlayImageFilter::HIGH_LABEL_ON_TOP}
private

Definition at line 182 of file sitkLabelMapContourOverlayImageFilter.h.

◆ m_SliceDimension

unsigned int itk::simple::LabelMapContourOverlayImageFilter::m_SliceDimension {0u}
private

Definition at line 178 of file sitkLabelMapContourOverlayImageFilter.h.


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