itkLBFGSOptimizerv4.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 itkLBFGSOptimizerv4_h
#define itkLBFGSOptimizerv4_h

#include "itkLBFGSOptimizerBasev4.h"
#include "vnl/algo/vnl_lbfgs.h"
#include "ITKOptimizersv4Export.h"

namespace itk
{
class ITKOptimizersv4_EXPORT LBFGSOptimizerv4:
    public LBFGSOptimizerBasev4< vnl_lbfgs >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(LBFGSOptimizerv4);

  using Self = LBFGSOptimizerv4;
  using Superclass = LBFGSOptimizerBasev4<vnl_lbfgs>;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  using MetricType = Superclass::MetricType;
  using ParametersType = Superclass::ParametersType;
  using ScalesType = Superclass::ScalesType;

  itkNewMacro(Self);

  itkTypeMacro(LBFGSOptimizerv4, Superclass);

  void StartOptimization(bool doOnlyInitialization = false) override;

  void SetMetric(MetricType *metric) override;

  void VerboseOn();
  void VerboseOff();

  void SetLineSearchAccuracy(double tol);

  itkGetConstMacro(LineSearchAccuracy, double);

  void SetDefaultStepLength(double stp);

  itkGetConstMacro(DefaultStepLength, double);

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

  using InternalParametersType = vnl_vector< double >;

  using InternalOptimizerType = vnl_lbfgs;

private:
  bool         m_Verbose{false};
  double       m_LineSearchAccuracy{0.9};
  double       m_DefaultStepLength{1.0};
};
} // end namespace itk
#endif