itkMultipleValuedNonLinearVnlOptimizer.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 __itkMultipleValuedNonLinearVnlOptimizer_h
#define __itkMultipleValuedNonLinearVnlOptimizer_h

#include "itkMultipleValuedNonLinearOptimizer.h"
#include "itkMultipleValuedVnlCostFunctionAdaptor.h"
#include "itkCommand.h"

namespace itk
{
class ITK_EXPORT MultipleValuedNonLinearVnlOptimizer:
  public MultipleValuedNonLinearOptimizer
{
public:
  typedef MultipleValuedNonLinearVnlOptimizer Self;
  typedef MultipleValuedNonLinearOptimizer    Superclass;
  typedef SmartPointer< Self >                Pointer;
  typedef SmartPointer< const Self >          ConstPointer;

  itkTypeMacro(MultipleValuedNonLinearVnlOptimizer,
               MultipleValueNonLinearOptimizer);

  typedef Superclass::ParametersType ParametersType;

  virtual void SetCostFunction(MultipleValuedCostFunction *costFunction) = 0;

  void SetUseCostFunctionGradient(bool);

  void UseCostFunctionGradientOn()
  {
    this->SetUseCostFunctionGradient(true);
  }

  void UseCostFunctionGradientOff()
  {
    this->SetUseCostFunctionGradient(false);
  }

  bool GetUseCostFunctionGradient() const;

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

protected:
  MultipleValuedNonLinearVnlOptimizer();
  virtual ~MultipleValuedNonLinearVnlOptimizer();

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

  typedef MultipleValuedVnlCostFunctionAdaptor CostFunctionAdaptorType;

  void SetCostFunctionAdaptor(CostFunctionAdaptorType *adaptor);

  const CostFunctionAdaptorType * GetCostFunctionAdaptor(void) const;

  CostFunctionAdaptorType * GetCostFunctionAdaptor(void);

  CostFunctionAdaptorType * GetNonConstCostFunctionAdaptor(void) const;

  typedef ReceptorMemberCommand< Self > CommandType;

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

  void IterationReport(const EventObject & event);

  CostFunctionAdaptorType *m_CostFunctionAdaptor;
  bool                     m_UseGradient;

  CommandType::Pointer m_Command;

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

#endif