Class ScalarToRGBColormapImageFilter

java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.ScalarToRGBColormapImageFilter

public class ScalarToRGBColormapImageFilter extends ImageFilter
Implements pixel-wise intensity->rgb mapping operation on one image. This class is parameterized over the type of the input image and the type of the output image. The input image's scalar pixel values are mapped into a color map. The color map is specified by passing the SetColormap function one of the predefined maps. The following selects the "RGBColormapFilterEnum::Hot" colormap: You can also specify a custom color map. This is done by creating a CustomColormapFunction, and then creating lists of values for the red, green, and blue channel. An example of setting the red channel of a colormap with only 2 colors is given below. The blue and green channels should be specified in the same manner. The range of values present in the input image is the range that is mapped to the entire range of colors. This code was contributed in the Insight Journal paper: "Meeting Andy Warhol Somewhere Over the Rainbow: RGB Colormapping and ITK" by Tustison N., Zhang H., Lehmann G., Yushkevich P., Gee J. https://www.insight-journal.org/browse/publication/285 See: BinaryFunctionImageFilter TernaryFunctionImageFilter itk::simple::ScalarToRGBColormap for the procedural interface itk::ScalarToRGBColormapImageFilter for the Doxygen on the original ITK class. C++ includes: sitkScalarToRGBColormapImageFilter.h
  • Constructor Details

    • ScalarToRGBColormapImageFilter

      protected ScalarToRGBColormapImageFilter(long cPtr, boolean cMemoryOwn)
    • ScalarToRGBColormapImageFilter

      public ScalarToRGBColormapImageFilter()
      itk::simple::ScalarToRGBColormapImageFilter::ScalarToRGBColormapImageFilter() Default Constructor that takes no arguments and initializes default parameters
  • Method Details

    • getCPtr

      protected static long getCPtr(ScalarToRGBColormapImageFilter obj)
    • swigRelease

      protected static long swigRelease(ScalarToRGBColormapImageFilter obj)
    • finalize

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

      public void delete()
      virtual itk::simple::ScalarToRGBColormapImageFilter::~ScalarToRGBColormapImageFilter() Destructor
      Overrides:
      delete in class ImageFilter
    • setColormap

      public void setColormap(ScalarToRGBColormapImageFilter.ColormapType Colormap)
      Self& itk::simple::ScalarToRGBColormapImageFilter::SetColormap(ColormapType Colormap)
    • getColormap

      ColormapType itk::simple::ScalarToRGBColormapImageFilter::GetColormap() const Set/Get the colormap object.
    • setUseInputImageExtremaForScaling

      public void setUseInputImageExtremaForScaling(boolean UseInputImageExtremaForScaling)
      Self& itk::simple::ScalarToRGBColormapImageFilter::SetUseInputImageExtremaForScaling(bool UseInputImageExtremaForScaling) Set/Get UseInputImageExtremaForScaling. If true, the colormap uses the min and max values from the image to scale appropriately. Otherwise, these values can be set in the colormap manually.
    • useInputImageExtremaForScalingOn

      public void useInputImageExtremaForScalingOn()
      Self& itk::simple::ScalarToRGBColormapImageFilter::UseInputImageExtremaForScalingOn() Set the value of UseInputImageExtremaForScaling to true or false respectfully.
    • useInputImageExtremaForScalingOff

      public void useInputImageExtremaForScalingOff()
      Self& itk::simple::ScalarToRGBColormapImageFilter::UseInputImageExtremaForScalingOff()
    • getUseInputImageExtremaForScaling

      public boolean getUseInputImageExtremaForScaling()
      bool itk::simple::ScalarToRGBColormapImageFilter::GetUseInputImageExtremaForScaling() const Set/Get UseInputImageExtremaForScaling. If true, the colormap uses the min and max values from the image to scale appropriately. Otherwise, these values can be set in the colormap manually.
    • getName

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

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

      public Image execute(Image image1)
      Image itk::simple::ScalarToRGBColormapImageFilter::Execute(const Image &image1) Execute the filter on the input image