itkOnePlusOneEvolutionaryOptimizer.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 itkOnePlusOneEvolutionaryOptimizer_h
#define itkOnePlusOneEvolutionaryOptimizer_h
 
#include "itkSingleValuedNonLinearOptimizer.h"
#include "itkRandomVariateGeneratorBase.h"
#include "ITKOptimizersExport.h"
#include <string>
 
namespace itk
{
 
class ITKOptimizers_EXPORT OnePlusOneEvolutionaryOptimizer : public SingleValuedNonLinearOptimizer
{
public:
  using Self = OnePlusOneEvolutionaryOptimizer;
  using Superclass = SingleValuedNonLinearOptimizer;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(OnePlusOneEvolutionaryOptimizer);

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

  using NormalVariateGeneratorType = Statistics::RandomVariateGeneratorBase;

  itkSetMacro(Maximize, bool);
  itkBooleanMacro(Maximize);
  itkGetConstReferenceMacro(Maximize, bool);
 
  bool
  GetMinimize() const
  {
    return !m_Maximize;
  }
  void
  SetMinimize(bool v)
  {
    this->SetMaximize(!v);
  }
  void
  MinimizeOn()
  {
    SetMaximize(false);
  }
  void
  MinimizeOff()
  {
    SetMaximize(true);
  }

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

  itkSetMacro(GrowthFactor, double);
  itkGetConstReferenceMacro(GrowthFactor, double);

  itkSetMacro(ShrinkFactor, double);
  itkGetConstReferenceMacro(ShrinkFactor, double);

  itkSetMacro(InitialRadius, double);
  itkGetConstReferenceMacro(InitialRadius, double);

  itkSetMacro(Epsilon, double);
  itkGetConstReferenceMacro(Epsilon, double);

  itkGetConstReferenceMacro(FrobeniusNorm, double);
 
  void
  SetNormalVariateGenerator(NormalVariateGeneratorType * generator);

  void
  Initialize(double initialRadius, double grow = -1, double shrink = -1);

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


  itkGetConstReferenceMacro(CurrentIteration, unsigned int);

  itkGetConstReferenceMacro(Initialized, bool);

  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:
  OnePlusOneEvolutionaryOptimizer();
  OnePlusOneEvolutionaryOptimizer(const OnePlusOneEvolutionaryOptimizer &);
  ~OnePlusOneEvolutionaryOptimizer() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  NormalVariateGeneratorType::Pointer m_RandomGenerator{};

  unsigned int m_MaximumIteration{};

  unsigned int m_CurrentIteration{};
 
  bool   m_CatchGetValueException{};
  double m_MetricWorstPossibleValue{};

  bool m_Maximize{};

  double m_Epsilon{};

  double m_InitialRadius{};

  double m_GrowthFactor{};

  double m_ShrinkFactor{};

  bool m_Initialized{};

  MeasureType m_CurrentCost{};

  bool m_Stop{};

  std::ostringstream m_StopConditionDescription{};

  double m_FrobeniusNorm{};
}; // end of class
} // end of namespace itk
 
#endif