itkGradientDescentLineSearchOptimizerv4.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 __itkGradientDescentLineSearchOptimizerv4_h
#define __itkGradientDescentLineSearchOptimizerv4_h

#include "itkGradientDescentOptimizerv4.h"
#include "itkOptimizerParameterScalesEstimator.h"
#include "itkWindowConvergenceMonitoringFunction.h"

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

  itkTypeMacro(GradientDescentLineSearchOptimizerv4, GradientDescentOptimizerv4);

  itkNewMacro(Self);

  typedef Superclass::DerivativeType      DerivativeType;

  typedef Superclass::MeasureType                  MeasureType;
  typedef Superclass::InternalComputationValueType InternalComputationValueType;

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

  itkSetMacro( Epsilon , InternalComputationValueType );
  itkGetMacro( Epsilon , InternalComputationValueType );

  itkSetMacro( LowerLimit , InternalComputationValueType );
  itkGetMacro( LowerLimit , InternalComputationValueType );
  itkSetMacro( UpperLimit , InternalComputationValueType );
  itkGetMacro( UpperLimit , InternalComputationValueType );
  itkSetMacro( MaximumLineSearchIterations , unsigned int );
  itkGetMacro( MaximumLineSearchIterations , unsigned int );

protected:

  virtual void AdvanceOneStep(void);

  GradientDescentLineSearchOptimizerv4();

  virtual ~GradientDescentLineSearchOptimizerv4();

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

  InternalComputationValueType GoldenSectionSearch( InternalComputationValueType a, InternalComputationValueType b, InternalComputationValueType c );

  InternalComputationValueType m_LowerLimit;
  InternalComputationValueType m_UpperLimit;
  InternalComputationValueType m_Phi;
  InternalComputationValueType m_Resphi;
  InternalComputationValueType m_Epsilon;

  unsigned int      m_MaximumLineSearchIterations;

  unsigned int      m_LineSearchIterations;

private:

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

};

} // end namespace itk

#endif