itkPowellOptimizer.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkPowellOptimizer_h
#define itkPowellOptimizer_h
 
#include "itkVector.h"
#include "itkMatrix.h"
#include "itkSingleValuedNonLinearOptimizer.h"
#include "ITKOptimizersExport.h"
 
namespace itk
{
 
class ITKOptimizers_EXPORT PowellOptimizer : public SingleValuedNonLinearOptimizer
{
public:
  using Self = PowellOptimizer;
  using Superclass = SingleValuedNonLinearOptimizer;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using ParametersType = SingleValuedNonLinearOptimizer::ParametersType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(PowellOptimizer);

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

  itkSetMacro(Maximize, bool);
  itkBooleanMacro(Maximize);
  itkGetConstReferenceMacro(Maximize, bool);

  itkSetMacro(MaximumIteration, unsigned int);
  itkGetConstReferenceMacro(MaximumIteration, unsigned int);

  itkSetMacro(MaximumLineIteration, unsigned int);
  itkGetConstMacro(MaximumLineIteration, unsigned int);

  itkSetMacro(StepLength, double);
  itkGetConstReferenceMacro(StepLength, double);

  itkSetMacro(StepTolerance, double);
  itkGetConstReferenceMacro(StepTolerance, double);

  itkSetMacro(ValueTolerance, double);
  itkGetConstReferenceMacro(ValueTolerance, double);

  itkGetConstReferenceMacro(CurrentCost, MeasureType);
  MeasureType
  GetValue() const
  {
    return this->GetCurrentCost();
  }


  itkGetConstReferenceMacro(CurrentIteration, unsigned int);

  itkGetConstReferenceMacro(CurrentLineIteration, unsigned int);

  void
  StartOptimization() override;

  void
  StopOptimization()
  {
    m_Stop = true;
  }
 
  itkGetConstReferenceMacro(CatchGetValueException, bool);
  itkSetMacro(CatchGetValueException, bool);
 
  itkGetConstReferenceMacro(MetricWorstPossibleValue, double);
  itkSetMacro(MetricWorstPossibleValue, double);
 
  std::string
  GetStopConditionDescription() const override;
 
protected:
  PowellOptimizer();
  PowellOptimizer(const PowellOptimizer &);
  ~PowellOptimizer() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  itkSetMacro(CurrentCost, double);

  void
  SetLine(const ParametersType & origin, const vnl_vector<double> & direction);

  double
  GetLineValue(double x) const;
 
  double
  GetLineValue(double x, ParametersType & tempCoord) const;

  void
  SetCurrentLinePoint(double x, double fx);

  void
  Swap(double * a, double * b) const;

  void
  Shift(double * a, double * b, double * c, double d) const;

  virtual void
  LineBracket(double * x1, double * x2, double * x3, double * f1, double * f2, double * f3);
 
  virtual void
  LineBracket(double * x1, double * x2, double * x3, double * f1, double * f2, double * f3, ParametersType & tempCoord);

  virtual void
  BracketedLineOptimize(double   ax,
                        double   bx,
                        double   cx,
                        double   fa,
                        double   functionValueOfb,
                        double   fc,
                        double * extX,
                        double * extVal);
 
  virtual void
  BracketedLineOptimize(double           ax,
                        double           bx,
                        double           cx,
                        double           fa,
                        double           functionValueOfb,
                        double           fc,
                        double *         extX,
                        double *         extVal,
                        ParametersType & tempCoord);
 
  itkGetMacro(SpaceDimension, unsigned int);
  void
  SetSpaceDimension(unsigned int dim)
  {
    this->m_SpaceDimension = dim;
    this->m_LineDirection.set_size(dim);
    this->m_LineOrigin.set_size(dim);
    this->m_CurrentPosition.set_size(dim);
    this->Modified();
  }
 
  itkSetMacro(CurrentIteration, unsigned int);
 
  itkGetMacro(Stop, bool);
  itkSetMacro(Stop, bool);
 
private:
  unsigned int m_SpaceDimension{};

  unsigned int m_CurrentIteration{};
  unsigned int m_CurrentLineIteration{};

  unsigned int m_MaximumIteration{};
  unsigned int m_MaximumLineIteration{};
 
  bool   m_CatchGetValueException{};
  double m_MetricWorstPossibleValue{};

  bool m_Maximize{};

  double m_StepLength{};
  double m_StepTolerance{};
 
  ParametersType     m_LineOrigin{};
  vnl_vector<double> m_LineDirection{};
 
  double m_ValueTolerance{};

  MeasureType m_CurrentCost{};

  bool m_Stop{};
 
  std::ostringstream m_StopConditionDescription{};
}; // end of class
} // end of namespace itk
 
#endif