itkConjugateGradientMaxIterOptimizer.h

Go to the documentation of this file.

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

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

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

#ifndef itkConjugateGradientMaxIterOptimizer_h
#define itkConjugateGradientMaxIterOptimizer_h

#include <itkSingleValuedNonLinearVnlOptimizer.h>
#include <vnl/algo/vnl_conjugate_gradient.h>

namespace itk
{

class ITK_EXPORT ConjugateGradientMaxIterOptimizer :
    public SingleValuedNonLinearVnlOptimizer

{
public:
  typedef ConjugateGradientMaxIterOptimizer          Self;
  typedef SingleValuedNonLinearVnlOptimizer   Superclass;
  typedef SmartPointer<Self>                  Pointer;
  typedef SmartPointer<const Self>            ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro( ConjugateGradientMaxIterOptimizer, SingleValuedNonLinearOptimizer );

  typedef   vnl_vector<double>     InternalParametersType;

  typedef   vnl_conjugate_gradient InternalOptimizerType;

  vnl_conjugate_gradient * GetOptimizer(void);

  virtual void SetMaximumNumberOfFunctionEvaluations( unsigned int n );
  itkGetMacro( MaximumNumberOfFunctionEvaluations, unsigned int );

  void StartOptimization( void ) override;

  virtual void SetCostFunction( SingleValuedCostFunction * costFunction ) override;


  unsigned long GetNumberOfIterations(void) const;
  unsigned long GetCurrentIteration(void) const;

  MeasureType GetValue() const;

protected:
  ConjugateGradientMaxIterOptimizer();
  virtual ~ConjugateGradientMaxIterOptimizer();

  typedef Superclass::CostFunctionAdaptorType   CostFunctionAdaptorType;

private:
  ConjugateGradientMaxIterOptimizer(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  bool                            m_OptimizerInitialized;
  InternalOptimizerType       * m_VnlOptimizer;
  unsigned int                     m_MaximumNumberOfFunctionEvaluations;

};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkConjugateGradientMaxIterOptimizer.txx"
#endif

#endif