itkMultipleValuedVnlCostFunctionAdaptor.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkMultipleValuedVnlCostFunctionAdaptor.h,v $
  Language:  C++
  Date:      $Date: 2009-05-12 17:19:46 $
  Version:   $Revision: 1.8 $

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

#include "itkMultipleValuedCostFunction.h"
#include "vnl/vnl_least_squares_function.h"


namespace itk
{
  
class ITK_EXPORT MultipleValuedVnlCostFunctionAdaptor : 
    public vnl_least_squares_function
{
public:

  typedef   vnl_vector<double>     InternalParametersType;

  typedef   vnl_vector<double>     InternalMeasureType;

  typedef   vnl_matrix<double>     InternalDerivativeType;

  typedef MultipleValuedCostFunction::MeasureType   MeasureType;

  typedef MultipleValuedCostFunction::ParametersType ParametersType;

  typedef MultipleValuedCostFunction::DerivativeType DerivativeType;

  typedef Array<double>             ScalesType;

  MultipleValuedVnlCostFunctionAdaptor( unsigned int spaceDimension,
                                        unsigned int numberOfValues );

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

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

  virtual void f( const InternalParametersType & inparameters,
                  InternalMeasureType    & measures      );

  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 );

  void ConvertExternalToInternalMeasures(
    const MeasureType         & input,
    InternalMeasureType & output );

  void SetUseGradient(bool);
  void UseGradientOn()  { this->SetUseGradient( true  ); }
  void UseGradientOff() { this->SetUseGradient( false ); }
  bool GetUseGradient() const;

  void SetScales(const ScalesType & scales);

  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:

  MultipleValuedCostFunction::Pointer   m_CostFunction;

  bool                    m_ScalesInitialized;
  ScalesType              m_Scales;
  Object::Pointer         m_Reporter;

  mutable MeasureType     m_CachedValue;
  mutable DerivativeType  m_CachedDerivative;
  mutable ParametersType  m_CachedCurrentParameters;

};  // end of Class CostFunction

    
} // end namespace itk


#endif