itkStandardGradientDescentOptimizer.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 itkStandardGradientDescentOptimizer_h
#define itkStandardGradientDescentOptimizer_h
 
#include "itkGradientDescentOptimizer2.h"
 
namespace itk
{

 
class StandardGradientDescentOptimizer : public GradientDescentOptimizer2
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(StandardGradientDescentOptimizer);

  using Self = StandardGradientDescentOptimizer;
  using Superclass = GradientDescentOptimizer2;
 
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(StandardGradientDescentOptimizer);

  using Superclass::MeasureType;
  using Superclass::ParametersType;
  using Superclass::DerivativeType;
  using Superclass::CostFunctionType;
  using Superclass::ScalesType;
  using Superclass::ScaledCostFunctionType;
  using Superclass::ScaledCostFunctionPointer;
  using Superclass::StopConditionType;

  itkSetMacro(Param_a, double);
  itkGetConstMacro(Param_a, double);

  itkSetMacro(Param_A, double);
  itkGetConstMacro(Param_A, double);

  itkSetMacro(Param_alpha, double);
  itkGetConstMacro(Param_alpha, double);

  void
  AdvanceOneStep() override;

  void
  StartOptimization() override;

  itkSetMacro(InitialTime, double);
  itkGetConstMacro(InitialTime, double);

  itkGetConstMacro(CurrentTime, double);

  virtual void
  ResetCurrentTimeToInitialTime()
  {
    this->m_CurrentTime = this->m_InitialTime;
  }
 
 
protected:
  StandardGradientDescentOptimizer();
  ~StandardGradientDescentOptimizer() override = default;

  virtual double
  Compute_a(double k) const;

  virtual void
  UpdateCurrentTime();

  double m_CurrentTime{ 0.0 };

  bool m_UseConstantStep{ false };
 
private:
  double m_Param_a{ 1.0 };
  double m_Param_A{ 1.0 };
  double m_Param_alpha{ 0.602 };

  double m_InitialTime{ 0.0 };
};
 
} // end namespace itk
 
#endif // end #ifndef itkStandardGradientDescentOptimizer_h