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 ITK_TEMPLATE_EXPORT ConjugateGradientFRPR
  : public itk::FRPROptimizer
  , public OptimizerBase<TElastix>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ConjugateGradientFRPR);
 
  using Self = ConjugateGradientFRPR;
  using Superclass1 = itk::FRPROptimizer;
  using Superclass2 = OptimizerBase<TElastix>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ConjugateGradientFRPR, itk::FRPROptimizer);
 
  elxClassNameMacro("ConjugateGradientFRPR");
 
  using Superclass1::CostFunctionType;
  using Superclass1::CostFunctionPointer;
  // using Superclass1::StopConditionType; not implemented in this itkOptimizer
  using typename Superclass1::ParametersType;
  // not declared in Superclass, although it should be.
  using DerivativeType = SingleValuedNonLinearOptimizer::DerivativeType;
 
  using typename Superclass2::ElastixType;
  using typename Superclass2::RegistrationType;
  using ITKBaseType = typename Superclass2::ITKBaseType;
 
  void
  BeforeRegistration() override;
 
  void
  BeforeEachResolution() override;
 
  void
  AfterEachResolution() override;
 
  void
  AfterEachIteration() override;
 
  void
  AfterRegistration() 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 = default;
 
  double m_CurrentDerivativeMagnitude;
 
  double m_CurrentSearchDirectionMagnitude;
 
  double m_CurrentStepLength;
 
  itkSetMacro(LineOptimizing, bool);
  itkSetMacro(LineBracketing, bool);
 
  void
  GetValueAndDerivative(ParametersType & p, double * val, ParametersType * xi) override;
 
  void
  LineBracket(double * ax, double * bx, double * cx, double * fa, double * fb, double * fc, ParametersType & tempCoord)
    override;
 
  void
  BracketedLineOptimize(double           ax,
                        double           bx,
                        double           cx,
                        double           fa,
                        double           fb,
                        double           fc,
                        double *         extX,
                        double *         extVal,
                        ParametersType & tempCoord) override;
 
  void
  LineOptimize(ParametersType * p, ParametersType & xi, double * val, ParametersType & tempCoord) override;
 
private:
  elxOverrideGetSelfMacro;
 
  bool m_LineOptimizing;
  bool m_LineBracketing;
 
  const char *
  DeterminePhase() const;
 
  // Private using-declarations, to avoid accidentally calling the wrong overload of those member functions, and to
  // avoid `-Woverloaded-virtual` warnings from GCC (GCC 11.4) or clang (macos-12).
  using itk::PowellOptimizer::LineBracket;
  using itk::PowellOptimizer::BracketedLineOptimize;
  using itk::FRPROptimizer::LineOptimize;
};
 
} // end namespace elastix
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "elxConjugateGradientFRPR.hxx"
#endif
 
#endif // end #ifndef elxConjugateGradientFRPR_h