Package org.itk.simple
Class LabelOverlayImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.LabelOverlayImageFilter
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.
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA
de Jouy-en-Josas, France.
This class was contributed to the Insight Journal https://www.insight-journal.org/browse/publication/79
See:
LabelToRGBImageFilter
LabelMapOverlayImageFilter , LabelOverlayFunctor
itk::simple::LabelOverlay for the procedural interface
itk::LabelOverlayImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkLabelOverlayImageFilter.h
-
Field Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn
-
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::LabelOverlayImageFilter::LabelOverlayImageFilter() Default Constructor that takes no arguments and initializes default parametersprotected
LabelOverlayImageFilter
(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
virtual itk::simple::LabelOverlayImageFilter::~LabelOverlayImageFilter() DestructorImage itk::simple::LabelOverlayImageFilter::Execute(Image &&image, const Image &labelImage) Execute the filter on the input imageprotected void
finalize()
double
double itk::simple::LabelOverlayImageFilter::GetBackgroundValue() const Set/Get the background value.std::vector<uint8_t> itk::simple::LabelOverlayImageFilter::GetColormap() constprotected static long
getName()
std::string itk::simple::LabelOverlayImageFilter::GetName() const Name of this classdouble
double itk::simple::LabelOverlayImageFilter::GetOpacity() const Set/Get the opacity of the colored label image.void
setBackgroundValue
(double BackgroundValue) Self& itk::simple::LabelOverlayImageFilter::SetBackgroundValue(double BackgroundValue) Set/Get the background value.void
setColormap
(VectorUInt8 Colormap) Self& itk::simple::LabelOverlayImageFilter::SetColormap(std::vector< uint8_t > Colormap)void
setOpacity
(double Opacity) Self& itk::simple::LabelOverlayImageFilter::SetOpacity(double Opacity) Set/Get the opacity of the colored label image.protected static long
toString()
std::string itk::simple::LabelOverlayImageFilter::ToString() const Print ourselves outMethods inherited from class org.itk.simple.ImageFilter
getCPtr, swigRelease
Methods inherited from class org.itk.simple.ProcessObject
abort, addCommand, debugOff, debugOn, getCPtr, getDebug, getGlobalDefaultCoordinateTolerance, getGlobalDefaultDebug, getGlobalDefaultDirectionTolerance, getGlobalDefaultNumberOfThreads, getGlobalDefaultThreader, getGlobalWarningDisplay, getNumberOfThreads, getNumberOfWorkUnits, getProgress, globalDefaultDebugOff, globalDefaultDebugOn, globalWarningDisplayOff, globalWarningDisplayOn, hasCommand, removeAllCommands, setDebug, setGlobalDefaultCoordinateTolerance, setGlobalDefaultDebug, setGlobalDefaultDirectionTolerance, setGlobalDefaultNumberOfThreads, setGlobalDefaultThreader, setGlobalWarningDisplay, setNumberOfThreads, setNumberOfWorkUnits, swigRelease
-
Constructor Details
-
LabelOverlayImageFilter
protected LabelOverlayImageFilter(long cPtr, boolean cMemoryOwn) -
LabelOverlayImageFilter
public LabelOverlayImageFilter()itk::simple::LabelOverlayImageFilter::LabelOverlayImageFilter() Default Constructor that takes no arguments and initializes default parameters
-
-
Method Details
-
getCPtr
-
swigRelease
-
finalize
protected void finalize()- Overrides:
finalize
in classImageFilter
-
delete
public void delete()virtual itk::simple::LabelOverlayImageFilter::~LabelOverlayImageFilter() Destructor- Overrides:
delete
in classImageFilter
-
setOpacity
public void setOpacity(double Opacity) Self& itk::simple::LabelOverlayImageFilter::SetOpacity(double Opacity) Set/Get the opacity of the colored label image. The value must be between 0 and 1. -
getOpacity
public double getOpacity()double itk::simple::LabelOverlayImageFilter::GetOpacity() const Set/Get the opacity of the colored label image. The value must be between 0 and 1. -
setBackgroundValue
public void setBackgroundValue(double BackgroundValue) Self& itk::simple::LabelOverlayImageFilter::SetBackgroundValue(double BackgroundValue) Set/Get the background value. -
getBackgroundValue
public double getBackgroundValue()double itk::simple::LabelOverlayImageFilter::GetBackgroundValue() const Set/Get the background value. -
setColormap
Self& itk::simple::LabelOverlayImageFilter::SetColormap(std::vector< uint8_t > Colormap) -
getColormap
std::vector<uint8_t> itk::simple::LabelOverlayImageFilter::GetColormap() const -
getName
std::string itk::simple::LabelOverlayImageFilter::GetName() const Name of this class- Overrides:
getName
in classProcessObject
-
toString
std::string itk::simple::LabelOverlayImageFilter::ToString() const Print ourselves out- Overrides:
toString
in classProcessObject
-
execute
Image itk::simple::LabelOverlayImageFilter::Execute(Image &&image, const Image &labelImage) Execute the filter on the input image
-