itkAdaptiveStochasticGradientDescentOptimizer.h

Go to the documentation of this file.

/*======================================================================

  This file is part of the elastix software.

  Copyright (c) University Medical Center Utrecht. All rights reserved.
  See src/CopyrightElastix.txt or http://elastix.isi.uu.nl/legal.php for
  details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE. See the above copyright notices for more information.

======================================================================*/

#ifndef __itkAdaptiveStochasticGradientDescentOptimizer_h
#define __itkAdaptiveStochasticGradientDescentOptimizer_h

#include "../StandardGradientDescent/itkStandardGradientDescentOptimizer.h"

namespace itk
{

  class AdaptiveStochasticGradientDescentOptimizer :
    public StandardGradientDescentOptimizer
  {
  public:

    typedef AdaptiveStochasticGradientDescentOptimizer   Self;
    typedef StandardGradientDescentOptimizer      Superclass;

    typedef SmartPointer<Self>                  Pointer;
    typedef SmartPointer<const Self>            ConstPointer;

    itkNewMacro( Self );

    itkTypeMacro( AdaptiveStochasticGradientDescentOptimizer,
      StandardGradientDescentOptimizer );

    typedef Superclass::MeasureType               MeasureType;
    typedef Superclass::ParametersType            ParametersType;
    typedef Superclass::DerivativeType            DerivativeType;
    typedef Superclass::CostFunctionType          CostFunctionType;
    typedef Superclass::ScalesType                ScalesType;
    typedef Superclass::ScaledCostFunctionType    ScaledCostFunctionType;
    typedef Superclass::ScaledCostFunctionPointer ScaledCostFunctionPointer;
    typedef Superclass::StopConditionType         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);

  protected:

    AdaptiveStochasticGradientDescentOptimizer();
    virtual ~AdaptiveStochasticGradientDescentOptimizer() {};

    virtual void UpdateCurrentTime( void );

    DerivativeType m_PreviousGradient;

  private:

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

    bool                          m_UseAdaptiveStepSizes;
    double                        m_SigmoidMax;
    double                        m_SigmoidMin;
    double                        m_SigmoidScale;

  }; // end class AdaptiveStochasticGradientDescentOptimizer


} // end namespace itk


#endif // end #ifndef __itkAdaptiveStochasticGradientDescentOptimizer_h