freSetupOptimizationMetric.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: freSetupOptimizationMetric.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 __freSetupOptimizationMetric_h
#define __freSetupOptimizationMetric_h

#include "freElementals.h"
#include "freSetupTransform.h"
#include "freAdaptationList.h"
#include "freRegistrationEvents.h"
#include "freSetupOptimizationObserverEvents.h"

#include "itkCostFunction.h"
#include "itkArray.h"
#include "itkObjectFactory.h"
#include "itkNumericTraits.h"

namespace FREE
{

class ITK_EXPORT SetupOptimizationMetric : 
  public itk::CostFunction 
{
public:
  typedef SetupOptimizationMetric           Self;
  typedef itk::CostFunction            Superclass;
  typedef itk::SmartPointer<Self>           Pointer;
  typedef itk::SmartPointer<const Self>     ConstPointer;
 
  itkTypeMacro( SetupOptimizationMetric, CostFunction );
 
  typedef Superclass::ParametersType         ParametersType;

  typedef double                                                                 MeasureType;
  typedef itk::Array<double>                 DecomposedMeasureType;
  typedef itk::Array<double>                 DerivativeType;
  
        typedef itk::Array<double>                                                               MetricScalesType;

  typedef SetupTransform                     TransformType;
  typedef TransformType::Pointer                                         TransformPointer;

        itkSetMacro( Delta, double);
  itkGetMacro( Delta, double);

  itkSetMacro( MetricScales, MetricScalesType );
  itkGetConstReferenceMacro( MetricScales, MetricScalesType );

  virtual MeasureType GetValue( const ParametersType & parameters ) const;
  virtual DecomposedMeasureType GetDecomposedValue( const ParametersType & parameters ) const;

        DecomposedMeasureType GetCurrentDecomposedValue() const;
        MeasureType GetCurrentValue() const;
        ParametersType GetCurrentParameters() const;

  virtual void GetDerivative( const ParametersType & parameters,
                      DerivativeType  & derivative ) const;

  virtual void GetValueAndDerivative( const ParametersType & parameters,
    MeasureType& Value, DerivativeType& Derivative ) const;

  virtual unsigned int GetNumberOfValues(void) const  = 0;

  virtual unsigned int GetNumberOfParameters(void) const;

  itkSetObjectMacro( Transform, TransformType );
  itkGetConstObjectMacro( Transform, TransformType );

  Adaptation::AdaptationList* GetAdaptationList() const;
  void SetAdaptationList(Adaptation::AdaptationList* pAdaptations);

  virtual Statistics& GetMetricStatistic() const {return m_MetricStatistic;};

  virtual void Initialize();

  ProgressEventBase::Pointer fnOnEvaluationProgress;

  ProgressEventBase::Pointer fnOnEvaluationDone;

  ProgressEventBase::Pointer fnOnNextAdaptation;

  ProgressEventBase::Pointer fnOnEvaluationFailed;

protected:
  SetupOptimizationMetric();
  virtual ~SetupOptimizationMetric();

  TransformPointer m_Transform;
  Adaptation::AdaptationList::Pointer m_smpAdaptations;

  IterationEvent<SetupOptimizationMetric>::Pointer m_IterationEvent;

  virtual DecomposedMeasureType ComputeDecomposedValue( const ParametersType & parameters ) const = 0;

  virtual void ComputeDecomposedValueAndDerivative( const ParametersType & parameters,
                                                                                                                                                                                                                DecomposedMeasureType& Value,
                                                                                                                                                                                                                DerivativeType& Derivative) const;

        MeasureType ComposeValue(const DecomposedMeasureType& values) const;

        MetricScalesType m_MetricScales;

        mutable DecomposedMeasureType m_CachedValues;
        mutable DerivativeType m_CachedDerivative;
        mutable ParametersType m_CachedParameters;

  void EnlistLastRegistrationEvaluation() const;
  mutable Statistics m_MetricStatistic;

        double m_Delta;

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


} // end namespace FREE


#endif

---