itkMultipleValuedNonLinearVnlOptimizer.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkMultipleValuedNonLinearVnlOptimizer.h,v $
  Language:  C++
  Date:      $Date: 2007-03-22 21:39:37 $
  Version:   $Revision: 1.25 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#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

---