elxQuasiNewtonLBFGS.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 elxQuasiNewtonLBFGS_h
#define elxQuasiNewtonLBFGS_h
 
#include "elxIncludes.h" // include first to avoid MSVS warning
#include "itkQuasiNewtonLBFGSOptimizer.h"
#include "itkMoreThuenteLineSearchOptimizer.h"
 
namespace elastix
{

 
template <typename TElastix>
class ITK_TEMPLATE_EXPORT QuasiNewtonLBFGS
  : public itk::QuasiNewtonLBFGSOptimizer
  , public OptimizerBase<TElastix>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(QuasiNewtonLBFGS);

  using Self = QuasiNewtonLBFGS;
  using Superclass1 = QuasiNewtonLBFGSOptimizer;
  using Superclass2 = OptimizerBase<TElastix>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(QuasiNewtonLBFGS);

  elxClassNameMacro("QuasiNewtonLBFGS");

  using Superclass1::CostFunctionType;
  using Superclass1::CostFunctionPointer;
  using Superclass1::StopConditionType;
  using Superclass1::ParametersType;
  using Superclass1::DerivativeType;
  using Superclass1::ScalesType;

  using typename Superclass2::ElastixType;
  using typename Superclass2::RegistrationType;
  using ITKBaseType = typename Superclass2::ITKBaseType;

  using LineOptimizerType = itk::MoreThuenteLineSearchOptimizer;
  using LineOptimizerPointer = LineOptimizerType::Pointer;
  using EventPassThroughType = itk::ReceptorMemberCommand<Self>;
  using EventPassThroughPointer = typename EventPassThroughType::Pointer;

  void
  StartOptimization() override;

  void
  BeforeRegistration() override;
 
  void
  BeforeEachResolution() override;
 
  void
  AfterEachResolution() override;
 
  void
  AfterEachIteration() override;
 
  void
  AfterRegistration() override;
 
  itkGetConstMacro(StartLineSearch, bool);
 
protected:
  QuasiNewtonLBFGS();
  ~QuasiNewtonLBFGS() override = default;
 
  LineOptimizerPointer m_LineOptimizer;

  virtual std::string
  GetLineSearchStopCondition() const;

  virtual std::string
  DeterminePhase() const;

  bool
  TestConvergence(bool firstLineSearchDone) override;

  void
  LineSearch(const ParametersType searchDir, double & step, ParametersType & x, MeasureType & f, DerivativeType & g)
    override;
 
private:
  elxOverrideGetSelfMacro;
 
  void
  InvokeIterationEvent(const itk::EventObject & event);
 
  EventPassThroughPointer m_EventPasser;
  double                  m_SearchDirectionMagnitude;
  bool                    m_StartLineSearch;
  bool                    m_GenerateLineSearchIterations;
  bool                    m_StopIfWolfeNotSatisfied;
  bool                    m_WolfeIsStopCondition;
};
 
} // end namespace elastix
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "elxQuasiNewtonLBFGS.hxx"
#endif
 
#endif // end #ifndef elxQuasiNewtonLBFGS_h