itkExhaustiveOptimizerv4.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 itkExhaustiveOptimizerv4_h
#define itkExhaustiveOptimizerv4_h
 
#include "itkIntTypes.h"
#include "itkObjectToObjectOptimizerBase.h"
 
namespace itk
{
template <typename TInternalComputationValueType>
class ITK_TEMPLATE_EXPORT ExhaustiveOptimizerv4
  : public ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ExhaustiveOptimizerv4);

  using Self = ExhaustiveOptimizerv4;
  using Superclass = ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ExhaustiveOptimizerv4);

  using StepsType = Array<SizeValueType>;

  using typename Superclass::MeasureType;

  using typename Superclass::ParametersType;

  using typename Superclass::ScalesType;
 
  void
  StartOptimization(bool doOnlyInitialization = false) 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);

  std::string
  GetStopConditionDescription() const override;

  void
  SetInitialPosition(const ParametersType & param);

  ParametersType &
  GetInitialPosition()
  {
    return m_InitialPosition;
  }
 
protected:
  ExhaustiveOptimizerv4();
  ~ExhaustiveOptimizerv4() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  AdvanceOneStep();
 
  void
  IncrementIndex(ParametersType & newPosition);
 
protected:
  ParametersType m_InitialPosition{};
  MeasureType    m_CurrentValue{ 0 };
  StepsType      m_NumberOfSteps{ 0 };
  bool           m_Stop{ false };
  double         m_StepLength{ 1.0 };
  ParametersType m_CurrentIndex{ 0 };
  MeasureType    m_MaximumMetricValue{ 0.0 };
  MeasureType    m_MinimumMetricValue{ 0.0 };
  ParametersType m_MinimumMetricValuePosition{};
  ParametersType m_MaximumMetricValuePosition{};
 
private:
  std::ostringstream m_StopConditionDescription{ "" };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkExhaustiveOptimizerv4.hxx"
#endif
 
#endif