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
{
template<typename TInternalComputationValueType>
class GradientDescentLineSearchOptimizerv4Template
: public GradientDescentOptimizerv4Template<TInternalComputationValueType>
{
public:
  typedef GradientDescentLineSearchOptimizerv4Template                 Self;
  typedef  GradientDescentOptimizerv4Template<TInternalComputationValueType> Superclass;
  typedef SmartPointer< Self >                                         Pointer;
  typedef SmartPointer< const Self >                                   ConstPointer;

  itkTypeMacro(GradientDescentLineSearchOptimizerv4Template, Superclass);

  itkNewMacro(Self);

  typedef TInternalComputationValueType            InternalComputationValueType;

  typedef typename Superclass::DerivativeType      DerivativeType;

  typedef typename Superclass::MeasureType         MeasureType;
  typedef typename Superclass::ParametersType      ParametersType;

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

  itkSetMacro( Epsilon , TInternalComputationValueType );
  itkGetMacro( Epsilon , TInternalComputationValueType );

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

protected:
  virtual void AdvanceOneStep(void);

  GradientDescentLineSearchOptimizerv4Template();

  virtual ~GradientDescentLineSearchOptimizerv4Template();

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

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

  TInternalComputationValueType m_LowerLimit;
  TInternalComputationValueType m_UpperLimit;
  TInternalComputationValueType m_Phi;
  TInternalComputationValueType m_Resphi;
  TInternalComputationValueType m_Epsilon;

  unsigned int      m_MaximumLineSearchIterations;

  unsigned int      m_LineSearchIterations;

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

};

typedef GradientDescentLineSearchOptimizerv4Template<double> GradientDescentLineSearchOptimizerv4;

} // end namespace itk

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

#endif