itkGenericConjugateGradientOptimizer.h

Go to the documentation of this file.

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

  This file is part of the elastix software.

  Copyright (c) University Medical Center Utrecht. All rights reserved.
  See src/CopyrightElastix.txt or http://elastix.isi.uu.nl/legal.php 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 __itkGenericConjugateGradientOptimizer_h
#define __itkGenericConjugateGradientOptimizer_h

#include "itkScaledSingleValuedNonLinearOptimizer.h"
#include "itkLineSearchOptimizer.h"
#include <vector>
#include <map>

namespace itk
{
class GenericConjugateGradientOptimizer :
  public ScaledSingleValuedNonLinearOptimizer
{
public:

  typedef GenericConjugateGradientOptimizer    Self;
  typedef ScaledSingleValuedNonLinearOptimizer Superclass;
  typedef SmartPointer< Self >                 Pointer;
  typedef SmartPointer< const Self >           ConstPointer;

  itkNewMacro( Self );
  itkTypeMacro( GenericConjugateGradientOptimizer,
    ScaledSingleValuedNonLinearOptimizer );

  typedef Superclass::ParametersType         ParametersType;
  typedef Superclass::DerivativeType         DerivativeType;
  typedef Superclass::CostFunctionType       CostFunctionType;
  typedef Superclass::ScaledCostFunctionType ScaledCostFunctionType;
  typedef Superclass::MeasureType            MeasureType;
  typedef Superclass::ScalesType             ScalesType;

  typedef LineSearchOptimizer              LineSearchOptimizerType;
  typedef LineSearchOptimizerType::Pointer LineSearchOptimizerPointer;

  typedef double (Self::* ComputeBetaFunctionType
  )( const DerivativeType &,
    const DerivativeType &,
    const ParametersType & );
  typedef std::string BetaDefinitionType;
  typedef std::map< BetaDefinitionType,
    ComputeBetaFunctionType >                   BetaDefinitionMapType;

  typedef enum {
    MetricError,
    LineSearchError,
    MaximumNumberOfIterations,
    GradientMagnitudeTolerance,
    ValueTolerance,
    InfiniteBeta,
    Unknown
  }                                   StopConditionType;

  virtual void StartOptimization( void );

  virtual void ResumeOptimization( void );

  virtual void StopOptimization( void );

  itkGetConstMacro( CurrentIteration, unsigned long );
  itkGetConstMacro( CurrentValue, MeasureType );
  itkGetConstReferenceMacro( CurrentGradient, DerivativeType );
  itkGetConstMacro( InLineSearch, bool );
  itkGetConstReferenceMacro( StopCondition, StopConditionType );
  itkGetConstMacro( CurrentStepLength, double );

  itkSetObjectMacro( LineSearchOptimizer, LineSearchOptimizerType );
  itkGetObjectMacro( LineSearchOptimizer, LineSearchOptimizerType );

  itkGetConstMacro( MaximumNumberOfIterations, unsigned long );
  itkSetClampMacro( MaximumNumberOfIterations, unsigned long,
    1, NumericTraits< unsigned long >::max() );

  itkGetConstMacro( GradientMagnitudeTolerance, double );
  itkSetMacro( GradientMagnitudeTolerance, double )

  
  itkGetConstMacro( ValueTolerance, double );
  itkSetMacro( ValueTolerance, double );

  virtual void SetMaxNrOfItWithoutImprovement( unsigned long arg );

  itkGetConstMacro( MaxNrOfItWithoutImprovement, unsigned long );

  virtual void SetBetaDefinition( const BetaDefinitionType & arg );

  itkGetConstReferenceMacro( BetaDefinition, BetaDefinitionType );

protected:

  GenericConjugateGradientOptimizer();
  virtual ~GenericConjugateGradientOptimizer(){}

  void PrintSelf( std::ostream & os, Indent indent ) const;

  DerivativeType    m_CurrentGradient;
  MeasureType       m_CurrentValue;
  unsigned long     m_CurrentIteration;
  StopConditionType m_StopCondition;
  bool              m_Stop;
  double            m_CurrentStepLength;

  bool m_UseDefaultMaxNrOfItWithoutImprovement;

  bool m_InLineSearch;
  itkSetMacro( InLineSearch, bool );

  bool m_PreviousGradientAndSearchDirValid;

  BetaDefinitionType m_BetaDefinition;

  BetaDefinitionMapType m_BetaDefinitionMap;

  virtual void AddBetaDefinition(
    const BetaDefinitionType & name,
    ComputeBetaFunctionType function );

  virtual void ComputeSearchDirection(
    const DerivativeType & previousGradient,
    const DerivativeType & gradient,
    ParametersType & searchDir );

  virtual void LineSearch(
    const ParametersType searchDir,
    double & step,
    ParametersType & x,
    MeasureType & f,
    DerivativeType & g );

  virtual bool TestConvergence( bool firstLineSearchDone );

  virtual double ComputeBeta(
    const DerivativeType & previousGradient,
    const DerivativeType & gradient,
    const ParametersType & previousSearchDir );

  double ComputeBetaSD(
    const DerivativeType & previousGradient,
    const DerivativeType & gradient,
    const ParametersType & previousSearchDir );

  double ComputeBetaFR(
    const DerivativeType & previousGradient,
    const DerivativeType & gradient,
    const ParametersType & previousSearchDir );

  double ComputeBetaPR(
    const DerivativeType & previousGradient,
    const DerivativeType & gradient,
    const ParametersType & previousSearchDir );

  double ComputeBetaDY(
    const DerivativeType & previousGradient,
    const DerivativeType & gradient,
    const ParametersType & previousSearchDir );

  double ComputeBetaHS(
    const DerivativeType & previousGradient,
    const DerivativeType & gradient,
    const ParametersType & previousSearchDir );

  double ComputeBetaDYHS(
    const DerivativeType & previousGradient,
    const DerivativeType & gradient,
    const ParametersType & previousSearchDir );

private:

  GenericConjugateGradientOptimizer( const Self & ); // purposely not implemented
  void operator=( const Self & );                    // purposely not implemented

  unsigned long m_MaximumNumberOfIterations;
  double        m_ValueTolerance;
  double        m_GradientMagnitudeTolerance;
  unsigned long m_MaxNrOfItWithoutImprovement;

  LineSearchOptimizerPointer m_LineSearchOptimizer;

};

} // end namespace itk

#endif //#ifndef __itkGenericConjugateGradientOptimizer_h