itkStandardStochasticGradientDescentOptimizer.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 __itkStandardStochasticGradientOptimizer_h
#define __itkStandardStochasticGradientOptimizer_h
 
#include "itkStochasticGradientDescentOptimizer.h"
 
namespace itk
{
class StandardStochasticGradientOptimizer :
  public StochasticGradientDescentOptimizer
{
public:
 
  typedef StandardStochasticGradientOptimizer Self;
  typedef StochasticGradientDescentOptimizer  Superclass;
  typedef SmartPointer<Self>                  Pointer;
  typedef SmartPointer<const Self>            ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( StandardStochasticGradientOptimizer, StochasticGradientDescentOptimizer );
 
  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 Superclass::StopConditionType         StopConditionType;
 
  itkSetMacro( Param_a, double );
  itkGetConstMacro( Param_a, double );
 
  itkSetMacro( Param_beta, double );
  itkGetConstMacro( Param_beta, double );
 
  itkSetMacro( Param_A, double );
  itkGetConstMacro( Param_A, double );
 
  itkSetMacro( Param_alpha, double );
  itkGetConstMacro( Param_alpha, double );
 
  void AdvanceOneStep( void ) override;
 
  void StartOptimization( void ) override;
 
  itkSetMacro( InitialTime, double );
  itkGetConstMacro( InitialTime, double );
 
  itkGetConstMacro( CurrentTime, double );
 
  virtual void ResetCurrentTimeToInitialTime( void )
  {
    this->m_CurrentTime = this->m_InitialTime;
  }
 
protected:
 
  StandardStochasticGradientOptimizer();
  ~StandardStochasticGradientOptimizer() override {};
 
  virtual double Compute_a( double k ) const;
 
  virtual double Compute_beta( double k ) const;
 
  virtual void UpdateCurrentTime( void );
 
  double m_CurrentTime;
 
  bool m_UseConstantStep;
 
private:
 
  StandardStochasticGradientOptimizer( const Self& );  // purposely not implemented
  void operator=( const Self& );              // purposely not implemented
 
  double                        m_Param_a;
  double                        m_Param_beta;
  double                        m_Param_A;
  double                        m_Param_alpha;
 
  double                        m_InitialTime;
 
}; // end class StandardStochasticGradientOptimizer
 
 
} // end namespace itk
 
 
#endif // end #ifndef __itkStandardStochasticGradientOptimizer_h