freSetupOptimizationMetric.cxx

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.cxx,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.

=========================================================================*/
#include "freSetupOptimizationMetric.h"

namespace FREE
{
  
        SetupOptimizationMetric::SetupOptimizationMetric()
        {
                m_Transform = NULL;
                m_smpAdaptations = NULL;
                m_Delta = 0.05;
                m_CachedValues.fill(0.0);
                m_CachedDerivative.fill(0.0);
                m_CachedParameters.fill(0.0);
                m_MetricScales.fill(1.0);

    this->fnOnEvaluationProgress = 0;
    this->fnOnEvaluationDone = 0;
    this->fnOnNextAdaptation = 0;
    this->fnOnEvaluationFailed = 0;
        };

        SetupOptimizationMetric::~SetupOptimizationMetric()
        {
        };

  void
  SetupOptimizationMetric::
  Initialize()
  {
                if (this->m_smpAdaptations.IsNull()) throwExceptionMacro("Error. Cannot calculate metric value, adaptiation list is null.");
                if (this->m_Transform.IsNull()) throwExceptionMacro("Error. Cannot calculate metric value, no setup transform set.");

    //redefine if you need initialization in derived classes
  };

  Adaptation::AdaptationList*
  SetupOptimizationMetric::
  GetAdaptationList() const
  {
    return m_smpAdaptations.GetPointer();
  };

  void
  SetupOptimizationMetric::
  SetAdaptationList(Adaptation::AdaptationList* pAdaptations)
  {
    if (m_smpAdaptations.GetPointer()!=pAdaptations)
    {
      m_smpAdaptations=pAdaptations;
      this->Modified();
    }
  };

  unsigned int
  SetupOptimizationMetric::
	GetNumberOfParameters(void) const
        {
                if (m_Transform.IsNull()) return 0;
                
                return m_Transform->GetNumberOfParameters();
        };

SetupOptimizationMetric::MeasureType
SetupOptimizationMetric::
GetValue( const ParametersType & parameters ) const
{
  m_MetricStatistic.GetData().Reset();

  this->m_CachedValues = ComputeDecomposedValue(parameters);
        this->m_CachedParameters = parameters;

        return ComposeValue(m_CachedValues);
};

SetupOptimizationMetric::DecomposedMeasureType
SetupOptimizationMetric::
GetDecomposedValue( const ParametersType & parameters ) const
{
  m_MetricStatistic.GetData().Reset();

  this->m_CachedValues = ComputeDecomposedValue(parameters);
        this->m_CachedParameters = parameters;
        
        return this->m_CachedValues;
};

SetupOptimizationMetric::DecomposedMeasureType
SetupOptimizationMetric::
GetCurrentDecomposedValue() const
{
        return this->m_CachedValues;
};

SetupOptimizationMetric::MeasureType
SetupOptimizationMetric::
GetCurrentValue() const
{
        return ComposeValue(m_CachedValues);
};

SetupOptimizationMetric::ParametersType
SetupOptimizationMetric::
GetCurrentParameters() const
{
        return this->m_CachedParameters;
};

void
SetupOptimizationMetric::
GetDerivative( const ParametersType & parameters, 
                 DerivativeType & derivative           ) const
{
  m_MetricStatistic.GetData().Reset();

  ComputeDecomposedValueAndDerivative(parameters, m_CachedValues, derivative);
        this->m_CachedDerivative = derivative;
        this->m_CachedParameters = parameters;
}

void
SetupOptimizationMetric::
GetValueAndDerivative(const ParametersType & parameters, 
                        MeasureType & value, DerivativeType  & derivative) const
{
        DecomposedMeasureType values;
  
  m_MetricStatistic.GetData().Reset();

  ComputeDecomposedValueAndDerivative(parameters, values, derivative);

        this->m_CachedValues = values;
        this->m_CachedDerivative = derivative;
        this->m_CachedParameters = parameters;
        value = ComposeValue(m_CachedValues);
}

void
SetupOptimizationMetric::
ComputeDecomposedValueAndDerivative( const ParametersType & parametersconst,
                                                                                                                                                 DecomposedMeasureType& value,
                                                                                                                                                 DerivativeType& derivative) const
{
        throwExceptionMacro("Error: Registration Metrics, cannot calculate gradients by default");
};

SetupOptimizationMetric::MeasureType
SetupOptimizationMetric::
ComposeValue(const DecomposedMeasureType& values) const
{
        MeasureType result = 0.0;

        for(unsigned int i=0; i<values.GetSize(); i++)
  { 
                if (i < m_MetricScales.GetSize())       result += values[i]*this->m_MetricScales[i];
                else result += values[i];
  }

        return result;
};

} // end namespace FREE

---