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 ITK_TEMPLATE_EXPORT GradientDescentLineSearchOptimizerv4Template
: public GradientDescentOptimizerv4Template<TInternalComputationValueType>
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(GradientDescentLineSearchOptimizerv4Template);

  using Self = GradientDescentLineSearchOptimizerv4Template;
  using Superclass = GradientDescentOptimizerv4Template<TInternalComputationValueType>;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(GradientDescentLineSearchOptimizerv4Template, Superclass);

  itkNewMacro(Self);

  using InternalComputationValueType = TInternalComputationValueType;

  using DerivativeType = typename Superclass::DerivativeType;

  using MeasureType = typename Superclass::MeasureType;
  using ParametersType = typename Superclass::ParametersType;

  using ConvergenceMonitoringType = itk::Function::WindowConvergenceMonitoringFunction<TInternalComputationValueType>;

  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:
  void AdvanceOneStep() override;

  GradientDescentLineSearchOptimizerv4Template();

  ~GradientDescentLineSearchOptimizerv4Template() override = default;

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

  TInternalComputationValueType GoldenSectionSearch( TInternalComputationValueType a,
                                                     TInternalComputationValueType b,
                                                     TInternalComputationValueType c,
                                                     TInternalComputationValueType metricb = NumericTraits<TInternalComputationValueType>::max());

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

  unsigned int      m_MaximumLineSearchIterations;

  unsigned int      m_LineSearchIterations;
};

using GradientDescentLineSearchOptimizerv4 = GradientDescentLineSearchOptimizerv4Template<double>;

} // end namespace itk

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

#endif