de.unihalle.informatik.MiToBo.segmentation.snakes.energies

Class MTBSnakeEnergyCDIB_Distance

java.lang.Object

de.unihalle.informatik.MiToBo.segmentation.snakes.energies.MTBSnakeEnergyCDImageBased

de.unihalle.informatik.MiToBo.segmentation.snakes.energies.MTBSnakeEnergyCDIB_Distance

All Implemented Interfaces:

MTBActiveContourEnergy, MTBActiveContourEnergyDerivable, MTBSnakeEnergyComputable, MTBSnakeEnergyDerivable

@ALDDerivedClass
 @ALDParametrizedClass
public class MTBSnakeEnergyCDIB_Distance
extends MTBSnakeEnergyCDImageBased

 
 Class for external energy from a distance transform (distance map / field).
 The distance field is stored in a two-dimensional double array, where the
 first dimension includes the y-coordinates of the field and the
 second dimension hold the x-coordinates.
 For the distance field the user can specify the distance metric
 (Euclidean, Chessboard, Cityblock)
 and can set the foreground of the given binary image.
 
 So the external energy is defined as: extEnergy(x,y) = distField[y][x].
 
 !!!ATTENTION!!!
 If the distance map should be used as external energy, the map should be
 calculated on the foreground. Normal distance map is calculated in the
 object, so we want to set the foreground as object.
 That means, on a black image with white objects, the foreground for the
 distance map must be set to white and vice versa!
 
 

Author:

Danny Misiak

See Also:

DistanceTransform

Field Summary

Fields

Modifier and Type	Field and Description
private DistanceTransform.ForegroundColor	colorFG
private double[][]	distField The calculated 2D vector field from the distance map.
private DistanceTransform.DistanceMetric	distMetric The used distance metric for the distance map calculation.
private MTBImageByte	inImage

Fields inherited from class de.unihalle.informatik.MiToBo.segmentation.snakes.energies.MTBSnakeEnergyCDImageBased

height, normalizationFactor, normMode, scaleFactor, width

Fields inherited from interface de.unihalle.informatik.MiToBo.segmentation.snakes.energies.MTBSnakeEnergyDerivable

targetEnergyRange

Constructor Summary

Constructors

Constructor and Description
MTBSnakeEnergyCDIB_Distance()
MTBSnakeEnergyCDIB_Distance(MTBImageByte image, DistanceTransform.DistanceMetric d, DistanceTransform.ForegroundColor f) Constructor to create a new SnakeExternalEnergyDistance object.

Method Summary

Modifier and Type	Method and Description
double	getDerivativeX(double x, double y) Get x-derivative of the distance map at given position using central differences.
double	getDerivativeY(double x, double y) Get y-derivative of the distance map at given position using central differences.
double	getValue(double x, double y) Returns the distance value from the distance map at the given position.
boolean	initEnergy(SnakeOptimizerSingle o) Init routine which is called once before the energy is actually used.
void	normalizeEnergy() Normalize the external energy in a range [0.0, 1.0].
String	toString() Get an identifier string for the energy object.

Methods inherited from class de.unihalle.informatik.MiToBo.segmentation.snakes.energies.MTBSnakeEnergyCDImageBased

calcEnergy, calcEnergy, getDerivative_MatrixPart, getDerivative_VectorPart, getDerivativeX_norm, getDerivativeY_norm, getScaleFactor, getValue_norm, requiresCounterClockwiseContourSorting, requiresOverlapMask, setScaleFactor, updateStatus

Methods inherited from class java.lang.Object

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

Field Detail

distMetric

@ALDClassParameter(label="Distance Metric")
private DistanceTransform.DistanceMetric distMetric

The used distance metric for the distance map calculation.

colorFG

@ALDClassParameter(label="Foreground Color")
private DistanceTransform.ForegroundColor colorFG

inImage

@ALDClassParameter(label="Input Image")
private MTBImageByte inImage

distField

private double[][] distField

The calculated 2D vector field from the distance map.

Constructor Detail

MTBSnakeEnergyCDIB_Distance

public MTBSnakeEnergyCDIB_Distance()

MTBSnakeEnergyCDIB_Distance

public MTBSnakeEnergyCDIB_Distance(MTBImageByte image,
                                   DistanceTransform.DistanceMetric d,
                                   DistanceTransform.ForegroundColor f)

Constructor to create a new SnakeExternalEnergyDistance object. The distance map can be normalized between [0,1] using the normalizeEnergy() method.

Parameters:

image - the given input image to calculate the external energy

d - distance metric (euclidean, cityblock, ...)

f - foreground f the image (white or black)

Method Detail

initEnergy

public boolean initEnergy(SnakeOptimizerSingle o)

Description copied from interface: MTBSnakeEnergyDerivable

Init routine which is called once before the energy is actually used.

In this routine global parameter settings can be handled or other initialization stuff be done. The SnakeOptimizer will call this routine once before the actual use of the energy. If no stuff needs to be done in advance the routine should at least return true.

Specified by:

initEnergy in interface MTBSnakeEnergyComputable

Specified by:

initEnergy in interface MTBSnakeEnergyDerivable

Overrides:

initEnergy in class MTBSnakeEnergyCDImageBased

Parameters:

o - Calling snake optimizer.

Returns:

True if init was successful, otherwise false.

getValue

public double getValue(double x,
                       double y)

Returns the distance value from the distance map at the given position.

Specified by:

getValue in class MTBSnakeEnergyCDImageBased

Parameters:

x - x-coordinate of position

y - y-coordinate of position

Returns:

Absolute value of external energy.

getDerivativeX

public double getDerivativeX(double x,
                             double y)

Get x-derivative of the distance map at given position using central differences.

Specified by:

getDerivativeX in class MTBSnakeEnergyCDImageBased

Parameters:

x - x-coordinate of pixel position

y - y-coordinate of pixel position

Returns:

x-derivative value at given position.

getDerivativeY

public double getDerivativeY(double x,
                             double y)

Get y-derivative of the distance map at given position using central differences.

Specified by:

getDerivativeY in class MTBSnakeEnergyCDImageBased

Parameters:

x - x-coordinate of pixel position

y - y-coordinate of pixel position

Returns:

y-derivative value at given position.

normalizeEnergy

public void normalizeEnergy()

Normalize the external energy in a range [0.0, 1.0].

Specified by:

normalizeEnergy in class MTBSnakeEnergyCDImageBased

toString

public String toString()

Description copied from interface: MTBSnakeEnergyDerivable

Get an identifier string for the energy object.

When meta parameters are saved to a file, configuration objects need to be converted to strings. Consequently, each snake energy should be associated with a unique and descriptive string for later reference.

Specified by:

toString in interface MTBSnakeEnergyComputable

Specified by:

toString in interface MTBSnakeEnergyDerivable

Overrides:

toString in class Object

Returns:

Identifier string.