de.unihalle.informatik.MiToBo.segmentation.regions.labeling

Class LabelComponentsSequential

java.lang.Object

de.unihalle.informatik.Alida.operator.ALDOperator

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

de.unihalle.informatik.MiToBo.segmentation.regions.labeling.LabelComponentsSequential

All Implemented Interfaces:

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

@ALDAOperator(genericExecutionMode=ALL,
              level=APPLICATION,
              shortDescription="Sequential component labeling for binarized 2D images.")
public class LabelComponentsSequential
extends MTBOperator

Sequential component labeling for binarized 2D images to find connected components. Foreground pixels are assumed to have a value > 0, all pixels with value <= 0 are assumed to be background. Algorithm:
W. Burger and M. Burge, Digital image processing: an algorithmic introduction using Java, 2008, Springer-Verlag New York Inc

Author:

gress

Nested Class Summary

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 MTBImage	colorImage Image of regions in random colors.
private Boolean	createColorImage Flag to enable/disable creation of region image in random colors.
private Boolean	createIDImage Flag to enable/disable creation of gray-scale image with region IDs.
private Boolean	createLabelImage Flag to enable/disable creation of gray-scale label image.
private boolean	diagonalNeighbors Flag to define 4-/8-neighborhood in components.
private MTBImage	idImage Gray-scale image with IDs printed to regions.
private MTBImage	inputImage Input image to label.
private MTBImage	labelImage Grayscale image of regions, gray values are identical to IDs.
private int	m_height Height of input image.
private MTBImageInt	m_labelImg Temporary label image.
private int	m_width Width of input image.
private MTBRegion2DSet	resultingRegions Resulting set of labeled regions.

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

completeDAG, name, operatorExecutionEventlistenerList, portHashAccess, verbose, versionProvider

Constructor Summary

Constructors

Constructor and Description
LabelComponentsSequential() Constructor.
LabelComponentsSequential(MTBImage img, boolean dn) Constructor.

Method Summary

Modifier and Type	Method and Description
protected static MTBImage	drawStringToImage(MTBImage labelImage2, String s, int xPos, int yPos) Draws string at given position into image.
MTBImage	getColorImage() Get image of randomly colored regions, if the create-color-image-flag was set to true.
boolean	getCreateColorImageFlag() Get the flag that determines the creation of an image with randomly colored regions.
boolean	getCreateLabelImageFlag() Get the flag that determines the creation of an image with region labels.
boolean	getDiagonalNeighborsFlag() Get the neighborhood flag.
String	getDocumentation()
MTBImage	getIDImage() Get image of region ID (of type MTB_BYTE).
MTBImage	getInputImage() Get reference to the current input image.
private int	getLabel(int x, int y) returns the value of labelImg at position (x,y).
MTBImage	getLabelImage() Get image of region labels (of type MTB_INT).
MTBRegion2DSet	getResultingRegions() Get the resulting regions.
protected MTBRegion2DSet	labelComponents(MTBImage img, boolean diagonalNeighbors) Sequential component labeling
protected void	operate()
protected void	setColorImage(MTBImage colorImage) Add the label image to the parameter object
void	setCreateColorImageFlag(boolean createColorImage) Set the flag that determines the creation of an image with randomly colored regions.
void	setCreateIDImageFlag(boolean b) Enable/disable creation of ID image.
void	setCreateLabelImageFlag(boolean createLabelImage) Set the flag that determines the creation of an image with region labels.
void	setDiagonalNeighborsFlag(boolean diagonalNeighbors) Set the neighborhood flag.
void	setInputImage(MTBImage iImage) Set a new input image.
protected void	setLabelImage(MTBImage labelImage) Set image of region labels
protected void	setResultingRegions(MTBRegion2DSet regions) Attach the vector of resulting regions.

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, 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

inputImage

@Parameter(label="Input image",
           required=true,
           direction=IN,
           dataIOOrder=0,
           mode=STANDARD,
           description="Input image")
private transient MTBImage inputImage

Input image to label.

diagonalNeighbors

@Parameter(label="Diagonal neighborhood",
           required=true,
           direction=IN,
           dataIOOrder=1,
           mode=STANDARD,
           description="true for 8-neighborhood, false for 4-neighborhood")
private boolean diagonalNeighbors

Flag to define 4-/8-neighborhood in components.

createLabelImage

@Parameter(label="Create label image",
           required=true,
           direction=IN,
           dataIOOrder=2,
           mode=STANDARD,
           description="Create image of regions with region labels as grayvalue.")
private Boolean createLabelImage

Flag to enable/disable creation of gray-scale label image.

createIDImage

@Parameter(label="Create image with ID strings",
           required=true,
           direction=IN,
           dataIOOrder=3,
           mode=STANDARD,
           description="Create image of regions with numerical IDs written to regions.")
private Boolean createIDImage

Flag to enable/disable creation of gray-scale image with region IDs.

createColorImage

@Parameter(label="Create color image",
           required=true,
           direction=IN,
           dataIOOrder=4,
           mode=STANDARD,
           description="Create image of regions with random colors")
private Boolean createColorImage

Flag to enable/disable creation of region image in random colors.

resultingRegions

@Parameter(label="Resulting regions",
           required=true,
           direction=OUT,
           dataIOOrder=0,
           description="Resulting regions")
private MTBRegion2DSet resultingRegions

Resulting set of labeled regions.

labelImage

@Parameter(label="Label image",
           required=false,
           direction=OUT,
           dataIOOrder=1,
           description="Image of regions with labels (MTBImageType.MTB_INT)")
private transient MTBImage labelImage

Grayscale image of regions, gray values are identical to IDs.

idImage

@Parameter(label="ID image",
           required=false,
           direction=OUT,
           dataIOOrder=2,
           description="Image of region IDs")
private transient MTBImage idImage

Gray-scale image with IDs printed to regions.

Note that the gray values are scaled for better visibility and to not coincide with the region labels.

colorImage

@Parameter(label="Color image",
           required=false,
           direction=OUT,
           dataIOOrder=3,
           description="Image of regions with random colors")
private transient MTBImage colorImage

Image of regions in random colors.

m_labelImg

private MTBImageInt m_labelImg

Temporary label image.

m_width

private int m_width

Width of input image.

m_height

private int m_height

Height of input image.

Constructor Detail

LabelComponentsSequential

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

Constructor.

Throws:

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

LabelComponentsSequential

public LabelComponentsSequential(MTBImage img,
                                 boolean dn)
                          throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException

Constructor.

Parameters:

img - Input image.

dn - Set true for 8-NB or false for 4-NB.

Throws:

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

Method Detail

getInputImage

public MTBImage getInputImage()

Get reference to the current input image.

Returns:

Input image to work on.

setInputImage

public void setInputImage(MTBImage iImage)

Set a new input image.

Parameters:

iImage - Input image to label.

getDiagonalNeighborsFlag

public boolean getDiagonalNeighborsFlag()

Get the neighborhood flag.

Returns:

true if 8-neighborhood is used, false if 4-neighborhood is used

setDiagonalNeighborsFlag

public void setDiagonalNeighborsFlag(boolean diagonalNeighbors)

Set the neighborhood flag.

Parameters:

diagonalNeighbors - set true for 8-neighborhood and false for 4-neighborhood

getCreateLabelImageFlag

public boolean getCreateLabelImageFlag()

Get the flag that determines the creation of an image with region labels.

setCreateLabelImageFlag

public void setCreateLabelImageFlag(boolean createLabelImage)

Set the flag that determines the creation of an image with region labels.

setCreateIDImageFlag

public void setCreateIDImageFlag(boolean b)

Enable/disable creation of ID image.

Parameters:

b - If true, ID image is created.

getCreateColorImageFlag

public boolean getCreateColorImageFlag()

Get the flag that determines the creation of an image with randomly colored regions.

setCreateColorImageFlag

public void setCreateColorImageFlag(boolean createColorImage)

Set the flag that determines the creation of an image with randomly colored regions.

setResultingRegions

protected void setResultingRegions(MTBRegion2DSet regions)

Attach the vector of resulting regions.

getResultingRegions

public MTBRegion2DSet getResultingRegions()

Get the resulting regions.

setLabelImage

protected void setLabelImage(MTBImage labelImage)

Set image of region labels

getLabelImage

public MTBImage getLabelImage()

Get image of region labels (of type MTB_INT).

Only available if the create-label-image-flag was set to true, otherwise returns null.

Returns:

Label image.

getIDImage

public MTBImage getIDImage()

Get image of region ID (of type MTB_BYTE).

Only available if the corresponding flag was set to true, otherwise returns null.

Returns:

ID image.

setColorImage

protected void setColorImage(MTBImage colorImage)

Add the label image to the parameter object

getColorImage

public MTBImage getColorImage()

Get image of randomly colored regions, if the create-color-image-flag was set to true. Otherwise returns null.

operate

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

Specified by:

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

Throws:

de.unihalle.informatik.Alida.exceptions.ALDOperatorException

de.unihalle.informatik.Alida.exceptions.ALDProcessingDAGException

labelComponents

protected MTBRegion2DSet labelComponents(MTBImage img,
                                         boolean diagonalNeighbors)

Sequential component labeling

Parameters:

img - (binary) input image

diagonalNeighbors - set true for 8-neighborhood components, set false for 4-neighborhood

Returns:

returns a vector of regions

getLabel

private int getLabel(int x,
                     int y)

returns the value of labelImg at position (x,y). Also checks for image boundaries, returns 0 when (x,y) is outside of the image

Parameters:

x - x-coordinate

y - y-coordinate

labelImg - actual label image

Returns:

pixel value at (x,y) if (x,y) inside the image. If outside of the image, returns 0

drawStringToImage

protected static MTBImage drawStringToImage(MTBImage labelImage2,
                                            String s,
                                            int xPos,
                                            int yPos)

Draws string at given position into image.

Parameters:

labelImage2 - Image where to draw the string into.

s - String to draw.

xPos - Position of string in x.

yPos - Position of string in y.

Returns:

Result image.

getDocumentation

public String getDocumentation()

Overrides:

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