itkMultiStartOptimizerv4.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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.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 itkMultiStartOptimizerv4_h
#define itkMultiStartOptimizerv4_h

#include "itkObjectToObjectOptimizerBase.h"
#include "itkGradientDescentOptimizerv4.h"

namespace itk
{
template<typename TInternalComputationValueType>
class ITK_TEMPLATE_EXPORT MultiStartOptimizerv4Template
: public ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType>
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(MultiStartOptimizerv4Template);

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

  itkTypeMacro(MultiStartOptimizerv4Template, Superclass);

  itkNewMacro(Self);

  using ParametersType = typename Superclass::ParametersType;
  using ParametersListType = std::vector< ParametersType >;
  using ParameterListSizeType = typename ParametersListType::size_type;

  using OptimizerType = ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType>;
  using OptimizerPointer = typename OptimizerType::Pointer;
  using LocalOptimizerType = typename itk::GradientDescentOptimizerv4Template<TInternalComputationValueType>;
  using LocalOptimizerPointer = typename LocalOptimizerType::Pointer;

  typedef enum {
    MAXIMUM_NUMBER_OF_ITERATIONS,
    COSTFUNCTION_ERROR,
    UPDATE_PARAMETERS_ERROR,
    STEP_TOO_SMALL,
    CONVERGENCE_CHECKER_PASSED,
    OTHER_ERROR
  } StopConditionType;

  using StopConditionReturnStringType = typename Superclass::StopConditionReturnStringType;

  using StopConditionDescriptionType = typename Superclass::StopConditionDescriptionType;

  using InternalComputationValueType = TInternalComputationValueType;

  using MetricType = typename Superclass::MetricType;
  using MetricTypePointer = typename MetricType::Pointer;

  using DerivativeType = typename MetricType::DerivativeType;

  using MeasureType = typename Superclass::MeasureType;
  using MetricValuesListType = std::vector< MeasureType >;

  itkGetConstReferenceMacro(StopCondition, StopConditionType);

  void InstantiateLocalOptimizer();

  void StartOptimization( bool doOnlyInitialization = false ) override;

  virtual void StopOptimization();

  virtual void ResumeOptimization();

  const StopConditionReturnStringType GetStopConditionDescription() const override;

  ParametersListType & GetParametersList();

  void SetParametersList(ParametersListType & p);

  const MetricValuesListType & GetMetricValuesList() const;

  ParametersType GetBestParameters( );

  itkSetObjectMacro( LocalOptimizer, OptimizerType );
  itkGetModifiableObjectMacro(LocalOptimizer, OptimizerType );

  inline ParameterListSizeType GetBestParametersIndex( ) { return this->m_BestParametersIndex; }

protected:
  MultiStartOptimizerv4Template();
  ~MultiStartOptimizerv4Template() override = default;

  void PrintSelf(std::ostream & os, Indent indent) const override;

  /* Common variables for optimization control and reporting */
  bool                          m_Stop{false};
  StopConditionType             m_StopCondition;
  StopConditionDescriptionType  m_StopConditionDescription;
  ParametersListType            m_ParametersList;
  MetricValuesListType          m_MetricValuesList;
  MeasureType                   m_MinimumMetricValue;
  MeasureType                   m_MaximumMetricValue;
  ParameterListSizeType         m_BestParametersIndex;
  OptimizerPointer              m_LocalOptimizer;
};

using MultiStartOptimizerv4 = MultiStartOptimizerv4Template<double>;

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkMultiStartOptimizerv4.hxx"
#endif

#endif