de.unihalle.informatik.MiToBo.segmentation.activecontours.datatypes

Class MTBSetWeightedEnergy<T>

java.lang.Object

de.unihalle.informatik.MiToBo.segmentation.activecontours.datatypes.MTBSetWeightedEnergy<T>

@ALDParametrizedClass
public class MTBSetWeightedEnergy<T>
extends Object

Container data type for energies in PDE approaches.

Objects of this class contain a set of energies. With each energy an individual weight is associated which allows application-dependent energy combinations. Per default the weights of all energies in the set are set to 1.0.

Author:

moeller

Field Summary

Fields

Modifier and Type	Field and Description
protected Vector<T>	energies List of snake energies.
protected Vector<Double>	weights List of energy weights.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addEnergy(T e) Append another energy to the list with default weight 1.0.
void	addEnergy(T e, double w) Append another energy to the list.
T	getEnergy(int i) Returns element i of the energy list.
Vector<T>	getEnergyList() 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<T> 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

energies

@ALDClassParameter(label="energies",
                   mode=STANDARD,
                   dataIOOrder=-10)
protected Vector<T> energies

List of snake energies.

weights

@ALDClassParameter(label="weights",
                   mode=STANDARD,
                   dataIOOrder=-5)
protected Vector<Double> weights

List of energy weights.

Constructor Detail

MTBSetWeightedEnergy

public MTBSetWeightedEnergy()

Default contructor for empty set.

MTBSetWeightedEnergy

public MTBSetWeightedEnergy(Vector<T> es)

Constructor for a given vector of energies.

Parameters:

es - Vector with energies.

MTBSetWeightedEnergy

public MTBSetWeightedEnergy(Vector<T> 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<T> es)

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

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.

Parameters:

ws - List of energy weights.

getEnergyList

public Vector<T> getEnergyList()

Returns the list of energies.

Returns:

List of energies.

getEnergy

public T getEnergy(int i)

Returns element i of the energy list.

Parameters:

i - Index of energy to be returned.

Returns:

Requested energy object.

getWeights

public Vector<Double> getWeights()

Returns the list of weights.

Returns:

List of current weights.

getWeight

public Double getWeight(int i)

Returns element i of the weight list.

Returns:

Requested element of weight list.

addEnergy

public void addEnergy(T e,
                      double w)

Append another energy to the list.

Parameters:

e - New energy.

w - Weight for the energy.

addEnergy

public void addEnergy(T 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