SimpleITK
2.1.0
|
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>
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_t > | GetColormap () 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 () | |
Self & | SetColormap (std::vector< uint8_t > Colormap) |
Self & | SetContourThickness (std::vector< unsigned int > ContourThickness) |
Self & | SetContourType (ContourTypeType ContourType) |
Self & | SetDilationRadius (std::vector< unsigned int > DilationRadius) |
Self & | SetDilationRadius (unsigned int value) |
Self & | SetOpacity (double Opacity) |
Self & | SetPriority (PriorityType Priority) |
Self & | SetSliceDimension (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_t > | m_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::ProcessObject * | GetActiveProcess () |
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 | |
NonCopyable & | operator= (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::EventObject & | GetITKEventObject (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) |
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.
This implementation was taken from the Insight Journal paper: https://hdl.handle.net/1926/584 or http://www.insight-journal.org/browse/publication/176
Definition at line 55 of file sitkLabelMapContourOverlayImageFilter.h.
|
private |
Setup for member function dispatching
Definition at line 162 of file sitkLabelMapContourOverlayImageFilter.h.
Define the pixels types supported by this filter
Definition at line 67 of file sitkLabelMapContourOverlayImageFilter.h.
Definition at line 57 of file sitkLabelMapContourOverlayImageFilter.h.
Enumerator | |
---|---|
PLAIN | |
CONTOUR | |
SLICE_CONTOUR |
Definition at line 114 of file sitkLabelMapContourOverlayImageFilter.h.
Enumerator | |
---|---|
HIGH_LABEL_ON_TOP | |
LOW_LABEL_ON_TOP |
Definition at line 128 of file sitkLabelMapContourOverlayImageFilter.h.
|
virtual |
Destructor
itk::simple::LabelMapContourOverlayImageFilter::LabelMapContourOverlayImageFilter | ( | ) |
Default Constructor that takes no arguments and initializes default parameters
|
private |
Image itk::simple::LabelMapContourOverlayImageFilter::Execute | ( | const Image & | labelMapImage, |
const Image & | featureImage | ||
) |
Execute the filter on the input image
|
inline |
Definition at line 146 of file sitkLabelMapContourOverlayImageFilter.h.
|
inline |
Set/Get the contour thickness - 1 by default.
Definition at line 102 of file sitkLabelMapContourOverlayImageFilter.h.
|
inline |
Set/Get the overlay type - CONTOUR is used by default.
Definition at line 126 of file sitkLabelMapContourOverlayImageFilter.h.
|
inline |
Set/Get the object dilation radius - 0 by default.
Definition at line 92 of file sitkLabelMapContourOverlayImageFilter.h.
|
inlinevirtual |
Name of this class
Implements itk::simple::ProcessObject.
Definition at line 149 of file sitkLabelMapContourOverlayImageFilter.h.
|
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.
|
inline |
Set/Get the object priority - HIGH_LABEL_ON_TOP by default.
Definition at line 138 of file sitkLabelMapContourOverlayImageFilter.h.
|
inline |
Set/Get the slice dimension - defaults to image dimension - 1.
Definition at line 112 of file sitkLabelMapContourOverlayImageFilter.h.
|
inline |
Definition at line 142 of file sitkLabelMapContourOverlayImageFilter.h.
|
inline |
Set/Get the contour thickness - 1 by default.
Definition at line 97 of file sitkLabelMapContourOverlayImageFilter.h.
|
inline |
Set/Get the overlay type - CONTOUR is used by default.
Definition at line 120 of file sitkLabelMapContourOverlayImageFilter.h.
|
inline |
Set/Get the object dilation radius - 0 by default.
Definition at line 84 of file sitkLabelMapContourOverlayImageFilter.h.
|
inline |
Set the values of the DilationRadius vector all to value
Definition at line 87 of file sitkLabelMapContourOverlayImageFilter.h.
|
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.
|
inline |
Set/Get the object priority - HIGH_LABEL_ON_TOP by default.
Definition at line 133 of file sitkLabelMapContourOverlayImageFilter.h.
|
inline |
Set/Get the slice dimension - defaults to image dimension - 1.
Definition at line 107 of file sitkLabelMapContourOverlayImageFilter.h.
|
virtual |
Print ourselves out
Reimplemented from itk::simple::ProcessObject.
|
friend |
Definition at line 164 of file sitkLabelMapContourOverlayImageFilter.h.
|
private |
Definition at line 184 of file sitkLabelMapContourOverlayImageFilter.h.
|
private |
Definition at line 176 of file sitkLabelMapContourOverlayImageFilter.h.
|
private |
Definition at line 180 of file sitkLabelMapContourOverlayImageFilter.h.
|
private |
Definition at line 174 of file sitkLabelMapContourOverlayImageFilter.h.
|
private |
Definition at line 168 of file sitkLabelMapContourOverlayImageFilter.h.
|
private |
Definition at line 172 of file sitkLabelMapContourOverlayImageFilter.h.
|
private |
Definition at line 182 of file sitkLabelMapContourOverlayImageFilter.h.
|
private |
Definition at line 178 of file sitkLabelMapContourOverlayImageFilter.h.