otbExhaustiveExponentialOptimizer.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * 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
 *
 * 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 otbExhaustiveExponentialOptimizer_h
#define otbExhaustiveExponentialOptimizer_h
 
#include "itkSingleValuedNonLinearOptimizer.h"
 
namespace otb
{
 
class ITK_ABI_EXPORT ExhaustiveExponentialOptimizer : public itk::SingleValuedNonLinearOptimizer
{
public:
  typedef ExhaustiveExponentialOptimizer      Self;
  typedef itk::SingleValuedNonLinearOptimizer Superclass;
  typedef itk::SmartPointer<Self>             Pointer;
  typedef itk::SmartPointer<const Self>       ConstPointer;
 
  typedef itk::Array<unsigned long> StepsType;
  itkNewMacro(Self);
 
  itkTypeMacro(ExhaustiveExponentialOptimizer, itk::SingleValuedNonLinearOptimizer);
 
  void StartOptimization(void) override;
 
  void StartWalking(void);
  void ResumeWalking(void);
  void StopWalking(void);
 
  itkSetMacro(GeometricProgression, double);
  itkSetMacro(NumberOfSteps, StepsType);
  itkSetMacro(StepLength, double);
  itkGetConstReferenceMacro(GeometricProgression, double);
  itkGetConstReferenceMacro(NumberOfSteps, StepsType);
  itkGetConstReferenceMacro(StepLength, double);
  itkGetConstReferenceMacro(CurrentValue, MeasureType);
  itkGetConstReferenceMacro(MaximumMetricValue, MeasureType);
  itkGetConstReferenceMacro(MinimumMetricValue, MeasureType);
  itkGetConstReferenceMacro(MinimumMetricValuePosition, ParametersType);
  itkGetConstReferenceMacro(MaximumMetricValuePosition, ParametersType);
  itkGetConstReferenceMacro(CurrentIndex, ParametersType);
  itkGetConstReferenceMacro(MaximumNumberOfIterations, unsigned long);
 
protected:
  ExhaustiveExponentialOptimizer();
  ~ExhaustiveExponentialOptimizer() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void AdvanceOneStep(void);
  void IncrementIndex(ParametersType& param);
 
protected:
  MeasureType    m_CurrentValue;
  StepsType      m_NumberOfSteps;
  double         m_StepLength;
  unsigned long  m_CurrentIteration;
  bool           m_Stop;
  unsigned int   m_CurrentParameter;
  double         m_GeometricProgression;
  ParametersType m_CurrentIndex;
  unsigned long  m_MaximumNumberOfIterations;
  MeasureType    m_MaximumMetricValue;
  MeasureType    m_MinimumMetricValue;
  ParametersType m_MinimumMetricValuePosition;
  ParametersType m_MaximumMetricValuePosition;
 
private:
  ExhaustiveExponentialOptimizer(const Self&) = delete;
  void operator=(const Self&) = delete;
};
 
} // end namespace otb
 
#endif