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 "itkGradientDescentOptimizerBasev4ModifyGradientByScalesThreader.h"
#include "itkGradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader.h"

namespace itk
{
class ITK_EXPORT GradientDescentOptimizerBasev4
  : public ObjectToObjectOptimizerBase
{
public:
  typedef GradientDescentOptimizerBasev4 Self;
  typedef ObjectToObjectOptimizerBase    Superclass;
  typedef SmartPointer< Self >           Pointer;
  typedef SmartPointer< const Self >     ConstPointer;

  itkTypeMacro(GradientDescentOptimizerBasev4, ObjectToObjectOptimizerBase);

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

  typedef std::string                            StopConditionReturnStringType;

  typedef std::ostringstream                     StopConditionDescriptionType;

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

  typedef MetricType::DerivativeType                DerivativeType;

  typedef Superclass::MeasureType                   MeasureType;

  typedef Superclass::InternalComputationValueType InternalComputationValueType;

  itkGetConstReferenceMacro( Gradient, DerivativeType );

  itkGetConstReferenceMacro(StopCondition, StopConditionType);

  itkSetMacro(NumberOfIterations, SizeValueType);

  itkGetConstReferenceMacro(NumberOfIterations, SizeValueType);

  itkGetConstMacro(CurrentIteration, SizeValueType);

  virtual void ResumeOptimization() = 0;

  virtual void StopOptimization(void);

  virtual const StopConditionReturnStringType GetStopConditionDescription() const;

  virtual void ModifyGradient();

protected:

  GradientDescentOptimizerBasev4();
  virtual ~GradientDescentOptimizerBasev4();

  friend class GradientDescentOptimizerBasev4ModifyGradientByScalesThreader;
  friend class GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader;

  typedef GradientDescentOptimizerBasev4ModifyGradientByScalesThreader::IndexRangeType IndexRangeType;

  GradientDescentOptimizerBasev4ModifyGradientByScalesThreader::Pointer       m_ModifyGradientByScalesThreader;
  GradientDescentOptimizerBasev4ModifyGradientByLearningRateThreader::Pointer m_ModifyGradientByLearningRateThreader;

  virtual void EstimateLearningRate() = 0;

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

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

  /* Common variables for optimization control and reporting */
  bool                          m_Stop;
  StopConditionType             m_StopCondition;
  StopConditionDescriptionType  m_StopConditionDescription;
  SizeValueType                 m_NumberOfIterations;
  SizeValueType                 m_CurrentIteration;

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

private:
  GradientDescentOptimizerBasev4( const Self & ); //purposely not implemented
  void operator=( const Self& ); //purposely not implemented

};

} // end namespace itk

#endif