itkFiniteDifferenceGradientDescentOptimizer.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
 
#ifndef __itkFiniteDifferenceGradientDescentOptimizer_h
#define __itkFiniteDifferenceGradientDescentOptimizer_h
 
#include "itkScaledSingleValuedNonLinearOptimizer.h"
 
namespace itk
{
 
class FiniteDifferenceGradientDescentOptimizer :
  public ScaledSingleValuedNonLinearOptimizer
{
public:
 
  typedef FiniteDifferenceGradientDescentOptimizer Self;
  typedef ScaledSingleValuedNonLinearOptimizer     Superclass;
  typedef SmartPointer< Self >                     Pointer;
  typedef SmartPointer< const Self >               ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( FiniteDifferenceGradientDescentOptimizer, ScaledSingleValuedNonLinearOptimizer );
 
  typedef enum {
    MaximumNumberOfIterations,
    MetricError
  } StopConditionType;
 
  virtual void AdvanceOneStep( void );
 
  void StartOptimization( void ) override;
 
  void ResumeOptimization( void );
 
  void StopOptimization( void );
 
  itkSetMacro( NumberOfIterations, unsigned long );
 
  itkGetConstMacro( NumberOfIterations, unsigned long );
 
  itkGetConstMacro( CurrentIteration, unsigned long );
 
  itkGetConstMacro( Value, double );
 
  itkGetConstMacro( StopCondition, StopConditionType );
 
  itkSetMacro( Param_a, double );
  itkGetMacro( Param_a, double );
 
  itkSetMacro( Param_c, double );
  itkGetMacro( Param_c, double );
 
  itkSetMacro( Param_A, double );
  itkGetMacro( Param_A, double );
 
  itkSetMacro( Param_alpha, double );
  itkGetMacro( Param_alpha, double );
 
  itkSetMacro( Param_gamma, double );
  itkGetMacro( Param_gamma, double );
 
  itkGetConstMacro( ComputeCurrentValue, bool );
  itkSetMacro( ComputeCurrentValue, bool );
  itkBooleanMacro( ComputeCurrentValue );
 
  itkGetConstMacro( GradientMagnitude, double );
  itkGetConstMacro( LearningRate, double );
 
protected:
 
  FiniteDifferenceGradientDescentOptimizer();
  ~FiniteDifferenceGradientDescentOptimizer() override {}
 
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  // made protected so subclass can access
  DerivativeType m_Gradient;
  double         m_LearningRate;
  double         m_GradientMagnitude;
 
  bool m_ComputeCurrentValue;
 
  // Functions to compute the parameters at iteration k.
  virtual double Compute_a( unsigned long k ) const;
 
  virtual double Compute_c( unsigned long k ) const;
 
private:
 
  FiniteDifferenceGradientDescentOptimizer( const Self & ); // purposely not implemented
  void operator=( const Self & );                           // purposely not implemented
 
  bool              m_Stop;
  double            m_Value;
  StopConditionType m_StopCondition;
  unsigned long     m_NumberOfIterations;
  unsigned long     m_CurrentIteration;
 
  double m_Param_a;
  double m_Param_c;
  double m_Param_A;
  double m_Param_alpha;
  double m_Param_gamma;
 
};
 
} // end namespace itk
 
#endif // end #ifndef __itkFiniteDifferenceGradientDescentOptimizer_h