elxConjugateGradient.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 __elxConjugateGradient_h
#define __elxConjugateGradient_h
 
#include "elxIncludes.h" // include first to avoid MSVS warning
#include "itkGenericConjugateGradientOptimizer.h"
#include "itkMoreThuenteLineSearchOptimizer.h"
 
namespace elastix
{
 
template< class TElastix >
class ConjugateGradient :
  public
  itk::GenericConjugateGradientOptimizer,
  public
  OptimizerBase< TElastix >
{
public:
 
  typedef ConjugateGradient                 Self;
  typedef GenericConjugateGradientOptimizer Superclass1;
  typedef OptimizerBase< TElastix >         Superclass2;
  typedef itk::SmartPointer< Self >         Pointer;
  typedef itk::SmartPointer< const Self >   ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( ConjugateGradient, GenericConjugateGradientOptimizer );
 
  elxClassNameMacro( "ConjugateGradient" );
 
  typedef Superclass1::CostFunctionType    CostFunctionType;
  typedef Superclass1::CostFunctionPointer CostFunctionPointer;
  typedef Superclass1::StopConditionType   StopConditionType;
  typedef Superclass1::ParametersType      ParametersType;
  typedef Superclass1::DerivativeType      DerivativeType;
  typedef Superclass1::ScalesType          ScalesType;
 
  typedef typename Superclass2::ElastixType          ElastixType;
  typedef typename Superclass2::ElastixPointer       ElastixPointer;
  typedef typename Superclass2::ConfigurationType    ConfigurationType;
  typedef typename Superclass2::ConfigurationPointer ConfigurationPointer;
  typedef typename Superclass2::RegistrationType     RegistrationType;
  typedef typename Superclass2::RegistrationPointer  RegistrationPointer;
  typedef typename Superclass2::ITKBaseType          ITKBaseType;
 
  typedef itk::MoreThuenteLineSearchOptimizer    LineOptimizerType;
  typedef LineOptimizerType::Pointer             LineOptimizerPointer;
  typedef itk::ReceptorMemberCommand< Self >     EventPassThroughType;
  typedef typename EventPassThroughType::Pointer EventPassThroughPointer;
 
  void StartOptimization( void ) override;
 
  void BeforeRegistration( void ) override;
 
  void BeforeEachResolution( void ) override;
 
  void AfterEachResolution( void ) override;
 
  void AfterEachIteration( void ) override;
 
  void AfterRegistration( void ) override;
 
  itkGetConstMacro( StartLineSearch, bool );
 
protected:
 
  ConjugateGradient();
  ~ConjugateGradient() override {}
 
  LineOptimizerPointer m_LineOptimizer;
 
  virtual std::string GetLineSearchStopCondition( void ) const;
 
  virtual std::string DeterminePhase( void ) const;
 
  bool TestConvergence( bool firstLineSearchDone ) override;
 
  void LineSearch(
    const ParametersType searchDir,
    double & step,
    ParametersType & x,
    MeasureType & f,
    DerivativeType & g ) override;
 
private:
 
  ConjugateGradient( const Self & );  // purposely not implemented
  void operator=( const Self & );     // purposely not implemented
 
  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 "elxConjugateGradient.hxx"
#endif
 
#endif // end #ifndef __elxConjugateGradient_h