itkGradientDescentOptimizerBasev4.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkGradientDescentOptimizerBasev4_h
#define itkGradientDescentOptimizerBasev4_h
 
#include "itkObjectToObjectOptimizerBase.h"
#include "itkWindowConvergenceMonitoringFunction.h"
#include "itkThreadedIndexedContainerPartitioner.h"
#include "itkDomainThreader.h"
 
namespace itk
{
template <typename TInternalComputationValueType>
class ITK_TEMPLATE_EXPORT GradientDescentOptimizerBasev4Template
  : public ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GradientDescentOptimizerBasev4Template);

  using Self = GradientDescentOptimizerBasev4Template;
  using Superclass = ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(GradientDescentOptimizerBasev4Template);
 
#if !defined(ITK_LEGACY_REMOVE)
  static constexpr itk::StopConditionObjectToObjectOptimizerEnum MAXIMUM_NUMBER_OF_ITERATIONS =
    itk::StopConditionObjectToObjectOptimizerEnum::MAXIMUM_NUMBER_OF_ITERATIONS;
  static constexpr itk::StopConditionObjectToObjectOptimizerEnum COSTFUNCTION_ERROR =
    itk::StopConditionObjectToObjectOptimizerEnum::COSTFUNCTION_ERROR;
  static constexpr itk::StopConditionObjectToObjectOptimizerEnum UPDATE_PARAMETERS_ERROR =
    itk::StopConditionObjectToObjectOptimizerEnum::UPDATE_PARAMETERS_ERROR;
  static constexpr itk::StopConditionObjectToObjectOptimizerEnum STEP_TOO_SMALL =
    itk::StopConditionObjectToObjectOptimizerEnum::STEP_TOO_SMALL;
  static constexpr itk::StopConditionObjectToObjectOptimizerEnum CONVERGENCE_CHECKER_PASSED =
    itk::StopConditionObjectToObjectOptimizerEnum::CONVERGENCE_CHECKER_PASSED;
  static constexpr itk::StopConditionObjectToObjectOptimizerEnum GRADIENT_MAGNITUDE_TOLEARANCE =
    itk::StopConditionObjectToObjectOptimizerEnum::GRADIENT_MAGNITUDE_TOLEARANCE;
  static constexpr itk::StopConditionObjectToObjectOptimizerEnum OTHER_ERROR =
    itk::StopConditionObjectToObjectOptimizerEnum::OTHER_ERROR;
#endif

  using typename Superclass::StopConditionReturnStringType;

  using typename Superclass::StopConditionDescriptionType;

  using InternalComputationValueType = TInternalComputationValueType;

  using typename Superclass::MetricType;
  using MetricTypePointer = typename MetricType::Pointer;

  using typename Superclass::DerivativeType;

  using typename Superclass::MeasureType;
 
  using typename Superclass::ScalesType;
 
  using typename Superclass::ParametersType;

  using ConvergenceMonitoringType = itk::Function::WindowConvergenceMonitoringFunction<TInternalComputationValueType>;

  itkGetConstReferenceMacro(Gradient, DerivativeType);

  itkGetConstReferenceMacro(StopCondition, StopConditionObjectToObjectOptimizerEnum);

  void
  StartOptimization(bool doOnlyInitialization = false) override;

  virtual void
  ResumeOptimization() = 0;

  virtual void
  StopOptimization();

  StopConditionReturnStringType
  GetStopConditionDescription() const override;

  virtual void
  ModifyGradientByScales();
  virtual void
  ModifyGradientByLearningRate();
 
  using IndexRangeType = ThreadedIndexedContainerPartitioner::IndexRangeType;

  virtual void
  ModifyGradientByScalesOverSubRange(const IndexRangeType & subrange) = 0;

  virtual void
  ModifyGradientByLearningRateOverSubRange(const IndexRangeType & subrange) = 0;
 
protected:
  GradientDescentOptimizerBasev4Template();
  ~GradientDescentOptimizerBasev4Template() override = default;

  bool m_DoEstimateLearningRateAtEachIteration{};

  bool m_DoEstimateLearningRateOnce{};

  TInternalComputationValueType m_MaximumStepSizeInPhysicalUnits{};

  bool m_UseConvergenceMonitoring{};

  SizeValueType m_ConvergenceWindowSize{};

  typename ConvergenceMonitoringType::Pointer m_ConvergenceMonitoring{};
 
  typename DomainThreader<ThreadedIndexedContainerPartitioner, Self>::Pointer m_ModifyGradientByScalesThreader{};
  typename DomainThreader<ThreadedIndexedContainerPartitioner, Self>::Pointer m_ModifyGradientByLearningRateThreader{};
 
  /* Common variables for optimization control and reporting */
  bool                                     m_Stop{ false };
  StopConditionObjectToObjectOptimizerEnum m_StopCondition{};
  StopConditionDescriptionType             m_StopConditionDescription{};

  DerivativeType m_Gradient{};
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
};

using GradientDescentOptimizerBasev4 = GradientDescentOptimizerBasev4Template<double>;
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGradientDescentOptimizerBasev4.hxx"
#endif
 
#endif