itkSingleValuedVnlCostFunctionAdaptor.h

Go to the documentation of this file.

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

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

  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 __itkSingleValuedVnlCostFunctionAdaptor_h
#define __itkSingleValuedVnlCostFunctionAdaptor_h

#include "itkSingleValuedCostFunction.h"
#include "vnl/vnl_cost_function.h"


namespace itk
{
  
class SingleValuedVnlCostFunctionAdaptor : 
    public vnl_cost_function
{
public:

  typedef   vnl_vector<double>     InternalParametersType;

  typedef   double                 InternalMeasureType;

  typedef   vnl_vector<double>     InternalDerivativeType;

  typedef SingleValuedCostFunction::ParametersType ParametersType;

  typedef SingleValuedCostFunction::DerivativeType DerivativeType;

  typedef SingleValuedCostFunction::MeasureType MeasureType;

  typedef Array<double>             ScalesType;

  SingleValuedVnlCostFunctionAdaptor(unsigned int spaceDimension);


  void SetCostFunction( SingleValuedCostFunction * costFunction )
    { m_CostFunction = costFunction; }

  const SingleValuedCostFunction * GetCostFunction( void ) const
    { return m_CostFunction; }

  virtual InternalMeasureType f( const InternalParametersType & inparameters );

  virtual void gradf(const InternalParametersType   & inparameters,
                     InternalDerivativeType   & gradient );

  virtual void compute(const InternalParametersType   & x,
                       InternalMeasureType      * f, 
                       InternalDerivativeType   * g   );

  void ConvertExternalToInternalGradient(
    const DerivativeType         & input,
    InternalDerivativeType & output ) const;

  void SetScales(const ScalesType & scales);

  void SetNegateCostFunction( bool value );
  bool GetNegateCostFunction() const;
  void NegateCostFunctionOn() { m_NegateCostFunction = true; }
  void NegateCostFunctionOff() { m_NegateCostFunction = false; }

  unsigned long AddObserver(const EventObject & event, Command *) const;

  const MeasureType & GetCachedValue() const;
  const DerivativeType & GetCachedDerivative() const;
  const ParametersType & GetCachedCurrentParameters() const;

protected:

  void ReportIteration( const EventObject & event ) const;

private:

  SingleValuedCostFunction::Pointer   m_CostFunction;
  bool                                m_ScalesInitialized;
  ScalesType                          m_Scales;
  bool                                m_NegateCostFunction;
  Object::Pointer                     m_Reporter;
  
  mutable MeasureType                 m_CachedValue;
  mutable DerivativeType              m_CachedDerivative;
  mutable ParametersType              m_CachedCurrentParameters;

};  // end of Class CostFunction

    
} // end namespace itk


#endif