itkGradientDescentOptimizer2.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 __itkGradientDescentOptimizer2_h
#define __itkGradientDescentOptimizer2_h
 
#include "itkScaledSingleValuedNonLinearOptimizer.h"
 
 
namespace itk
{
 
class GradientDescentOptimizer2 :
  public ScaledSingleValuedNonLinearOptimizer
{
public:
 
  typedef GradientDescentOptimizer2            Self;
  typedef ScaledSingleValuedNonLinearOptimizer Superclass;
  typedef SmartPointer< Self >                 Pointer;
  typedef SmartPointer< const Self >           ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( GradientDescentOptimizer2, ScaledSingleValuedNonLinearOptimizer );
 
  typedef Superclass::MeasureType               MeasureType;
  typedef Superclass::ParametersType            ParametersType;
  typedef Superclass::DerivativeType            DerivativeType;
  typedef Superclass::CostFunctionType          CostFunctionType;
  typedef Superclass::ScalesType                ScalesType;
  typedef Superclass::ScaledCostFunctionType    ScaledCostFunctionType;
  typedef Superclass::ScaledCostFunctionPointer ScaledCostFunctionPointer;
 
  typedef enum {
    MaximumNumberOfIterations,
    MetricError,
    MinimumStepSize
  } StopConditionType;
 
  virtual void AdvanceOneStep( void );
 
  void StartOptimization( void ) override;
 
  virtual void ResumeOptimization( void );
 
  virtual void MetricErrorResponse( ExceptionObject & err );
 
  virtual void StopOptimization( void );
 
  itkSetMacro( LearningRate, double );
 
  itkGetConstReferenceMacro( LearningRate, double );
 
  itkSetMacro( NumberOfIterations, unsigned long );
 
  itkGetConstReferenceMacro( NumberOfIterations, unsigned long );
 
  itkGetConstMacro( CurrentIteration, unsigned int );
 
  itkGetConstReferenceMacro( Value, double );
 
  itkGetConstReferenceMacro( StopCondition, StopConditionType );
 
  itkGetConstReferenceMacro( Gradient, DerivativeType );
 
  itkGetConstReferenceMacro( SearchDirection, DerivativeType );
 
  itkSetMacro( UseOpenMP, bool );
 
protected:
 
  GradientDescentOptimizer2();
  ~GradientDescentOptimizer2() override {}
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  // made protected so subclass can access
  double            m_Value;
  DerivativeType    m_Gradient;
  DerivativeType    m_SearchDirection;
  double            m_LearningRate;
  StopConditionType m_StopCondition;
 
  bool          m_Stop;
  unsigned long m_NumberOfIterations;
  unsigned long m_CurrentIteration;
 
private:
 
  GradientDescentOptimizer2( const Self & ); // purposely not implemented
  void operator=( const Self & );            // purposely not implemented
 
  bool m_UseOpenMP;
 
};
 
} // end namespace itk
 
#endif