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:
 
  typedef PreconditionedASGDOptimizer       Self;
  typedef StandardGradientDescentOptimizer  Superclass;
  typedef SmartPointer< Self >              Pointer;
  typedef SmartPointer< const Self >        ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( PreconditionedASGDOptimizer,
    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 );
 
  itkGetConstReferenceMacro( PreconditionVector, ParametersType );
 
protected:
 
  PreconditionedASGDOptimizer();
  ~PreconditionedASGDOptimizer() override {}
 
  void UpdateCurrentTime( void ) override;
 
  DerivativeType m_PreviousSearchDirection;
  ParametersType m_PreconditionVector;
  std::string    m_StepSizeStrategy;
 
private:
 
  PreconditionedASGDOptimizer( 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 namespace itk
 
#endif // end #ifndef __itkPreconditionedASGDOptimizer_h