de.unihalle.informatik.MiToBo.features

Class TileFeatureCalculator

java.lang.Object

de.unihalle.informatik.Alida.operator.ALDOperator

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

de.unihalle.informatik.MiToBo.features.TileFeatureCalculator

All Implemented Interfaces:

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

@ALDAOperator(genericExecutionMode=ALL,
              level=APPLICATION,
              allowBatchMode=false,
              shortDescription="Calculates features tile-wise on images for given feature extractors.")
public class TileFeatureCalculator
extends MTBOperator

Calculates features on images tile-wise, based on operators extending FeatureCalculator.

Author:

moeller

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 Vector<FeatureCalculator>	featureOps List of feature calculators to apply.
private MTBImage	inImg Input image to process.
private MTBImage	mask Mask to exclude image regions and tiles, respectively.
private TileFeatureCalculatorResult	resultData Result of the calculation.
private MTBImage	resultImage Optional stack of result visualizations, if result data suppports that.
private Vector<MTBImage>	resultImages Vector for collecting result images.
private int	tileNumX Number of tiles in x dimension.
private int	tileNumY Number of tiles in y dimension.
private int	tileShiftX Shift of tiles in x direction.
private int	tileShiftY Shift of tiles in y direction.
private int	tileSizeX Size of tiles in x direction.
private int	tileSizeY Size of tiles in y direction.

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

completeDAG, name, operatorExecutionEventlistenerList, portHashAccess, verbose, versionProvider

Constructor Summary

Constructors

Constructor and Description
TileFeatureCalculator() Default constructor.
TileFeatureCalculator(int _tileSizeX, int _tileSizeY) Constructor with non-default tile sizes.
TileFeatureCalculator(int _tileSizeX, int _tileSizeY, int _tileShiftX, int _tileShiftY) Constructor with non-default tile sizes.

Method Summary

Modifier and Type	Method and Description
private void	addResultImages(FeatureCalculatorResult[] data) Generates a visual representation of the tile data and stores it.
String	getDocumentation()
TileFeatureCalculatorResult	getResult() Get result data.
MTBImage	getResultImage() Get image with result data.
int	getTileCountX() Get number of tiles in x-direction.
int	getTileCountY() Get number of tiles in x-direction.
void	operate()
private void	prepareImageStack() Puts all result images into a stack.
void	setFeatureOperators(Vector<FeatureCalculator> ops) Set feature operators.
void	setInputImage(MTBImage img) Set input image.
void	setMask(MTBImage exMask) Set optional exclude mask.

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

inImg

@Parameter(label="Input image",
           required=true,
           direction=IN,
           supplemental=false,
           description="Input image to analyze.",
           dataIOOrder=-10)
private transient MTBImage inImg

Input image to process.

tileSizeX

@Parameter(label="Tile size in x",
           required=true,
           direction=IN,
           supplemental=false,
           description="Size of image tiles to analyze in x.",
           dataIOOrder=-9)
private int tileSizeX

Size of tiles in x direction.

tileSizeY

@Parameter(label="Tile size in y",
           required=true,
           direction=IN,
           supplemental=false,
           description="Size of image tiles to analyze in y.",
           dataIOOrder=-8)
private int tileSizeY

Size of tiles in y direction.

tileShiftX

@Parameter(label="Tile shift in x",
           required=true,
           direction=IN,
           supplemental=false,
           description="Shift of image tiles to analyze in x.",
           dataIOOrder=-7)
private int tileShiftX

Shift of tiles in x direction.

tileShiftY

@Parameter(label="Tile shift in y",
           required=true,
           direction=IN,
           supplemental=false,
           description="Shift of image tiles to analyze in y.",
           dataIOOrder=-6)
private int tileShiftY

Shift of tiles in y direction.

featureOps

@Parameter(label="Feature calculators",
           required=true,
           direction=IN,
           supplemental=false,
           description="List of feature calculators to apply.",
           dataIOOrder=-5)
private Vector<FeatureCalculator> featureOps

List of feature calculators to apply.

mask

@Parameter(label="Exclude mask",
           required=false,
           direction=IN,
           supplemental=false,
           description="Mask to exclude image regions.",
           dataIOOrder=0)
private transient MTBImage mask

Mask to exclude image regions and tiles, respectively.

Tiles containing at least one masked pixel (value = 0) are ignored.

resultData

@Parameter(label="Result data object",
           direction=OUT,
           description="Calculated texture measures.")
private transient TileFeatureCalculatorResult resultData

Result of the calculation.

resultImage

@Parameter(label="Result image",
           direction=OUT,
           description="Optional result image stack.")
private transient MTBImage resultImage

Optional stack of result visualizations, if result data suppports that.

resultImages

private transient Vector<MTBImage> resultImages

Vector for collecting result images.

tileNumX

private transient int tileNumX

Number of tiles in x dimension.

tileNumY

private transient int tileNumY

Number of tiles in y dimension.

Constructor Detail

TileFeatureCalculator

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

Default constructor.

Throws:

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

TileFeatureCalculator

public TileFeatureCalculator(int _tileSizeX,
                             int _tileSizeY)
                      throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException

Constructor with non-default tile sizes.

Parameters:

_tileSizeX - Size of one tile in x direction.

_tileSizeY - Size of one tile in y direction.

Throws:

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

TileFeatureCalculator

public TileFeatureCalculator(int _tileSizeX,
                             int _tileSizeY,
                             int _tileShiftX,
                             int _tileShiftY)
                      throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException

Constructor with non-default tile sizes.

Parameters:

_tileSizeX - Size of one tile in x direction.

_tileSizeY - Size of one tile in y direction.

_tileShiftX - Shift between successive tiles in x direction.

_tileShiftY - Shift between successive tiles in y direction.

Throws:

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

Method Detail

operate

public 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

addResultImages

private void addResultImages(FeatureCalculatorResult[] data)

Generates a visual representation of the tile data and stores it.

Parameters:

data - Result data.

prepareImageStack

private void prepareImageStack()

Puts all result images into a stack.

setInputImage

public void setInputImage(MTBImage img)

Set input image.

Parameters:

img - Image to process.

setMask

public void setMask(MTBImage exMask)

Set optional exclude mask.

Parameters:

exMask - Exclude mask.

setFeatureOperators

public void setFeatureOperators(Vector<FeatureCalculator> ops)

Set feature operators.

Parameters:

ops - Feature operators to apply.

getResult

public TileFeatureCalculatorResult getResult()

Get result data.

Returns:

Calculated features.

getResultImage

public MTBImage getResultImage()

Get image with result data.

Returns:

Image with calculated feature data.

getTileCountX

public int getTileCountX()

Get number of tiles in x-direction.

Returns:

Number of tiles.

getTileCountY

public int getTileCountY()

Get number of tiles in x-direction.

Returns:

Number of tiles.

getDocumentation

public String getDocumentation()

Overrides:

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