DrawRegion2DSet (mitobo 2.0 API)

java.lang.Object
- de.unihalle.informatik.Alida.operator.ALDOperator
- - de.unihalle.informatik.MiToBo.core.operator.MTBOperator
  - - de.unihalle.informatik.MiToBo.visualization.drawing.DrawRegion2DSet

All Implemented Interfaces:

de.unihalle.informatik.Alida.datatypes.ALDConfigurationValidator, de.unihalle.informatik.Alida.operator.events.ALDOperatorExecutionProgressEventListener, EventListener
```
@ALDAOperator(genericExecutionMode=ALL,
              shortDescription="Visualizes 2D regions.")
public class DrawRegion2DSet
extends MTBOperator
```
A class to visualize 2D regions.
Background is always 0, regions can be drawn in different ways. The following kinds of region images can be created or drawn to an existing image:
- LABEL_IMAGE:
  draw gray value image where regions are labeled by their index in the set plus one
- ID_IMAGE:
  draw gray value image where regions are labeled by their region id (see MTBRegion2D for details)
- MASK_IMAGE:
  draw a mask image with equal gray values for all regions
- COLOR_IMAGE:
  draw a mask with colored regions
- TRANSPARENT_IMAGE:
  draw a mask with colored regions, but the regions are transparent to show the underlying intensity structure of the given target image
- CONTOURS:
  draw only contours of the regions in a given colour
Constructors take the kind of image and the regions to be drawn as well as an eventual target image. Default configurations are set by the constructors. Use the different get/set methods to specify non default parameters like color, gray value etc.
Be sure to set the xMin, xMax, yMin, yMax values of the input MTBRegion2DSet correctly, because these values are used to determine the output image size if no target image is specified nor dimensions are given explicitly!
Author:

Oliver Gress

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DrawRegion2DSet.DrawType
Type of image to be drawn.
- 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`DrawRegion2DSet.DrawType` Type of image to be drawn.

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`cloneTargetImage` Flag to enable/disable cloning of target image.
`private Color`	`color` Color value used, e.g., for color and transparent images.
`private DrawRegion2DSet.DrawType`	`drawType` Type of image to be created.
`private Double`	`grayValue` Gray value used, e.g., for mask or contour images.
`private MTBImage.MTBImageType`	`imageType` Desired type of output image.
`private MTBRegion2DSet`	`inputRegions` Set of regions to draw.
`private Random`	`random` Random generator for color sampling.
`private MTBImage`	`resultImage` Output image.
`private int`	`resultImgHeight` Desired height of result image.
`private int`	`resultImgOffsetX` Desired offset in x of result image.
`private int`	`resultImgOffsetY` Desired offset in y of result image.
`private int`	`resultImgWidth` Desired width of result image.
`private MTBImage`	`targetImage` Optional target image.

Fields inherited from class de.unihalle.informatik.Alida.operator.ALDOperator
completeDAG, name, operatorExecutionEventlistenerList, portHashAccess, verbose, versionProvider

Constructor Summary

Constructors
Constructor and Description
`DrawRegion2DSet()` Default constructor where no parameters are set.
`DrawRegion2DSet(DrawRegion2DSet.DrawType dtype, MTBRegion2DSet regions)` Simple constructor to create the most common region image types.
`DrawRegion2DSet(DrawRegion2DSet.DrawType dtype, MTBRegion2DSet regions, MTBImage tImage, boolean cloneTImage)` Simple constructor to draw the most common region image types to a given image.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`color2int(Color c)` Transforms color to integer value.
`Color`	`getColor()` Get the uniform color of the regions in a color image (COLOR_IMAGE only).
`String`	`getDocumentation()`
`DrawRegion2DSet.DrawType`	`getDrawType()` Get the kind of region image drawn by the operator
`Double`	`getGrayValue()` Get the gray value of the regions in a mask image (MASK_IMAGE only).
`MTBImage.MTBImageType`	`getImageType()` Get the datatype of the resulting image.
`MTBRegion2DSet`	`getInputRegions()` Get the regions that have to be drawn
`Random`	`getRandom()` Get the random number generator which is responsable to draw each region in a random color (COLOR_IMAGE only).
`MTBImage`	`getResultImage()` Get the resulting region image.
`MTBImage`	`getTargetImage()` Get the target image to which the regions are drawn, if one was specified.
`private void`	`initOperator()` Initial setip of the operator.
`protected Color`	`int2Color(int cInt)` Transforms integer value to `Color` object.
`protected void`	`operate()`
`protected int`	`randomColor(Random r)` Generates the next random color.
`void`	`setCloneTargetImage(boolean flag)` Enable or disable cloning of target image.
`void`	`setColor(Color c)` Set the uniform color of the regions in a color image.
`void`	`setDrawType(DrawRegion2DSet.DrawType dtype)` Set the kind of region image to be drawn
`void`	`setGrayValue(Double value)` Set the gray value of the regions in a mask image.
`void`	`setImageType(MTBImage.MTBImageType type)` Set the resulting image's datatype.
`void`	`setInputRegions(MTBRegion2DSet regions)` Set the input regions to be drawn.
`void`	`setRandom(Random r)` Set a random number generator to draw each region in a random color.
`private void`	`setResultImage(MTBImage image)` Set the resulting image.
`void`	`setResultImageHeight(int h)` Set target image height, overwrites all other internal settings.
`void`	`setResultImageOffsetX(int ox)` Set desired offset for target image in x direction.
`void`	`setResultImageOffsetY(int oy)` Set desired offset for target image in y direction.
`void`	`setResultImageWidth(int w)` Set target image width, overwrites all other internal settings.
`void`	`setTargetImage(MTBImage targetimage)` Specify a target image to which the regions are drawn.
`private void`	`synchronizeColorOptions()` Updates color parameter if a random generator is given.
`private void`	`synchronizeRandomOptions()` Updates random parameter if a color is set.
`private void`	`updateImageAndColorSettings()` Updates output image type and gray values according to chosen draw type.
`private void`	`updateTargetImageDependencies()` Updates parameters depending on the target image.
`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, 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
  - inputRegions
```
@Parameter(label="Input Regions",
           required=true,
           direction=IN,
           dataIOOrder=0,
           mode=STANDARD,
           description="Regions to draw.")
private transient MTBRegion2DSet inputRegions
```
    Set of regions to draw.
  - drawType
```
@Parameter(label="Draw Type",
           required=true,
           direction=IN,
           dataIOOrder=1,
           mode=STANDARD,
           paramModificationMode=MODIFIES_INTERFACE,
           callback="updateImageAndColorSettings",
           description="The type of image to be drawn.")
private DrawRegion2DSet.DrawType drawType
```
    Type of image to be created.
  - imageType
```
@Parameter(label="Type of Output Image",
           required=true,
           direction=IN,
           dataIOOrder=2,
           mode=STANDARD,
           description="The data type of the output image.")
private MTBImage.MTBImageType imageType
```
    Desired type of output image.
  - grayValue
```
@Parameter(label="Gray Value",
           required=false,
           direction=IN,
           dataIOOrder=0,
           mode=STANDARD,
           description="Gray value used to draw all regions or contours.")
private Double grayValue
```
    Gray value used, e.g., for mask or contour images.
  - color
```
@Parameter(label="Color Value",
           required=false,
           direction=IN,
           dataIOOrder=1,
           mode=STANDARD,
           paramModificationMode=MODIFIES_INTERFACE,
           callback="synchronizeRandomOptions",
           description="A color used to paint all regions or contours.")
private Color color
```
    Color value used, e.g., for color and transparent images.
  - random
```
@Parameter(label="Random Generator",
           required=false,
           direction=IN,
           dataIOOrder=2,
           mode=STANDARD,
           paramModificationMode=MODIFIES_INTERFACE,
           callback="synchronizeColorOptions",
           description="Random generator for sampling pseudo-colors.")
private Random random
```
    Random generator for color sampling.
  - targetImage
```
@Parameter(label="Target Image",
           required=false,
           direction=IN,
           dataIOOrder=3,
           mode=STANDARD,
           paramModificationMode=MODIFIES_INTERFACE,
           callback="updateTargetImageDependencies",
           description="Image where to draw the regions into.")
private transient MTBImage targetImage
```
    Optional target image.
  - cloneTargetImage
```
@Parameter(label="   - Clone Target Image?",
           required=false,
           direction=IN,
           dataIOOrder=4,
           mode=STANDARD,
           description="Select if the target image should be cloned.")
private boolean cloneTargetImage
```
    Flag to enable/disable cloning of target image.
  - resultImgWidth
```
@Parameter(label="Result Image Width",
           required=false,
           direction=IN,
           dataIOOrder=5,
           mode=ADVANCED,
           description="Width of target image.")
private int resultImgWidth
```
    Desired width of result image.
    If this parameter and resultImgHeight are set to something different from -1 they will overwrite all other specifications.
  - resultImgHeight
```
@Parameter(label="Result Image Height",
           required=false,
           direction=IN,
           dataIOOrder=6,
           mode=ADVANCED,
           description="Height of target image.")
private int resultImgHeight
```
    Desired height of result image.
    If this parameter and resultImgWidth are set to something different from -1 they will overwrite all other specifications.
  - resultImgOffsetX
```
@Parameter(label="Result Image Offset X",
           required=false,
           direction=IN,
           dataIOOrder=7,
           mode=ADVANCED,
           description="Offset in x of result image.")
private int resultImgOffsetX
```
    Desired offset in x of result image.
    If resultImgHeight and resultImgWidth are set to values different from -1 this parameter will be used and overwrite all other specifications.
  - resultImgOffsetY
```
@Parameter(label="Result Image Offset Y",
           required=false,
           direction=IN,
           dataIOOrder=8,
           mode=ADVANCED,
           description="Offset in y of result image.")
private int resultImgOffsetY
```
    Desired offset in y of result image.
    If resultImgHeight and resultImgWidth are set to values different from -1 this parameter will be used and overwrite all other specifications.
  - resultImage
```
@Parameter(label="Result Image",
           direction=OUT,
           mode=STANDARD,
           dataIOOrder=0,
           description="Result image.")
private transient MTBImage resultImage
```
    Output image.
- Constructor Detail
  - DrawRegion2DSet
```
public DrawRegion2DSet()
                throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException
```
    Default constructor where no parameters are set.
    Don't use this for region image creation.
    
    Throws:
    
    de.unihalle.informatik.Alida.exceptions.ALDOperatorException - Thrown if instantiation fails.
  - DrawRegion2DSet
```
public DrawRegion2DSet(DrawRegion2DSet.DrawType dtype,
                       MTBRegion2DSet regions)
                throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException
```
    Simple constructor to create the most common region image types.
    See drawType for details.
    
    Parameters:
    
    dtype - Drawing type to be used.
    
    regions - Set of regions to be drawn.
    
    Throws:
    
    de.unihalle.informatik.Alida.exceptions.ALDOperatorException - Thrown in case of failure.
  - DrawRegion2DSet
```
public DrawRegion2DSet(DrawRegion2DSet.DrawType dtype,
                       MTBRegion2DSet regions,
                       MTBImage tImage,
                       boolean cloneTImage)
                throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException
```
    Simple constructor to draw the most common region image types to a given image.
    
    Parameters:
    
    dtype - Drawing type to apply.
    
    regions - Set of regions to draw.
    
    tImage - Target image to draw the regions to.
    
    cloneTImage - Flag to clone the target image.
    
    Throws:
    
    de.unihalle.informatik.Alida.exceptions.ALDOperatorException - Thrown in case of processing failure.
- Method Detail
  - initOperator
```
private void initOperator()
```
    Initial setip of the operator.
  - 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
  - setInputRegions
```
public void setInputRegions(MTBRegion2DSet regions)
```
    Set the input regions to be drawn.
    
    Parameters:
    
    regions - Regions to draw.
  - getInputRegions
```
public MTBRegion2DSet getInputRegions()
```
    Get the regions that have to be drawn
    
    Returns:
    
    set of regions
  - setTargetImage
```
public void setTargetImage(MTBImage targetimage)
```
    Specify a target image to which the regions are drawn.
    If image is null a new image is created.
    
    Parameters:
    
    targetimage - Target image.
  - getTargetImage
```
public MTBImage getTargetImage()
```
    Get the target image to which the regions are drawn, if one was specified.
    
    Returns:
    
    target image or null, if none was specified and the operator creates a new image
  - setCloneTargetImage
```
public void setCloneTargetImage(boolean flag)
```
    Enable or disable cloning of target image.
    Enabling cloning of the image requires a target image to be available.
    
    Parameters:
    
    flag - If true cloning of target image is enabled.
  - setDrawType
```
public void setDrawType(DrawRegion2DSet.DrawType dtype)
```
    Set the kind of region image to be drawn
    
    Parameters:
    
    dtype - see DrawType
  - getDrawType
```
public DrawRegion2DSet.DrawType getDrawType()
```
    Get the kind of region image drawn by the operator
    
    Returns:
    
    Draw type currently set.
  - setImageType
```
public void setImageType(MTBImage.MTBImageType type)
```
    Set the resulting image's datatype.
    If a target image was specified and the given type differs from the target image's type, the target image is set to null. In this case a new image is created.
    
    Parameters:
    
    type - Desired type of result image.
  - getImageType
```
public MTBImage.MTBImageType getImageType()
```
    Get the datatype of the resulting image.
    
    Returns:
    
    Data type of result image.
  - setGrayValue
```
public void setGrayValue(Double value)
```
    Set the gray value of the regions in a mask image.
    This setting is only active if a mask image is to be created. Be aware of the resulting image's datatype!
    
    Parameters:
    
    value - Gray value to use.
  - getGrayValue
```
public Double getGrayValue()
```
    Get the gray value of the regions in a mask image (MASK_IMAGE only).
    
    Returns:
    
    Gray value or null, if none was specified
  - setColor
```
public void setColor(Color c)
```
    Set the uniform color of the regions in a color image.
    This setting is only active if a color image is to be created.
    
    Parameters:
    
    c - Color to be applied.
  - getColor
```
public Color getColor()
```
    Get the uniform color of the regions in a color image (COLOR_IMAGE only).
    
    Returns:
    
    Color or null, if none was specified.
  - setRandom
```
public void setRandom(Random r)
```
    Set a random number generator to draw each region in a random color.
    This setting is only active if a color image is to be created.
    
    Parameters:
    
    r - Random generator to be applied.
  - getRandom
```
public Random getRandom()
```
    Get the random number generator which is responsable to draw each region in a random color (COLOR_IMAGE only).
    
    Returns:
    
    Random number generator or null, if none was specified
  - setResultImageWidth
```
public void setResultImageWidth(int w)
```
    Set target image width, overwrites all other internal settings.
    
    Parameters:
    
    w - Desired width of target image.
  - setResultImageHeight
```
public void setResultImageHeight(int h)
```
    Set target image height, overwrites all other internal settings.
    
    Parameters:
    
    h - Desired height of target image.
  - setResultImageOffsetX
```
public void setResultImageOffsetX(int ox)
```
    Set desired offset for target image in x direction.
    
    Parameters:
    
    ox - Desired offset of target image in x.
  - setResultImageOffsetY
```
public void setResultImageOffsetY(int oy)
```
    Set desired offset for target image in y direction.
    
    Parameters:
    
    oy - Desired offset of target image in y.
  - setResultImage
```
private void setResultImage(MTBImage image)
```
    Set the resulting image.
    
    Parameters:
    
    image - Result image.
  - getResultImage
```
public MTBImage getResultImage()
```
    Get the resulting region image.
    If a target image (targetImage) was specified, this is the same object if cloning was not selected.
    
    Returns:
    
    Result image.
  - 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
  - randomColor
```
protected int randomColor(Random r)
```
    Generates the next random color.
    
    Parameters:
    
    r - Random generator to be used.
    
    Returns:
    
    Integer value of new color.
  - color2int
```
protected int color2int(Color c)
```
    Transforms color to integer value.
    
    Parameters:
    
    c - Color to transform.
    
    Returns:
    
    Resulting integer value.
  - int2Color
```
protected Color int2Color(int cInt)
```
    Transforms integer value to Color object.
    
    Parameters:
    
    cInt - Input integer value.
    
    Returns:
    
    Resulting color object.
  - updateImageAndColorSettings
```
private void updateImageAndColorSettings()
```
    Updates output image type and gray values according to chosen draw type.
  - updateTargetImageDependencies
```
private void updateTargetImageDependencies()
                                    throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException
```
    Updates parameters depending on the target image.
    
    Throws:
    
    de.unihalle.informatik.Alida.exceptions.ALDOperatorException - Thrown in case of failure.
  - synchronizeRandomOptions
```
private void synchronizeRandomOptions()
                               throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException
```
    Updates random parameter if a color is set.
    
    Throws:
    
    de.unihalle.informatik.Alida.exceptions.ALDOperatorException - Thrown in case of failure.
  - synchronizeColorOptions
```
private void synchronizeColorOptions()
                              throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException
```
    Updates color parameter if a random generator is given.
    
    Throws:
    
    de.unihalle.informatik.Alida.exceptions.ALDOperatorException - Thrown in case of failure.
  - getDocumentation
```
public String getDocumentation()
```
    Overrides:
    
    getDocumentation in class de.unihalle.informatik.Alida.operator.ALDOperator

Class DrawRegion2DSet

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

inputRegions

drawType

imageType

grayValue

color

random

targetImage

cloneTargetImage

resultImgWidth

resultImgHeight

resultImgOffsetX

resultImgOffsetY

resultImage

Constructor Detail

DrawRegion2DSet

DrawRegion2DSet

DrawRegion2DSet

Method Detail

initOperator

validateCustom

setInputRegions

getInputRegions

setTargetImage

getTargetImage

setCloneTargetImage

setDrawType

getDrawType

setImageType

getImageType

setGrayValue

getGrayValue

setColor

getColor

setRandom

getRandom

setResultImageWidth

setResultImageHeight

setResultImageOffsetX

setResultImageOffsetY

setResultImage

getResultImage

operate

randomColor

color2int

int2Color

updateImageAndColorSettings

updateTargetImageDependencies

synchronizeRandomOptions

synchronizeColorOptions

getDocumentation