itkMultiGradientOptimizerv4.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 itkMultiGradientOptimizerv4_h
#define itkMultiGradientOptimizerv4_h

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

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

  using Self = MultiGradientOptimizerv4Template;
  using Superclass = GradientDescentOptimizerv4Template<TInternalComputationValueType>;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(MultiGradientOptimizerv4Template, Superclass);

  itkNewMacro(Self);

  using LocalOptimizerType = itk::GradientDescentOptimizerv4Template<TInternalComputationValueType>;
  using LocalOptimizerPointer = typename itk::GradientDescentOptimizerv4Template<TInternalComputationValueType>::Pointer;
  using ParametersType = typename Superclass::ParametersType;
  using OptimizerType = ObjectToObjectOptimizerBaseTemplate<TInternalComputationValueType>;
  using OptimizerPointer = typename OptimizerType::Pointer;
  using OptimizersListType = std::vector< LocalOptimizerPointer >;
  using OptimizersListSizeType = typename OptimizersListType::size_type;

  using StopConditionType = typename Superclass::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 >;

  const StopConditionType & GetStopCondition() const override
    {
    return this->m_StopCondition;
    }

  void StartOptimization( bool doOnlyInitialization = false ) override;

  void StopOptimization() override;

  void ResumeOptimization() override;

  const StopConditionReturnStringType GetStopConditionDescription() const override;

  OptimizersListType & GetOptimizersList();

  void SetOptimizersList(OptimizersListType & p);

  const MetricValuesListType & GetMetricValuesList() const;

  protected:

  MultiGradientOptimizerv4Template();
  ~MultiGradientOptimizerv4Template() 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;
  OptimizersListType            m_OptimizersList;
  MetricValuesListType          m_MetricValuesList;
  MeasureType                   m_MinimumMetricValue;
  MeasureType                   m_MaximumMetricValue;
};

using MultiGradientOptimizerv4 = MultiGradientOptimizerv4Template<double>;

} // end namespace itk

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

#endif