de.unihalle.informatik.MiToBo.color.conversion

Class RGBToHSXConverter

java.lang.Object

de.unihalle.informatik.Alida.operator.ALDOperator

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

de.unihalle.informatik.MiToBo.color.conversion.RGBToHSXConverter

All Implemented Interfaces:

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

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

Converts an image of type MTBImageRGB ( RGB color space ) into an image with HSX( hue saturation intensity/brightness/value ) color space.

The type of the resulting image is MTBImageByte MTBImageByte or MTBImageFloat MTBImageFloat . In the later case all three channels have values in the range 0..1, otherwise in the range 0..255.

There are three ways to convert an rgb-image.

1. RGB to HSI introduced by Sonka
2. RGB to HSB, pure Java Implementation
3. RGB to HSV, adapted from http://www.easyrgb.com

Author:

Tim Langhammer, Halle/Saale,

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RGBToHSXConverter.ColorChannel Supported Color Channels.
static class	RGBToHSXConverter.Mode The way of converting an image from rgb to hsi.

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 int	BLUE_COMPONENT_INDEX
static float	BYTE_TO_DEGREE Constants to convert from [0-255] to [0-359] and vice versa.
private boolean	createFloatImage Create byte or float image
static float	DEGREE_TO_BYTE
private static int	GREEN_COMPONENT_INDEX
private static int	HUE_COMPONENT_INDEX
static float	HUE_UNDEFINED
private MTBImage	hueMTBImg Hue channel image.
private MTBImageRGB	inputMTBImageRGB Input Image.
private RGBToHSXConverter.Mode	mode Converter mode/algorithm
private static int	RED_COMPONENT_INDEX
private MTBImage	resultMTBImg Result Image.
private MTBImage	satMTBImg Saturation channel image.
private static int	SATURATION_COMPONENT_INDEX
static float	SATURATION_UNDEFINED To cope with undefined saturation/hue-values, we use the following scheme.
private int	THREE_COMPONENTS_COLOR_SPACE
private static int	X_COMPONENT_INDEX
private MTBImage	xMTBImg Result Image.

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

completeDAG, name, operatorExecutionEventlistenerList, portHashAccess, verbose, versionProvider

Constructor Summary

Constructors

Constructor and Description
RGBToHSXConverter() Default constructor.
RGBToHSXConverter(MTBImageRGB image) Constructor.

Method Summary

Modifier and Type	Method and Description
MTBImage	getHueMTBImg() Get the hue channel image.
MTBImageRGB	getInputMTBImgRGB() Returns the input image, null if not set.
MTBImage	getResultMTBImage() Returns the converted image, null if not available.
MTBImage	getSatMTBImg() Get the saturation channel image.
MTBImage	getXMTBImg() Get the value channel image.
static boolean	isHueUndefined(float saturation) Return true if the hue channel is undefined which is true is saturation is zero or undefined which in turn is encoded as zero.
static boolean	isHueUndefined(int saturation) Return true if the hue channel is undefined which is true is saturation is zero or undefined which in turn is encoded as zero.
static boolean	isSaturationUndefined(float xValue) Return true if the saturation channel is undefined which is true if the x channel is zero.
static boolean	isSaturationUndefined(int xValue) Return true if the saturation channel is undefined which is true if the x channel is zero.
protected void	operate() Creates a MTBImage with three channels, the same size as the original one and converts each rgb pixel to a hsx pixel, where x stands for Inentsity or Brightness or Value depending on the mode set.
private float[]	rgbToHSB_JRE(int[] rgbColor) Conversion from RGB into HSB color space.
private float[]	rgbToHSI_Sonka(int[] rgbColor) Conversion from RGB to HSI color space according to Sonka et al.
private float[]	rgbToHSV_EasyRGB(int[] rgbColor) Conversion from RGB into HSV color space.
void	setHueMTBImg(MTBImage hueChannelImage) Set the hue channel image.
void	setInputMTBImgRGB(MTBImageRGB inputImage) Set the input image.
void	setSatMTBImg(MTBImage saturationChannelImage) Set the saturation channel image.
void	setXMTBImg(MTBImage valueChannelImage) Set the value channel image.

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, validateCustom, validateGeneric, writeHistory, writeHistory, writeHistory

Methods inherited from class java.lang.Object

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

Field Detail

BYTE_TO_DEGREE

public static final float BYTE_TO_DEGREE

Constants to convert from [0-255] to [0-359] and vice versa.

See Also:

Constant Field Values

DEGREE_TO_BYTE

public static final float DEGREE_TO_BYTE

See Also:

Constant Field Values

THREE_COMPONENTS_COLOR_SPACE

private final int THREE_COMPONENTS_COLOR_SPACE

See Also:

Constant Field Values

RED_COMPONENT_INDEX

private static final int RED_COMPONENT_INDEX

See Also:

Constant Field Values

GREEN_COMPONENT_INDEX

private static final int GREEN_COMPONENT_INDEX

See Also:

Constant Field Values

BLUE_COMPONENT_INDEX

private static final int BLUE_COMPONENT_INDEX

See Also:

Constant Field Values

HUE_COMPONENT_INDEX

private static final int HUE_COMPONENT_INDEX

See Also:

Constant Field Values

SATURATION_COMPONENT_INDEX

private static final int SATURATION_COMPONENT_INDEX

See Also:

Constant Field Values

X_COMPONENT_INDEX

private static final int X_COMPONENT_INDEX

See Also:

Constant Field Values

SATURATION_UNDEFINED

public static final float SATURATION_UNDEFINED

To cope with undefined saturation/hue-values, we use the following scheme. If x component equals zero then saturation and hue are undefined. We set them to UNDEFINED defined as zero. If saturation is zero, then hue is undefined (and set to UNDEFINED defined as zero).

See Also:

Constant Field Values

HUE_UNDEFINED

public static final float HUE_UNDEFINED

See Also:

Constant Field Values

inputMTBImageRGB

@Parameter(label="Input Image",
           required=true,
           dataIOOrder=0,
           direction=IN,
           description="Input RGB-image")
private transient MTBImageRGB inputMTBImageRGB

Input Image.

Should be of type MTBImageRGB.

mode

@Parameter(label="Algorithm used",
           required=true,
           dataIOOrder=1,
           direction=IN,
           description="The algorithm used")
private RGBToHSXConverter.Mode mode

Converter mode/algorithm

createFloatImage

@Parameter(label="Create float image",
           required=true,
           dataIOOrder=1,
           direction=IN,
           description="If true a float image is created, otherwise a byte image")
private boolean createFloatImage

Create byte or float image

resultMTBImg

@Parameter(label="Result Image",
           required=true,
           direction=OUT,
           dataIOOrder=-1,
           description="Result image (HSX color space)")
private transient MTBImage resultMTBImg

Result Image.

The result image is a MTBImage.

hueMTBImg

@Parameter(label="Hue channel Image",
           required=true,
           direction=OUT,
           dataIOOrder=-2,
           description="Hue-channel image")
private transient MTBImage hueMTBImg

Hue channel image.

The hue channel image is a MTBImage.

satMTBImg

@Parameter(label="Saturation channel Image",
           required=true,
           direction=OUT,
           dataIOOrder=-4,
           description="Saturation-channel image")
private transient MTBImage satMTBImg

Saturation channel image.

The result image is a MTBImage.

xMTBImg

@Parameter(label="X channel Image",
           required=true,
           direction=OUT,
           dataIOOrder=-8,
           description="Wheather I or V/B-channel image")
private transient MTBImage xMTBImg

Result Image.

The result image is a MTBImage.

Constructor Detail

RGBToHSXConverter

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

Default constructor.

Throws:

de.unihalle.informatik.Alida.exceptions.ALDOperatorException

RGBToHSXConverter

public RGBToHSXConverter(MTBImageRGB image)
                  throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException

Constructor.

Parameters:

image - The input image.

Throws:

de.unihalle.informatik.Alida.exceptions.ALDOperatorException

Method Detail

getResultMTBImage

public MTBImage getResultMTBImage()

Returns the converted image, null if not available.

Returns:

The result image or null if not set.

getInputMTBImgRGB

public MTBImageRGB getInputMTBImgRGB()

Returns the input image, null if not set.

Returns:

The input image or null if not set.

setInputMTBImgRGB

public void setInputMTBImgRGB(MTBImageRGB inputImage)

Set the input image.

Parameters:

inputImage - The input image.

getHueMTBImg

public MTBImage getHueMTBImg()

Get the hue channel image.

Returns:

The image which contains the hue channel informations of * * type MTBImage.

getSatMTBImg

public MTBImage getSatMTBImg()

Get the saturation channel image.

Returns:

The image which contains the saturation channel informations of type MTBImage.

getXMTBImg

public MTBImage getXMTBImg()

Get the value channel image.

Returns:

The image which contains the value channel informations of * * type MTBImage.

setHueMTBImg

public void setHueMTBImg(MTBImage hueChannelImage)

Set the hue channel image.

Parameters:

hueChannelImage - The image which contains the hue channel informations of type MTBImage.

setSatMTBImg

public void setSatMTBImg(MTBImage saturationChannelImage)

Set the saturation channel image.

Parameters:

saturationChannelImage - The image which contains the saturation channel informations of * * type MTBImage.

setXMTBImg

public void setXMTBImg(MTBImage valueChannelImage)

Set the value channel image.

Parameters:

valueChannelImage - The image which contains the value channel informations of type MTBImage.

operate

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

Creates a MTBImage with three channels, the same size as the original one and converts each rgb pixel to a hsx pixel, where x stands for Inentsity or Brightness or Value depending on the mode set.

Specified by:

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

Throws:

de.unihalle.informatik.Alida.exceptions.ALDOperatorException

de.unihalle.informatik.Alida.exceptions.ALDProcessingDAGException

rgbToHSI_Sonka

private float[] rgbToHSI_Sonka(int[] rgbColor)

Conversion from RGB to HSI color space according to Sonka et al.

Parameters:

rgbColor - The array of red/green/blue-parts as ints.

Returns:

The array of float containing the hue/saturation/intensity-parts in the range 0.0 : 1.0.

rgbToHSB_JRE

private float[] rgbToHSB_JRE(int[] rgbColor)

Conversion from RGB into HSB color space.

This method simply calls the RGBtoHSB method containing in the jre, in the java.awt.Color-class.

Parameters:

rgbColor - The array of red/green/blue-parts as ints.

Returns:

The array of float containing the hue/saturation/brightness-parts in the range 0.0 : 1.0.

See Also:

Color.RGBtoHSB(int, int, int, float[])

rgbToHSV_EasyRGB

private float[] rgbToHSV_EasyRGB(int[] rgbColor)

Conversion from RGB into HSV color space.

Code modified from : Easy RGB. A short description of the hsv/hsb colorspace : Wikipedia.

Parameters:

rgbColor - The array of red/green/blue-parts as ints.

Returns:

The array of float containing the hue/saturation/value-parts in the range 0.0 : 1.0.

isHueUndefined

public static final boolean isHueUndefined(float saturation)

Return true if the hue channel is undefined which is true is saturation is zero or undefined which in turn is encoded as zero.

Parameters:

saturation -

Returns:

isSaturationUndefined

public static final boolean isSaturationUndefined(float xValue)

Return true if the saturation channel is undefined which is true if the x channel is zero.

Parameters:

xValue -

Returns:

isHueUndefined

public static final boolean isHueUndefined(int saturation)

Return true if the hue channel is undefined which is true is saturation is zero or undefined which in turn is encoded as zero.

Parameters:

saturation -

Returns:

isSaturationUndefined

public static final boolean isSaturationUndefined(int xValue)

Return true if the saturation channel is undefined which is true if the x channel is zero.

Parameters:

xValue -

Returns: