de.unihalle.informatik.MiToBo.visualization.colormappings

Class GrayscaleImageToHeatmap

java.lang.Object

de.unihalle.informatik.Alida.operator.ALDOperator

de.unihalle.informatik.MiToBo.core.operator.MTBOperator

de.unihalle.informatik.MiToBo.visualization.colormappings.GrayscaleImageToHeatmap

All Implemented Interfaces:

de.unihalle.informatik.Alida.datatypes.ALDConfigurationValidator, de.unihalle.informatik.Alida.operator.events.ALDOperatorExecutionProgressEventListener, EventListener

@ALDAOperator(genericExecutionMode=ALL,
              level=APPLICATION)
public class GrayscaleImageToHeatmap
extends MTBOperator

This operator converts a gray-scale image to a heat map image.

The given minimal value is mapped to the range minimum color, the given maximal value to the range maximum color. All gray values in between are mapped by linear interpolation between both colors.
Values which are smaller than the range minimum or larger than the maximum are by default mapped to the minimal and maximal colors, respectively. If they should be handled differently this can be configured using outOfRangeValueMode.

Author:

moeller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GrayscaleImageToHeatmap.OperationMode Operation mode of the operator.
static class	GrayscaleImageToHeatmap.OutOfRangeValuesHandlingMode Available modes how to handle values out of range.

Nested classes/interfaces inherited from class de.unihalle.informatik.Alida.operator.ALDOperator

de.unihalle.informatik.Alida.operator.ALDOperator.HidingMode, de.unihalle.informatik.Alida.operator.ALDOperator.HistoryConstructionMode

Field Summary

Fields

Modifier and Type	Field and Description
private static String	classID Class identifier.
protected MTBImageByte	ignoreMask Optional binary mask of additional pixels to ignore.
private de.unihalle.informatik.Alida.datatypes.ALDDirectoryString	inDir Input directory.
protected MTBImage	inputImg Input image.
protected Color	maxColor Color for maximal value.
protected Color	minColor Color for minimal value.
GrayscaleImageToHeatmap.OperationMode	opMode Mode of operation of the operator.
protected GrayscaleImageToHeatmap.OutOfRangeValuesHandlingMode	outOfRangeValueMode Mode how to handle values out of range and masked pixels.
protected double	rangeMax Maximum value of mapping range, will be mapped to second color.
protected double	rangeMin Minimum value of mapping range, will be mapped to first color.
private MTBImageRGB	resultImg Generated result image.

Fields inherited from class de.unihalle.informatik.Alida.operator.ALDOperator

completeDAG, name, operatorExecutionEventlistenerList, portHashAccess, verbose, versionProvider

Constructor Summary

Constructors

Constructor and Description
GrayscaleImageToHeatmap() Default constructor.

Method Summary

Modifier and Type	Method and Description
MTBImageRGB	getHeatmapImage() Returns the result color heat map.
protected void	operate() This method does the actual work.
protected MTBImageRGB	processImage(MTBImage img, double rmin, double rmax) Convert a single image to a heatmap.
void	setColorRangeMaximum(Color c) Color for range maximum.
void	setColorRangeMinimum(Color c) Color for range minimum.
void	setIgnoreMask(MTBImageByte bImg) Specfiy additional mask of pixels to ignore.
void	setInputImage(MTBImage inimg) Set input image.
void	setOutOfRangeValueHandlingMode(GrayscaleImageToHeatmap.OutOfRangeValuesHandlingMode m) Specify how to handle values out of range.
void	setRangeMaximum(double maxval) Specify maximum of heat map range.
void	setRangeMinimum(double minval) Specify minimum of heat map range.
private void	switchOpModeParameters() Callback routine to change operator mode parameters.
void	validateCustom()

Methods inherited from class de.unihalle.informatik.MiToBo.core.operator.MTBOperator

readResolve

Methods inherited from class de.unihalle.informatik.Alida.operator.ALDOperator

addOperatorExecutionProgressEventListener, addParameter, addParameter, addParameterUnconditioned, fieldContained, fireOperatorExecutionProgressEvent, getALDPortHashAccessKey, getConstructionMode, getDocumentation, getHidingMode, getInactiveParameterNames, getInInoutNames, getInInoutNames, getInNames, getInOutNames, getMissingRequiredInputs, getName, getNumParameters, getOutInoutNames, getOutNames, getParameter, getParameterDescriptor, getParameterDescriptorUnconditioned, getParameterNames, getParameterUnconditioned, getSupplementalNames, getVerbose, getVersion, handleOperatorExecutionProgressEvent, hasInOutParameters, hasParameter, isAnnotatedParameter, isConfigured, print, print, print, printInterface, printInterface, readHistory, reinitializeParameterDescriptors, removeOperatorExecutionProgressEventListener, removeParameter, runOp, runOp, runOp, setConstructionMode, setConstructionMode, setConstructionMode, setHidingMode, setName, setParameter, setParameterUnconditioned, setVerbose, toStringVerbose, unconfiguredItems, validate, validateGeneric, writeHistory, writeHistory, writeHistory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

classID

private static final String classID

Class identifier.

See Also:

Constant Field Values

opMode

@Parameter(label="Operation Mode",
           required=true,
           direction=IN,
           dataIOOrder=-5,
           description="Operation mode of the operator.",
           callback="switchOpModeParameters",
           paramModificationMode=MODIFIES_INTERFACE)
public GrayscaleImageToHeatmap.OperationMode opMode

Mode of operation of the operator.

inputImg

@Parameter(label="Input Image",
           required=true,
           dataIOOrder=1,
           direction=IN,
           description="Input image.")
protected MTBImage inputImg

Input image.

inDir

@Parameter(label="Input Directory",
           required=true,
           direction=IN,
           description="Input directory.",
           dataIOOrder=1)
private de.unihalle.informatik.Alida.datatypes.ALDDirectoryString inDir

Input directory.

rangeMin

@Parameter(label="Range Minimum",
           required=true,
           dataIOOrder=2,
           direction=IN,
           description="Minimum value to map, if NaN minimum image value is used.")
protected double rangeMin

Minimum value of mapping range, will be mapped to first color.

minColor

@Parameter(label="Color of Range Minimum",
           required=true,
           dataIOOrder=3,
           direction=IN,
           description="Color of small values.")
protected Color minColor

Color for minimal value.

rangeMax

@Parameter(label="Range Maximum",
           required=true,
           dataIOOrder=4,
           direction=IN,
           description="Maximum value to map, if NaN maximum image value is used.")
protected double rangeMax

Maximum value of mapping range, will be mapped to second color.

maxColor

@Parameter(label="Color of Range Maximum",
           required=true,
           dataIOOrder=5,
           direction=IN,
           description="Color of large values.")
protected Color maxColor

Color for maximal value.

outOfRangeValueMode

@Parameter(label="How to handle values out of range?",
           required=true,
           dataIOOrder=6,
           direction=IN,
           description="Mode how values out of range are treated.")
protected GrayscaleImageToHeatmap.OutOfRangeValuesHandlingMode outOfRangeValueMode

Mode how to handle values out of range and masked pixels.

ignoreMask

@Parameter(label="Ignore mask?",
           required=false,
           dataIOOrder=1,
           direction=IN,
           description="Ignore mask, pixels with values > 0 are ignored.")
protected MTBImageByte ignoreMask

Optional binary mask of additional pixels to ignore.

Pixels marked white are ignored, i.e. mapped to black or left untouched.

resultImg

@Parameter(label="Result Image",
           dataIOOrder=0,
           direction=OUT,
           description="Resulting RGB image.")
private transient MTBImageRGB resultImg

Generated result image.

Constructor Detail

GrayscaleImageToHeatmap

public GrayscaleImageToHeatmap()
                        throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException

Default constructor.

Throws:

de.unihalle.informatik.Alida.exceptions.ALDOperatorException - Thrown in case of failure.

Method Detail

switchOpModeParameters

private void switchOpModeParameters()

Callback routine to change operator mode parameters.

getHeatmapImage

public MTBImageRGB getHeatmapImage()

Returns the result color heat map.

Returns:

RGB image containing heat map.

setInputImage

public void setInputImage(MTBImage inimg)

Set input image.

Parameters:

inimg - Input grayscale image.

setRangeMinimum

public void setRangeMinimum(double minval)

Specify minimum of heat map range.

Parameters:

minval - Range minimum.

setColorRangeMinimum

public void setColorRangeMinimum(Color c)

Color for range minimum.

Parameters:

c - Color to use.

setRangeMaximum

public void setRangeMaximum(double maxval)

Specify maximum of heat map range.

Parameters:

maxval - Range maximum.

setColorRangeMaximum

public void setColorRangeMaximum(Color c)

Color for range maximum.

Parameters:

c - Color to use.

setOutOfRangeValueHandlingMode

public void setOutOfRangeValueHandlingMode(GrayscaleImageToHeatmap.OutOfRangeValuesHandlingMode m)

Specify how to handle values out of range.

Parameters:

m - Handling mode.

setIgnoreMask

public void setIgnoreMask(MTBImageByte bImg)

Specfiy additional mask of pixels to ignore.

Parameters:

bImg - Binary mask.

validateCustom

public void validateCustom()
                    throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException

Overrides:

validateCustom in class de.unihalle.informatik.Alida.operator.ALDOperator

Throws:

de.unihalle.informatik.Alida.exceptions.ALDOperatorException

operate

protected void operate()
                throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException,
                       de.unihalle.informatik.Alida.exceptions.ALDProcessingDAGException

This method does the actual work.

Specified by:

operate in class de.unihalle.informatik.Alida.operator.ALDOperator

Throws:

de.unihalle.informatik.Alida.exceptions.ALDOperatorException - Thrown in case of failure.

de.unihalle.informatik.Alida.exceptions.ALDProcessingDAGException - Thrown in case of failure.

processImage

protected MTBImageRGB processImage(MTBImage img,
                                   double rmin,
                                   double rmax)

Convert a single image to a heatmap.

Parameters:

img - Image to convert.

rmin - Minimum range value to map on minimum color.

rmax - Maximum range value to map on maximum color.

Returns:

RGB heatmap image.