itkGradientDescentOptimizerBasev4.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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 itkGradientDescentOptimizerBasev4_h
#define itkGradientDescentOptimizerBasev4_h

#include "itkObjectToObjectOptimizerBase.h"
#include "itkWindowConvergenceMonitoringFunction.h"
#include "itkThreadedIndexedContainerPartitioner.h"
#include "itkDomainThreader.h"

namespace itk
{
template<typename TInternalComputationValueType>
class GradientDescentOptimizerBasev4Template
  : public ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType>
{
public:
  typedef GradientDescentOptimizerBasev4Template                       Self;
  typedef ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType> Superclass;
  typedef SmartPointer< Self >                                         Pointer;
  typedef SmartPointer< const Self >                                   ConstPointer;

  itkTypeMacro(GradientDescentOptimizerBasev4Template, Superclass);

  typedef enum {
    MAXIMUM_NUMBER_OF_ITERATIONS,
    COSTFUNCTION_ERROR,
    UPDATE_PARAMETERS_ERROR,
    STEP_TOO_SMALL,
    CONVERGENCE_CHECKER_PASSED,
    GRADIENT_MAGNITUDE_TOLEARANCE,
    OTHER_ERROR
    } StopConditionType;

  typedef typename Superclass::StopConditionReturnStringType StopConditionReturnStringType;

  typedef typename Superclass::StopConditionDescriptionType  StopConditionDescriptionType;

  typedef TInternalComputationValueType          InternalComputationValueType;

  typedef typename Superclass::MetricType                    MetricType;
  typedef typename MetricType::Pointer                       MetricTypePointer;

  typedef typename Superclass::DerivativeType                DerivativeType;

  typedef typename Superclass::MeasureType                   MeasureType;

  typedef typename Superclass::ScalesType                    ScalesType;

  typedef typename Superclass::ParametersType                ParametersType;

  typedef itk::Function::WindowConvergenceMonitoringFunction<TInternalComputationValueType>
  ConvergenceMonitoringType;

  itkGetConstReferenceMacro( Gradient, DerivativeType );

  itkGetConstReferenceMacro(StopCondition, StopConditionType);

  virtual void SetNumberOfIterations( const SizeValueType numberOfIterations ) ITK_OVERRIDE
    {
    itkDebugMacro("setting NumberOfIterations to " << numberOfIterations );
    if ( this->m_NumberOfIterations != numberOfIterations)
      {
      this->m_NumberOfIterations = numberOfIterations;
      this->Modified();
      }
    }

  virtual SizeValueType GetNumberOfIterations() const ITK_OVERRIDE
    {
    return this->m_NumberOfIterations;
    }

  virtual SizeValueType GetCurrentIteration() const ITK_OVERRIDE
    {
    return this->m_CurrentIteration;
    }

  virtual void StartOptimization( bool doOnlyInitialization = false ) ITK_OVERRIDE;

  virtual void ResumeOptimization() = 0;

  virtual void StopOptimization();

  virtual const StopConditionReturnStringType GetStopConditionDescription() const ITK_OVERRIDE;

  virtual void ModifyGradientByScales();
  virtual void ModifyGradientByLearningRate();

  typedef ThreadedIndexedContainerPartitioner::IndexRangeType IndexRangeType;

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

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

protected:

  GradientDescentOptimizerBasev4Template();
  virtual ~GradientDescentOptimizerBasev4Template();

  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;
  StopConditionType             m_StopCondition;
  StopConditionDescriptionType  m_StopConditionDescription;

  DerivativeType     m_Gradient;
  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

private:

  GradientDescentOptimizerBasev4Template( const Self & ); //purposely not implemented
  void operator=( const Self& ); //purposely not implemented

};

typedef GradientDescentOptimizerBasev4Template<double> GradientDescentOptimizerBasev4;

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkGradientDescentOptimizerBasev4.hxx"
#endif

#endif