elxConjugateGradientFRPR.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 __elxConjugateGradientFRPR_h
#define __elxConjugateGradientFRPR_h
 
#include "elxIncludes.h" // include first to avoid MSVS warning
#include "itkFRPROptimizer.h"
 
namespace elastix
{
 
template< class TElastix >
class ConjugateGradientFRPR :
  public
  itk::FRPROptimizer,
  public
  OptimizerBase< TElastix >
{
public:
 
  typedef ConjugateGradientFRPR           Self;
  typedef itk::FRPROptimizer              Superclass1;
  typedef OptimizerBase< TElastix >       Superclass2;
  typedef itk::SmartPointer< Self >       Pointer;
  typedef itk::SmartPointer< const Self > ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( ConjugateGradientFRPR, itk::FRPROptimizer );
 
  elxClassNameMacro( "ConjugateGradientFRPR" );
 
  typedef Superclass1::CostFunctionType    CostFunctionType;
  typedef Superclass1::CostFunctionPointer CostFunctionPointer;
  //typedef Superclass1::StopConditionType                  StopConditionType; not implemented in this itkOptimizer
  typedef typename Superclass1::ParametersType ParametersType;
  //not declared in Superclass, although it should be.
  typedef SingleValuedNonLinearOptimizer::DerivativeType DerivativeType;
 
  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;
 
  void BeforeRegistration( void ) override;
 
  void BeforeEachResolution( void ) override;
 
  void AfterEachResolution( void ) override;
 
  void AfterEachIteration( void ) override;
 
  void AfterRegistration( void ) override;
 
  void SetInitialPosition( const ParametersType & param ) override;
 
  itkGetConstMacro( LineOptimizing, bool );
  itkGetConstMacro( LineBracketing, bool );
 
  itkGetConstReferenceMacro( CurrentDerivativeMagnitude, double );
 
  itkGetConstReferenceMacro( CurrentStepLength, double );
 
  itkGetConstReferenceMacro( CurrentSearchDirectionMagnitude, double );
 
protected:
 
  ConjugateGradientFRPR();
  ~ConjugateGradientFRPR() override {}
 
  double m_CurrentDerivativeMagnitude;
 
  double m_CurrentSearchDirectionMagnitude;
 
  double m_CurrentStepLength;
 
  itkSetMacro( LineOptimizing, bool );
  itkSetMacro( LineBracketing, bool );
 
  virtual void GetValueAndDerivative( ParametersType p, double * val,
    ParametersType * xi );
 
  void   LineBracket( double * ax, double * bx, double * cx,
    double * fa, double * fb, double * fc ) override;
 
  void   BracketedLineOptimize( double ax, double bx, double cx,
    double fa, double fb, double fc,
    double * extX, double * extVal ) override;
 
  virtual void   LineOptimize( ParametersType * p, ParametersType xi,
    double * val );
 
private:
 
  ConjugateGradientFRPR( const Self & );    // purposely not implemented
  void operator=( const Self & );           // purposely not implemented
 
  bool m_LineOptimizing;
  bool m_LineBracketing;
 
  const char * DeterminePhase( void ) const;
 
};
 
} // end namespace elastix
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "elxConjugateGradientFRPR.hxx"
#endif
 
#endif // end #ifndef __elxConjugateGradientFRPR_h