freSingleValuedVnlSOMetricAdaptor.h

Go to the documentation of this file.

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

  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: freSingleValuedVnlSOMetricAdaptor.h,v $
  Language:  C++



  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/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 __freSingleValuedVnlSOMetricAdaptor_h
#define __freSingleValuedVnlSOMetricAdaptor_h

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

#include "itkEventObject.h"
#include "itkCommand.h"


namespace FREE
{
  
class SingleValuedVnlSOMetricAdaptor : 
    public vnl_cost_function
{
public:

  typedef   vnl_vector<double>     InternalParametersType;

  typedef   double                 InternalMeasureType;

  typedef   vnl_vector<double>     InternalDerivativeType;

  typedef SetupOptimizationMetric::ParametersType ParametersType;

        typedef itk::Array<double>                                                               DerivativeType;

  typedef SetupOptimizationMetric::MeasureType           MeasureType;

        typedef SetupOptimizationMetric::DecomposedMeasureType           DecomposedMeasureType;

        typedef itk::Array<double>             ScalesType;

        typedef itk::Array<double>             MetricScalesType;

        virtual const char* GetNameOfClass() const { return "SingleValuedVnlSOMetricAdaptor";};

  SingleValuedVnlSOMetricAdaptor(unsigned int spaceDimension);

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

  const SetupOptimizationMetric * 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 itk::EventObject & event, itk::Command * command) const;

  const MeasureType & GetCachedValue() const;
  const DecomposedMeasureType & GetCachedDecomposedValue() const;
  const DerivativeType & GetCachedDerivative() const;
  const ParametersType & GetCachedCurrentParameters() const;
  
protected:

        void ReportIteration( const itk::EventObject & event ) const;

        virtual ParametersType ConvertInternalToParameter(const InternalParametersType & inparameters);
        virtual InternalParametersType ConvertParameterToInternal(const ParametersType & parameters);

  SetupOptimizationMetric::Pointer                                      m_CostFunction;
  bool                                m_ScalesInitialized;
  ScalesType                          m_Scales;
  bool                                m_NegateCostFunction;
        itk::Object::Pointer                     m_Reporter;
  
  mutable MeasureType                 m_CachedValue;
  mutable DecomposedMeasureType       m_CachedDecomposedValue;
  mutable DerivativeType              m_CachedDerivative;
  mutable ParametersType              m_CachedCurrentParameters;

};  // end of Class CostFunction

    
} // end namespace itk


#endif

---