SimpleITK
2.1.0
|
Apply a colormap to a label image and put it on top of the input image. More...
#include <sitkLabelOverlayImageFilter.h>
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_t > | GetColormap () const |
std::string | GetName () const |
double | GetOpacity () const |
LabelOverlayImageFilter () | |
Self & | SetBackgroundValue (double BackgroundValue) |
Self & | SetColormap (std::vector< uint8_t > Colormap) |
Self & | SetOpacity (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_t > | m_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::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 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.
This class was contributed to the Insight Journal https://hdl.handle.net/1926/172
Definition at line 53 of file sitkLabelOverlayImageFilter.h.
|
private |
Setup for member function dispatching
Definition at line 113 of file sitkLabelOverlayImageFilter.h.
Define the pixels types supported by this filter
Definition at line 65 of file sitkLabelOverlayImageFilter.h.
Definition at line 55 of file sitkLabelOverlayImageFilter.h.
|
virtual |
Destructor
itk::simple::LabelOverlayImageFilter::LabelOverlayImageFilter | ( | ) |
Default Constructor that takes no arguments and initializes default parameters
|
private |
Image itk::simple::LabelOverlayImageFilter::Execute | ( | const Image & | image, |
const Image & | labelImage | ||
) |
Execute the filter on the input image
|
inline |
Set/Get the background value
Definition at line 87 of file sitkLabelOverlayImageFilter.h.
|
inline |
Definition at line 95 of file sitkLabelOverlayImageFilter.h.
|
inlinevirtual |
Name of this class
Implements itk::simple::ProcessObject.
Definition at line 98 of file sitkLabelOverlayImageFilter.h.
|
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.
|
inline |
Set/Get the background value
Definition at line 82 of file sitkLabelOverlayImageFilter.h.
Definition at line 91 of file sitkLabelOverlayImageFilter.h.
|
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.
|
virtual |
Print ourselves out
Reimplemented from itk::simple::ProcessObject.
|
friend |
Definition at line 115 of file sitkLabelOverlayImageFilter.h.
|
private |
Definition at line 126 of file sitkLabelOverlayImageFilter.h.
|
private |
Definition at line 128 of file sitkLabelOverlayImageFilter.h.
|
private |
Definition at line 119 of file sitkLabelOverlayImageFilter.h.
|
private |
Definition at line 131 of file sitkLabelOverlayImageFilter.h.
|
private |
Definition at line 124 of file sitkLabelOverlayImageFilter.h.