itkPreconditionedASGDOptimizer.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 itkPreconditionedASGDOptimizer_h
#define itkPreconditionedASGDOptimizer_h
 
#include "../StandardGradientDescent/itkStandardGradientDescentOptimizer.h"
 
namespace itk
{
class PreconditionedASGDOptimizer : public StandardGradientDescentOptimizer
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(PreconditionedASGDOptimizer);
 
  using Self = PreconditionedASGDOptimizer;
  using Superclass = StandardGradientDescentOptimizer;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkTypeMacro(PreconditionedASGDOptimizer, 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(UseAdaptiveStepSizes, bool);
  itkGetConstMacro(UseAdaptiveStepSizes, bool);
 
  itkSetMacro(SigmoidMax, double);
  itkGetConstMacro(SigmoidMax, double);
 
  itkSetMacro(SigmoidMin, double);
  itkGetConstMacro(SigmoidMin, double);
 
  itkSetMacro(SigmoidScale, double);
  itkGetConstMacro(SigmoidScale, double);
 
  itkGetConstReferenceMacro(PreconditionVector, ParametersType);
 
protected:
  PreconditionedASGDOptimizer();
  ~PreconditionedASGDOptimizer() override = default;
 
  void
  UpdateCurrentTime() override;
 
  DerivativeType m_PreviousSearchDirection{};
  ParametersType m_PreconditionVector{};
  std::string    m_StepSizeStrategy{};
 
private:
  bool   m_UseAdaptiveStepSizes{ true };
  double m_SigmoidMax{ 1.0 };
  double m_SigmoidMin{ -0.8 };
  double m_SigmoidScale{ 1e-8 };
};
 
} // end namespace itk
 
#endif // end #ifndef itkPreconditionedASGDOptimizer_h