|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ALDParametrizedClass public interface MTBSnakeEnergyDerivable
Super class for all energies to be used with PDE snakes in MiToBo.
Field Summary | |
---|---|
static double[] |
targetEnergyRange
Target interval boundaries of energy. |
Method Summary | |
---|---|
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(SnakeOptimizerSingleVarCalc o)
Init routine which is called once before the energy is actually used. |
void |
setScaleFactor(double s)
Set the scaling factor. |
java.lang.String |
toString()
Get an identifier string for the energy object. |
void |
updateStatus(SnakeOptimizerSingleVarCalc o)
Update internal state of energy object prior to usaging it. |
Field Detail |
---|
static final double[] targetEnergyRange
targetEnergyRange[0] -> left boundary targetEnergyRange[1] -> right boundary targetEnergyRange[2] -> interval width
Method Detail |
---|
Jama.Matrix getDerivative_MatrixPart(SnakeOptimizerSingleVarCalc o)
o
- Calling snake optimizer.
Jama.Matrix getDerivative_VectorPart(SnakeOptimizerSingleVarCalc o)
o
- Calling snake optimizer.
double getScaleFactor()
boolean initEnergy(SnakeOptimizerSingleVarCalc o) throws MTBSnakeException
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.
o
- Calling snake optimizer.
MTBSnakeException
void setScaleFactor(double s)
s
- New scaling factor.java.lang.String toString()
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.
toString
in class java.lang.Object
void updateStatus(SnakeOptimizerSingleVarCalc o) throws MTBSnakeException
MTBSnakeException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |