Class ScalarToRGBColormapImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.ScalarToRGBColormapImageFilter
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://doi.org/10.54294/tmojbk
See:
 BinaryFunctionImageFilter TernaryFunctionImageFilter
 itk::simple::ScalarToRGBColormap for the procedural interface
 itk::ScalarToRGBColormapImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkScalarToRGBColormapImageFilter.h
- 
Nested Class SummaryNested Classes
- 
Field SummaryFields inherited from class org.itk.simple.ProcessObjectswigCMemOwn
- 
Constructor SummaryConstructorsModifierConstructorDescriptionitk::simple::ScalarToRGBColormapImageFilter::ScalarToRGBColormapImageFilter() Default Constructor that takes no arguments and initializes default parametersprotectedScalarToRGBColormapImageFilter(long cPtr, boolean cMemoryOwn) 
- 
Method SummaryModifier and TypeMethodDescriptionvoiddelete()virtual itk::simple::ScalarToRGBColormapImageFilter::~ScalarToRGBColormapImageFilter() DestructorImage itk::simple::ScalarToRGBColormapImageFilter::Execute(const Image &image1) Execute the filter on the input imageprotected voidfinalize()ColormapType itk::simple::ScalarToRGBColormapImageFilter::GetColormap() const Set/Get the colormap object.protected static longgetName()std::string itk::simple::ScalarToRGBColormapImageFilter::GetName() const Name of this classbooleanbool itk::simple::ScalarToRGBColormapImageFilter::GetUseInputImageExtremaForScaling() const Set/Get UseInputImageExtremaForScaling.voidSelf& itk::simple::ScalarToRGBColormapImageFilter::SetColormap(ColormapType Colormap)voidsetUseInputImageExtremaForScaling(boolean UseInputImageExtremaForScaling) Self& itk::simple::ScalarToRGBColormapImageFilter::SetUseInputImageExtremaForScaling(bool UseInputImageExtremaForScaling) Set/Get UseInputImageExtremaForScaling.protected static longtoString()std::string itk::simple::ScalarToRGBColormapImageFilter::ToString() const Print ourselves outvoidSelf& itk::simple::ScalarToRGBColormapImageFilter::UseInputImageExtremaForScalingOff()voidSelf& itk::simple::ScalarToRGBColormapImageFilter::UseInputImageExtremaForScalingOn() Set the value of UseInputImageExtremaForScaling to true or false respectfully.Methods inherited from class org.itk.simple.ImageFiltergetCPtr, swigReleaseMethods inherited from class org.itk.simple.ProcessObjectabort, 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- 
ScalarToRGBColormapImageFilterprotected ScalarToRGBColormapImageFilter(long cPtr, boolean cMemoryOwn) 
- 
ScalarToRGBColormapImageFilterpublic ScalarToRGBColormapImageFilter()itk::simple::ScalarToRGBColormapImageFilter::ScalarToRGBColormapImageFilter() Default Constructor that takes no arguments and initializes default parameters
 
- 
- 
Method Details- 
getCPtr
- 
swigRelease
- 
finalizeprotected void finalize()- Overrides:
- finalizein class- ImageFilter
 
- 
deletepublic void delete()virtual itk::simple::ScalarToRGBColormapImageFilter::~ScalarToRGBColormapImageFilter() Destructor- Overrides:
- deletein class- ImageFilter
 
- 
setColormapSelf& itk::simple::ScalarToRGBColormapImageFilter::SetColormap(ColormapType Colormap)
- 
getColormapColormapType itk::simple::ScalarToRGBColormapImageFilter::GetColormap() const Set/Get the colormap object.
- 
setUseInputImageExtremaForScalingpublic 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.
- 
useInputImageExtremaForScalingOnpublic void useInputImageExtremaForScalingOn()Self& itk::simple::ScalarToRGBColormapImageFilter::UseInputImageExtremaForScalingOn() Set the value of UseInputImageExtremaForScaling to true or false respectfully.
- 
useInputImageExtremaForScalingOffpublic void useInputImageExtremaForScalingOff()Self& itk::simple::ScalarToRGBColormapImageFilter::UseInputImageExtremaForScalingOff()
- 
getUseInputImageExtremaForScalingpublic 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.
- 
getNamestd::string itk::simple::ScalarToRGBColormapImageFilter::GetName() const Name of this class- Overrides:
- getNamein class- ProcessObject
 
- 
toStringstd::string itk::simple::ScalarToRGBColormapImageFilter::ToString() const Print ourselves out- Overrides:
- toStringin class- ProcessObject
 
- 
execute
 
-