Class LabelOverlayImageFilter


public class LabelOverlayImageFilter extends ImageFilter
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
  • 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

      protected static long getCPtr(LabelOverlayImageFilter obj)
    • swigRelease

      protected static long swigRelease(LabelOverlayImageFilter obj)
    • finalize

      protected void finalize()
      Overrides:
      finalize in class ImageFilter
    • delete

      public void delete()
      virtual itk::simple::LabelOverlayImageFilter::~LabelOverlayImageFilter() Destructor
      Overrides:
      delete in class ImageFilter
    • 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

      public void setColormap(VectorUInt8 Colormap)
      Self& itk::simple::LabelOverlayImageFilter::SetColormap(std::vector< uint8_t > Colormap)
    • getColormap

      public VectorUInt8 getColormap()
      std::vector<uint8_t> itk::simple::LabelOverlayImageFilter::GetColormap() const
    • getName

      public String getName()
      std::string itk::simple::LabelOverlayImageFilter::GetName() const Name of this class
      Overrides:
      getName in class ProcessObject
    • toString

      public String toString()
      std::string itk::simple::LabelOverlayImageFilter::ToString() const Print ourselves out
      Overrides:
      toString in class ProcessObject
    • execute

      public Image execute(Image image, Image labelImage)
      Image itk::simple::LabelOverlayImageFilter::Execute(Image &&image, const Image &labelImage) Execute the filter on the input image