itkFRPROptimizer.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 itkFRPROptimizer_h
#define itkFRPROptimizer_h

#include "itkPowellOptimizer.h"
#include "ITKOptimizersExport.h"

namespace itk
{
class ITKOptimizers_EXPORT FRPROptimizer:
  public PowellOptimizer
{
public:
  using Self = FRPROptimizer;
  using Superclass = PowellOptimizer;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  using ParametersType = SingleValuedNonLinearOptimizer::ParametersType;

  itkNewMacro(Self);

  itkTypeMacro(FRPROptimizer, PowellOptimizer);

  using CostFunctionType = SingleValuedCostFunction;
  using CostFunctionPointer = CostFunctionType::Pointer;

  itkSetMacro(UseUnitLengthGradient, bool);
  itkGetConstMacro(UseUnitLengthGradient, bool);

  void StartOptimization() override;

  void SetToFletchReeves();

  void SetToPolakRibiere();

protected:
  FRPROptimizer();
  ~FRPROptimizer() override;

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

  virtual void GetValueAndDerivative(ParametersType & p, double *val,
                                     ParametersType *xi);

  virtual void   LineOptimize(ParametersType *p, ParametersType & xi,
                              double *val);

  virtual void   LineOptimize(ParametersType *p, ParametersType & xi,
                              double *val,
                              ParametersType & tempCoord);

private:
  FRPROptimizer(const FRPROptimizer &) = delete;

  typedef enum {
    FletchReeves,
    PolakRibiere
    }               OptimizationType;

  OptimizationType m_OptimizationType;

  bool m_UseUnitLengthGradient;
}; // end of class
} // end of namespace itk

#endif