itkExhaustiveOptimizer.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 itkExhaustiveOptimizer_h
#define itkExhaustiveOptimizer_h
 
#include "itkIntTypes.h"
#include "itkSingleValuedNonLinearOptimizer.h"
#include "ITKOptimizersExport.h"
 
namespace itk
{
class ITKOptimizers_EXPORT ExhaustiveOptimizer : public SingleValuedNonLinearOptimizer
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ExhaustiveOptimizer);

  using Self = ExhaustiveOptimizer;
  using Superclass = SingleValuedNonLinearOptimizer;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using StepsType = Array<SizeValueType>;
  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ExhaustiveOptimizer);

  void
  StartOptimization() override;
 
  void
  StartWalking();

  void
  ResumeWalking();

  void
  StopWalking();
 
  itkSetMacro(StepLength, double);
  itkSetMacro(NumberOfSteps, StepsType);
  itkGetConstReferenceMacro(StepLength, double);
  itkGetConstReferenceMacro(NumberOfSteps, StepsType);
  itkGetConstReferenceMacro(CurrentValue, MeasureType);
  itkGetConstReferenceMacro(MaximumMetricValue, MeasureType);
  itkGetConstReferenceMacro(MinimumMetricValue, MeasureType);
  itkGetConstReferenceMacro(MinimumMetricValuePosition, ParametersType);
  itkGetConstReferenceMacro(MaximumMetricValuePosition, ParametersType);
  itkGetConstReferenceMacro(CurrentIndex, ParametersType);
  itkGetConstReferenceMacro(MaximumNumberOfIterations, SizeValueType);

  std::string
  GetStopConditionDescription() const override;
 
protected:
  ExhaustiveOptimizer();
  ~ExhaustiveOptimizer() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  AdvanceOneStep();
 
  void
  IncrementIndex(ParametersType & newPosition);
 
protected:
  MeasureType m_CurrentValue{ 0 };
 
  StepsType m_NumberOfSteps{};
 
  SizeValueType m_CurrentIteration{ 0 };
 
  bool m_Stop{ false };
 
  unsigned int m_CurrentParameter{ 0 };
 
  double m_StepLength{ 1.0 };
 
  ParametersType m_CurrentIndex{};
 
  SizeValueType m_MaximumNumberOfIterations{ 1 };
 
  MeasureType m_MaximumMetricValue{ itk::NumericTraits<MeasureType>::max() };
 
  MeasureType m_MinimumMetricValue{ itk::NumericTraits<MeasureType>::Zero };
 
  ParametersType m_MinimumMetricValuePosition{};
 
  ParametersType m_MaximumMetricValuePosition{};
 
private:
  std::ostringstream m_StopConditionDescription{};
};
} // end namespace itk
 
#endif