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 MultiGradientOptimizerv4Template
: public GradientDescentOptimizerv4Template<TInternalComputationValueType>
{
public:
  typedef MultiGradientOptimizerv4Template                             Self;
  typedef GradientDescentOptimizerv4Template<TInternalComputationValueType>  Superclass;
  typedef SmartPointer< Self >                                         Pointer;
  typedef SmartPointer< const Self >                                   ConstPointer;

  itkTypeMacro(MultiGradientOptimizerv4Template, Superclass);

  itkNewMacro(Self);

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

  typedef typename Superclass::StopConditionType                                             StopConditionType;

  typedef typename Superclass::StopConditionReturnStringType StopConditionReturnStringType;

  typedef typename Superclass::StopConditionDescriptionType  StopConditionDescriptionType;

  typedef TInternalComputationValueType             InternalComputationValueType;

  typedef typename Superclass::MetricType           MetricType;
  typedef typename MetricType::Pointer              MetricTypePointer;

  typedef typename MetricType::DerivativeType       DerivativeType;

  typedef typename Superclass::MeasureType          MeasureType;
  typedef std::vector< MeasureType >                MetricValuesListType;

  itkGetConstReferenceMacro(StopCondition, StopConditionType);

  virtual void StartOptimization( bool doOnlyInitialization = false );

  virtual void StopOptimization(void);

  virtual void ResumeOptimization();

  virtual const StopConditionReturnStringType GetStopConditionDescription() const ITK_OVERRIDE;

  OptimizersListType & GetOptimizersList();

  void SetOptimizersList(OptimizersListType & p);

  const MetricValuesListType & GetMetricValuesList() const;

  protected:

  MultiGradientOptimizerv4Template();
  virtual ~MultiGradientOptimizerv4Template();

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

  /* Common variables for optimization control and reporting */
  bool                          m_Stop;
  StopConditionType             m_StopCondition;
  StopConditionDescriptionType  m_StopConditionDescription;
  OptimizersListType            m_OptimizersList;
  MetricValuesListType          m_MetricValuesList;
  MeasureType                   m_MinimumMetricValue;
  MeasureType                   m_MaximumMetricValue;

  private:
  MultiGradientOptimizerv4Template( const Self & ); //purposely not implemented
  void operator=( const Self& ); //purposely not implemented

};

typedef MultiGradientOptimizerv4Template<double> MultiGradientOptimizerv4;

} // end namespace itk

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

#endif