itkSingleValuedNonLinearVnlOptimizerv4.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 itkSingleValuedNonLinearVnlOptimizerv4_h
#define itkSingleValuedNonLinearVnlOptimizerv4_h

#include "ITKOptimizersv4Export.h"

#include "itkObjectToObjectOptimizerBase.h"
#include "itkSingleValuedVnlCostFunctionAdaptorv4.h"
#include "itkCommand.h"

namespace itk
{
class ITKOptimizersv4_EXPORT SingleValuedNonLinearVnlOptimizerv4 :
    public ObjectToObjectOptimizerBaseTemplate<double>
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(SingleValuedNonLinearVnlOptimizerv4);

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

  itkTypeMacro(SingleValuedNonLinearVnlOptimizerv4, ObjectToObjectOptimizerBase)


  using CommandType = ReceptorMemberCommand< Self >;

  using MetricType = Superclass::MetricType;
  using DerivativeType = Superclass::DerivativeType;
  using ParametersType = Superclass::ParametersType;
  using ScalesType = Superclass::ScalesType;

  using StopConditionReturnStringType = Superclass::StopConditionReturnStringType;

  using StopConditionDescriptionType = Superclass::StopConditionDescriptionType;

  void StartOptimization(bool doOnlyInitialization = false) override;

  void SetMetric(MetricType *metric) override = 0;

  itkGetConstReferenceMacro(CachedDerivative, DerivativeType);
  itkGetConstReferenceMacro(CachedCurrentPosition, ParametersType);

  const StopConditionReturnStringType GetStopConditionDescription() const override = 0;

protected:
  SingleValuedNonLinearVnlOptimizerv4();
  ~SingleValuedNonLinearVnlOptimizerv4() override;

  using CostFunctionAdaptorType = SingleValuedVnlCostFunctionAdaptorv4;

  void SetCostFunctionAdaptor(CostFunctionAdaptorType *adaptor);

  const CostFunctionAdaptorType * GetCostFunctionAdaptor() const;

  CostFunctionAdaptorType * GetCostFunctionAdaptor();

  CostFunctionAdaptorType * GetNonConstCostFunctionAdaptor() const;

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

private:
  void IterationReport(const EventObject & event);

  CostFunctionAdaptorType *m_CostFunctionAdaptor;

  CommandType::Pointer m_Command;

  mutable ParametersType m_CachedCurrentPosition;
  mutable DerivativeType m_CachedDerivative;
};
} // end namespace itk

#endif