de.unihalle.informatik.MiToBo.segmentation.levelset.core

Class MTBSet_LevelEnergyDerivable

java.lang.Object

de.unihalle.informatik.MiToBo.segmentation.levelset.core.MTBSet_LevelEnergyDerivable

All Implemented Interfaces:

MTBSet_ActiveContourEnergy

@ALDParametrizedClass
public class MTBSet_LevelEnergyDerivable
extends Object
implements MTBSet_ActiveContourEnergy

Container data type for derivable level set energies.

Objects of this class contain a set of derivable level set energies to be used in image segmentation by level sets. With each energy an individual weight is associated which allows to freely combine various energies depending on the application at hand. By default the weights of all energies in the set are set to 1.0.

Important notice: in MiToBo there exists a specialized data I/O provider MTBSet_SnakeEnergyDerivableDataIOSwing for this class; however, the provider only supports graphical data I/O. Accordingly, the class is also annotated as parametrized class to allow for using the generic parametrized class data I/O provider ALDParametrizedClassDataIOCmdline when using this class in the context of the command line user interfaces.

Author:

Birgit Moeller

Field Summary

Fields

Modifier and Type	Field and Description
protected MTBSetWeightedEnergy<MTBLevelsetEnergyDerivable>	energySet Set of energies.

Constructor Summary

Constructors

Constructor and Description
MTBSet_LevelEnergyDerivable() Default contructor for empty set.
MTBSet_LevelEnergyDerivable(Vector<MTBLevelsetEnergyDerivable> es) Constructor for a given vector of energies.
MTBSet_LevelEnergyDerivable(Vector<MTBLevelsetEnergyDerivable> es, Vector<Double> ws) Constructor with energies and weights.

Method Summary

Modifier and Type	Method and Description
void	addEnergy(MTBLevelsetEnergyDerivable e) Append another energy to the list with default weight 1.0.
void	addEnergy(MTBLevelsetEnergyDerivable e, double w) Append another energy to the list.
MTBLevelsetEnergyDerivable	getEnergy(int i) Returns element i of the energy list.
Vector<MTBLevelsetEnergyDerivable>	getEnergyList() Returns the list of level set energies.
Vector<MTBActiveContourEnergy>	getGenericEnergyList() Returns the list of energies.
Double	getWeight(int i) Returns element i of the weight list.
Vector<Double>	getWeights() Returns the list of weights.
void	setEnergyList(Vector<MTBActiveContourEnergy> es) Specify a new set of energies, all weights are reset to 1.0.
void	setWeights(Vector<Double> ws) Specify new weights.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

energySet

protected MTBSetWeightedEnergy<MTBLevelsetEnergyDerivable> energySet

Set of energies.

Constructor Detail

MTBSet_LevelEnergyDerivable

public MTBSet_LevelEnergyDerivable()

Default contructor for empty set.

MTBSet_LevelEnergyDerivable

public MTBSet_LevelEnergyDerivable(Vector<MTBLevelsetEnergyDerivable> es)

Constructor for a given vector of energies.

Parameters:

es - Vector with energies.

MTBSet_LevelEnergyDerivable

public MTBSet_LevelEnergyDerivable(Vector<MTBLevelsetEnergyDerivable> es,
                                   Vector<Double> ws)
                            throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException

Constructor with energies and weights.

Both vectors must have the same size, otherwise an exception is thrown.

Parameters:

es - Vector of energies.

ws - Vector of weights.

Throws:

de.unihalle.informatik.Alida.exceptions.ALDOperatorException

Method Detail

setEnergyList

public void setEnergyList(Vector<MTBActiveContourEnergy> es)

Specify a new set of energies, all weights are reset to 1.0.

Specified by:

setEnergyList in interface MTBSet_ActiveContourEnergy

Parameters:

es - New vector of energies.

setWeights

public void setWeights(Vector<Double> ws)

Specify new weights.

Note that it is assumed that the size of the weight vector matches the size of the current energy set.

Specified by:

setWeights in interface MTBSet_ActiveContourEnergy

Parameters:

ws - List of energy weights.

getGenericEnergyList

public Vector<MTBActiveContourEnergy> getGenericEnergyList()

Returns the list of energies.

Specified by:

getGenericEnergyList in interface MTBSet_ActiveContourEnergy

Returns:

List of energies.

getEnergyList

public Vector<MTBLevelsetEnergyDerivable> getEnergyList()

Returns the list of level set energies.

Returns:

List of energies casted to objects of type level set energy.

getEnergy

public MTBLevelsetEnergyDerivable getEnergy(int i)

Returns element i of the energy list.

Specified by:

getEnergy in interface MTBSet_ActiveContourEnergy

Parameters:

i - Index of energy to be returned.

Returns:

Requested energy object.

getWeights

public Vector<Double> getWeights()

Returns the list of weights.

Specified by:

getWeights in interface MTBSet_ActiveContourEnergy

Returns:

List of current weights.

getWeight

public Double getWeight(int i)

Returns element i of the weight list.

Specified by:

getWeight in interface MTBSet_ActiveContourEnergy

Parameters:

i - Index of requested weight.

Returns:

Requested element of weight list.

addEnergy

public void addEnergy(MTBLevelsetEnergyDerivable e,
                      double w)

Append another energy to the list.

Parameters:

e - New energy.

w - Weight for the energy.

addEnergy

public void addEnergy(MTBLevelsetEnergyDerivable e)

Append another energy to the list with default weight 1.0.

Parameters:

e - New energy to be appended.

toString

public String toString()

Overrides:

toString in class Object