itkAmoebaOptimizerv4.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 itkAmoebaOptimizerv4_h
#define itkAmoebaOptimizerv4_h
 
#include "itkSingleValuedNonLinearVnlOptimizerv4.h"
#include "vnl/algo/vnl_amoeba.h"
#include "ITKOptimizersv4Export.h"
#include <memory> // For unique_ptr.
 
namespace itk
{
class ITKOptimizersv4_EXPORT AmoebaOptimizerv4 : public SingleValuedNonLinearVnlOptimizerv4
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(AmoebaOptimizerv4);

  using Self = AmoebaOptimizerv4;
  using Superclass = SingleValuedNonLinearVnlOptimizerv4;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(AmoebaOptimizerv4);

  using ParametersType = Superclass::ParametersType;

  using InternalParametersType = vnl_vector<double>;

  void
  StartOptimization(bool doOnlyInitialization = false) override;

  void
  SetMetric(MetricType * metric) override;

  itkSetMacro(AutomaticInitialSimplex, bool);
  itkBooleanMacro(AutomaticInitialSimplex);
  itkGetConstMacro(AutomaticInitialSimplex, bool);

  itkSetMacro(OptimizeWithRestarts, bool);
  itkBooleanMacro(OptimizeWithRestarts);
  itkGetConstMacro(OptimizeWithRestarts, bool);

  void
  SetInitialSimplexDelta(ParametersType initialSimplexDelta, bool automaticInitialSimplex = false);
  itkGetConstMacro(InitialSimplexDelta, ParametersType);

  itkSetMacro(ParametersConvergenceTolerance, double);
  itkGetConstMacro(ParametersConvergenceTolerance, double);

  itkSetMacro(FunctionConvergenceTolerance, double);
  itkGetConstMacro(FunctionConvergenceTolerance, double);

  std::string
  GetStopConditionDescription() const override;

  vnl_amoeba *
  GetOptimizer() const;
 
protected:
  AmoebaOptimizerv4();
  ~AmoebaOptimizerv4() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  using CostFunctionAdaptorType = Superclass::CostFunctionAdaptorType;
 
private:
  void
  ValidateSettings();
 
  ParametersType::ValueType   m_ParametersConvergenceTolerance{};
  MeasureType                 m_FunctionConvergenceTolerance{};
  bool                        m_AutomaticInitialSimplex{};
  ParametersType              m_InitialSimplexDelta{};
  bool                        m_OptimizeWithRestarts{};
  std::unique_ptr<vnl_amoeba> m_VnlOptimizer;
 
  std::ostringstream m_StopConditionDescription{};
};
} // end namespace itk
 
#endif