mitkOptimizer Class Reference

mitkOptimizer - an abstract class specifies interface for an optimization method More...

#include <mitkOptimizer.h>

Inherits mitkProcessObject.

Inherited by mitkAmoebaOptimizer, mitkGradientDescentOptimizer, mitkIterativeClosestPointOptimizer, mitkLBFGSBOptimizer, mitkLBFGSOptimizer, and mitkPowellOptimizer.

Inheritance diagram for mitkOptimizer:

[legend]Collaboration diagram for mitkOptimizer:

[legend]List of all members.

Public Member Functions
virtual void	PrintSelf (ostream &os)
virtual void	SetInitialParameters (VectorParameterType &param)
virtual VectorParameterType &	GetInitialParameters ()
void	SetScales (VectorParameterType &scales)
void	SetScales (ScalarParameterType *scales, unsigned int length)
VectorParameterType &	GetScales ()
virtual VectorParameterType &	GetLastParameters ()
void	SetMetric (mitkMetric *metric)
mitkMetric *	GetMetric ()
void	SetMaxIterations (unsigned int n)
unsigned int	GetMaxIterationNumber ()
virtual void	Update ()
void	SetNumberOfParameters (unsigned int num)
unsigned int	GetNumberOfParameters ()
void	SetSpaceDimension (unsigned int dim)
unsigned int	GetSpaceDimension ()
void	SetCurrentIterationNumber (unsigned int iterations)
unsigned int	GetCurrentIterationNumber ()
VectorParameterType &	GetCurrentPosition ()
void	GetCurrentPosition (double *currentPosition)
void	SetMaximizeFlag (bool flag)
bool	GetMaximizeFlag ()
void	SetStopFlag (bool flag)
bool	GetStopFlag ()
void	StopOptimization (StopCondition condition)

---

Detailed Description

mitkOptimizer - an abstract class specifies interface for an optimization method

mitkOptimizer is an abstract class specifies interface for an optimization method. It is not intended to be instantiated. This class is a base for a hierarchy of optimizers.

---

Member Function Documentation

unsigned int mitkOptimizer::GetCurrentIterationNumber (   )  [inline]

Get current iteration number. Returns: Current iteration number.

void mitkOptimizer::GetCurrentPosition (  double *  currentPosition  )

Get parameters in current iteration. currentPosition An array to store the parameters.

VectorParameterType& mitkOptimizer::GetCurrentPosition (   )  [inline]

Get the pointer of parameters vector in current iteration. Returns: The pointer to parameters vector.

virtual VectorParameterType& mitkOptimizer::GetInitialParameters (   )  [virtual]

Get the position to initialize the optimization. Returns: Return the vector pointer to the initial position for optimization.

virtual VectorParameterType& mitkOptimizer::GetLastParameters (   )  [virtual]

Get the last position of optimization. Returns: Return the vector pointer to the last position.

bool mitkOptimizer::GetMaximizeFlag (   )  [inline]

Get the maximize flag. Returns: The maximize flag.

unsigned int mitkOptimizer::GetMaxIterationNumber (   )  [inline]

Get the maximum number of iterations. Returns: The maximum number of iterations.

mitkMetric* mitkOptimizer::GetMetric (   )

Get the Metric Returns: Return the pointer to the Metric.

unsigned int mitkOptimizer::GetNumberOfParameters (   )  [inline]

Get the number of parameters. Returns: The number of parameters.

VectorParameterType& mitkOptimizer::GetScales (   )

Get current parameters scaling. Returns: Return the pointer to scale vector.

unsigned int mitkOptimizer::GetSpaceDimension (   )  [inline]

Get the dimensions of optimization space. Returns: The dimension of optimization space.

bool mitkOptimizer::GetStopFlag (   )  [inline]

Get the stop flag. Returns: The stop flag.

virtual void mitkOptimizer::PrintSelf (  ostream &  os  )  [virtual]

Print the necessary information about this object for the debugging purpose. Parameters: os  The specified ostream to output information. Reimplemented from mitkProcessObject. Reimplemented in mitkAmoebaOptimizer, mitkGradientDescentOptimizer, mitkIterativeClosestPointOptimizer, mitkLBFGSBOptimizer, mitkLBFGSOptimizer, and mitkPowellOptimizer.

void mitkOptimizer::SetCurrentIterationNumber (  unsigned int  iterations  )  [inline]

Set current iteration number. Parameters: iterations  Current iteration number.

virtual void mitkOptimizer::SetInitialParameters (  VectorParameterType &  param  )  [inline, virtual]

Set the position to initialize the optimization. Parameters: param  The vector pointer to the initial position for optimization.

void mitkOptimizer::SetMaximizeFlag (  bool  flag  )  [inline]

Define whether the cost function will be maximized or minimized. flag Maximizing the cost function if flag is true.

void mitkOptimizer::SetMaxIterations (  unsigned int  n  )  [inline]

Set the maximum number of iterations. Parameters: n  The maximum number of iterations.

void mitkOptimizer::SetMetric (  mitkMetric *  metric  )  [inline]

Set the similarity function Parameters: metric  The pointer to the Metric.

void mitkOptimizer::SetNumberOfParameters (  unsigned int  num  )  [inline]

Set the number of parameters. Parameters: num  The number of parameters.

void mitkOptimizer::SetScales (  ScalarParameterType *  scales, unsigned int  length )

Set the scalings of current parameters. Parameters: scales  The array pointer to the scales for every elements of parameters. numberOfParameters  The length of input scaling array.

void mitkOptimizer::SetScales (  VectorParameterType &  scales  )

Set the scalings of current parameters. Parameters: scales  The vector pointer to the scales for every elements of parameters.

void mitkOptimizer::SetSpaceDimension (  unsigned int  dim  )  [inline]

Set the dimensions of optimization space. Parameters: num  The dimensions of optimization space.

void mitkOptimizer::SetStopFlag (  bool  flag  )  [inline]

Set the stop flag, it will terminate the optimization process if the value is true. flag The stop flag.

void mitkOptimizer::StopOptimization (  StopCondition  condition  )

General stop conditions handling function call by concrete optimize classes. condition The stop condition.

virtual void mitkOptimizer::Update (   )  [virtual]

Initialize the Optimizer and make sure the components are present.

---

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

• mitkOptimizer.h

---