itkAmoebaOptimizer.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkAmoebaOptimizer.h,v $
  Language:  C++
  Date:      $Date: 2009-06-24 12:02:50 $
  Version:   $Revision: 1.26 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkAmoebaOptimizer_h
#define __itkAmoebaOptimizer_h

#include "itkSingleValuedNonLinearVnlOptimizer.h"
#include "vnl/algo/vnl_amoeba.h"

namespace itk
{
  
class ITK_EXPORT AmoebaOptimizer : 
    public SingleValuedNonLinearVnlOptimizer
{
public:
  typedef AmoebaOptimizer                     Self;
  typedef SingleValuedNonLinearVnlOptimizer   Superclass;
  typedef SmartPointer<Self>                  Pointer;
  typedef SmartPointer<const Self>            ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro( AmoebaOptimizer, SingleValuedNonLinearVnlOptimizer );

  typedef Superclass::ParametersType ParametersType;

  typedef   vnl_vector<double>     InternalParametersType;

  typedef   vnl_amoeba             InternalOptimizerType;

  vnl_amoeba * GetOptimizer(void);

  void StartOptimization( void );

  virtual void SetCostFunction( SingleValuedCostFunction * costFunction );

  virtual void SetMaximumNumberOfIterations( unsigned int n );
  itkGetConstMacro( MaximumNumberOfIterations, unsigned int );

  itkSetMacro(AutomaticInitialSimplex, bool);
  itkBooleanMacro(AutomaticInitialSimplex);
  itkGetConstMacro(AutomaticInitialSimplex, bool);

  itkSetMacro(InitialSimplexDelta, ParametersType);
  itkGetConstMacro(InitialSimplexDelta, ParametersType);

  virtual void SetParametersConvergenceTolerance( double tol );
  itkGetConstMacro( ParametersConvergenceTolerance, double );
  virtual void SetFunctionConvergenceTolerance( double tol );
  itkGetConstMacro( FunctionConvergenceTolerance, double );

  const std::string GetStopConditionDescription() const;

  MeasureType GetValue() const;

protected:
  AmoebaOptimizer();
  virtual ~AmoebaOptimizer();
  void PrintSelf(std::ostream& os, Indent indent) const;

  typedef Superclass::CostFunctionAdaptorType   CostFunctionAdaptorType;

private:
  AmoebaOptimizer(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  bool                          m_OptimizerInitialized;
  InternalOptimizerType       * m_VnlOptimizer;
  unsigned int                  m_MaximumNumberOfIterations;
  double                        m_ParametersConvergenceTolerance;
  double                        m_FunctionConvergenceTolerance;

  bool                          m_AutomaticInitialSimplex;
  ParametersType                m_InitialSimplexDelta;

  OStringStream                 m_StopConditionDescription;
};

} // end namespace itk

#endif