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 "itkObjectToObjectOptimizerBase.h"
#include "itkSingleValuedVnlCostFunctionAdaptorv4.h"
#include "itkCommand.h"

namespace itk
{
class  SingleValuedNonLinearVnlOptimizerv4 :
    public ObjectToObjectOptimizerBaseTemplate<double>
{
public:
  typedef SingleValuedNonLinearVnlOptimizerv4 Self;
  typedef ObjectToObjectOptimizerBase         Superclass;
  typedef SmartPointer< Self >                Pointer;
  typedef SmartPointer< const Self >          ConstPointer;

  itkTypeMacro(SingleValuedNonLinearVnlOptimizerv4, ObjectToObjectOptimizerBase)


  typedef ReceptorMemberCommand< Self >   CommandType;

  typedef Superclass::MetricType     MetricType;
  typedef Superclass::DerivativeType DerivativeType;
  typedef Superclass::ParametersType ParametersType;
  typedef Superclass::ScalesType     ScalesType;

  typedef Superclass::StopConditionReturnStringType StopConditionReturnStringType;

  typedef Superclass::StopConditionDescriptionType  StopConditionDescriptionType;

  virtual void StartOptimization(bool doOnlyInitialization = false) ITK_OVERRIDE;

  virtual void SetMetric(MetricType *metric) = 0;

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

  virtual const StopConditionReturnStringType GetStopConditionDescription() const = 0;

protected:
  SingleValuedNonLinearVnlOptimizerv4();
  virtual ~SingleValuedNonLinearVnlOptimizerv4();

  typedef SingleValuedVnlCostFunctionAdaptorv4 CostFunctionAdaptorType;

  void SetCostFunctionAdaptor(CostFunctionAdaptorType *adaptor);

  const CostFunctionAdaptorType * GetCostFunctionAdaptor(void) const;

  CostFunctionAdaptorType * GetCostFunctionAdaptor(void);

  CostFunctionAdaptorType * GetNonConstCostFunctionAdaptor(void) const;

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

private:
  void IterationReport(const EventObject & event);

  SingleValuedNonLinearVnlOptimizerv4(const Self &); //purposely not implemented
  void operator=(const Self &);                    //purposely not implemented

  CostFunctionAdaptorType *m_CostFunctionAdaptor;

  CommandType::Pointer m_Command;

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

#endif