imaging::EnergyInterface Class Reference
[Minimization Module]

Abstract class interface for energies depending on vector valued input data. More...

#include <EnergyInterface.hpp>

Inheritance diagram for imaging::EnergyInterface:

imaging::DifferentiableEnergyInterface imaging::FunctionalAdaptor< functional_t > imaging::ShapeEnergyInterface< shape_t > imaging::DifferentiableFunctionalAdaptor< functional_t > imaging::MumfordShahEnergy< shape_t > imaging::MumfordShahEnergy< shape_t > imaging::SnakesEnergy< shape_t > imaging::StatisticalRegularization< shape_t >

List of all members.

Public Member Functions

virtual ublas::vector< float_t > & current_argument ()=0
virtual void set_argument ()=0
virtual float_t current_energy () const =0
virtual std::size_t dimension () const =0

Detailed Description

Abstract class interface for energies depending on vector valued input data.

Classes implementing EnergyInterface always have a current argument which can be directly accessed from the outside. It is only when set_argument() is called that the energy value for the current argument is computed. In other words, instead of passing an argument to a member of the energy class the clients edit the argument inside the energy class and manually trigger its evaluation. This has the advantage that the argument has only to be stored once and is still always accesible from the outside. Minor modifications of the argument can be made without resetting it completely. Accessing the argument is expected to be cheap, only calls to set_argument() might be expensive.

Member Function Documentation

virtual ublas::vector<float_t>& imaging::EnergyInterface::current_argument (  )  [pure virtual]

virtual void imaging::EnergyInterface::set_argument (  )  [pure virtual]

Compute the energy value corresponding to the current argument. This is where the main work of the energy evaluation should be done.

Implemented in imaging::DifferentiableFunctionalAdaptor< functional_t >, imaging::FunctionalAdaptor< functional_t >, imaging::MumfordShahEnergy< shape_t >, imaging::SnakesEnergy< shape_t >, and imaging::StatisticalRegularization< shape_t >.

Referenced by imaging::CovarianceMatrixAdaptation::minimize().

virtual float_t imaging::EnergyInterface::current_energy (  )  const [pure virtual]

virtual std::size_t imaging::EnergyInterface::dimension (  )  const [pure virtual]

The documentation for this class was generated from the following file:

Generated on Tue Feb 10 10:01:31 2009 for imaging2 by  doxygen 1.5.5