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

Interface MTBSnakeEnergyDerivable

All Superinterfaces:

MTBActiveContourEnergy, MTBActiveContourEnergyDerivable

All Known Implementing Classes:

MTBSnakeEnergyCD_CVRegionFit, MTBSnakeEnergyCD_KassCurvature, MTBSnakeEnergyCD_KassLength, MTBSnakeEnergyCD_OverlapPenalty, MTBSnakeEnergyCDIB_Distance, MTBSnakeEnergyCDIB_Gradient, MTBSnakeEnergyCDIB_GVF2D, MTBSnakeEnergyCDIB_Intensity, MTBSnakeEnergyCDImageBased

@ALDParametrizedClass
public interface MTBSnakeEnergyDerivable
extends MTBActiveContourEnergyDerivable

Super class for all energies to be used with PDE snakes in MiToBo.

Author:

moeller

Field Summary

Fields

Modifier and Type	Field and Description
static double[]	targetEnergyRange Target interval boundaries of energy.

Method Summary

Modifier and Type	Method and Description
Jama.Matrix	getDerivative_MatrixPart(SnakeOptimizerSingleVarCalc o) Returns the linear matrix part of this energy for snake optimization.
Jama.Matrix	getDerivative_VectorPart(SnakeOptimizerSingleVarCalc o) Returns the vector part of this energy for snake optimization.
double	getScaleFactor() Get scaling factor.
boolean	initEnergy(SnakeOptimizerSingle o) Init routine which is called once before the energy is actually used.
boolean	requiresCounterClockwiseContourSorting() Ask energy if contour points need to sorted counter-clockwise.
boolean	requiresOverlapMask() Ask energy if an overlap mask for all snakes jointly optimized is required.
void	setScaleFactor(double s) Set the scaling factor.
String	toString() Get an identifier string for the energy object.
void	updateStatus(SnakeOptimizerSingle o) Update internal state of energy object prior to usaging it.

Field Detail

targetEnergyRange

static final double[] targetEnergyRange

Target interval boundaries of energy.

targetEnergyRange[0] -> left boundary targetEnergyRange[1] -> right boundary targetEnergyRange[2] -> interval width

Method Detail

initEnergy

boolean initEnergy(SnakeOptimizerSingle o)
            throws MTBSnakeException

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.

Parameters:

o - Calling snake optimizer.

Returns:

True if init was successful, otherwise false.

Throws:

MTBSnakeException

updateStatus

void updateStatus(SnakeOptimizerSingle o)
           throws MTBSnakeException

Update internal state of energy object prior to usaging it.

Throws:

MTBSnakeException

getDerivative_MatrixPart

Jama.Matrix getDerivative_MatrixPart(SnakeOptimizerSingleVarCalc o)

Returns the linear matrix part of this energy for snake optimization.

Parameters:

o - Calling snake optimizer.

Returns:

Optimization matrix for this energy object.

getDerivative_VectorPart

Jama.Matrix getDerivative_VectorPart(SnakeOptimizerSingleVarCalc o)

Returns the vector part of this energy for snake optimization.

Parameters:

o - Calling snake optimizer.

Returns:

Optimization vector for this energy object.

setScaleFactor

void setScaleFactor(double s)

Set the scaling factor.

Parameters:

s - New scaling factor.

getScaleFactor

double getScaleFactor()

Get scaling factor.

Returns:

Current scaling factor.

requiresCounterClockwiseContourSorting

boolean requiresCounterClockwiseContourSorting()

Ask energy if contour points need to sorted counter-clockwise.

Returns:

If true, counter-clockwise sorting is expected.

requiresOverlapMask

boolean requiresOverlapMask()

Ask energy if an overlap mask for all snakes jointly optimized is required.

Returns:

If true, the energy expects an overlap mask to be available.

toString

String toString()

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.

Overrides:

toString in class Object

Returns:

Identifier string.