freOptimizerControllerBase.txx

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: freOptimizerControllerBase.txx,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 __freOptimizerControllerBase_txx
#define __freOptimizerControllerBase_txx

#include "freOptimizerControllerBase.h"

namespace FREE
{



template <class TControlledOptimizer>
OptimizerControllerBase<TControlledOptimizer>::
OptimizerControllerBase():ComponentControllerBase<TControlledOptimizer>()
{
  this->UpdateControllerID(ControllerID::OptimizerControllerBase);
  this->m_Description = "Base class for optimizer controller; not for practical use.";
};

template <class TControlledOptimizer>
void
OptimizerControllerBase<TControlledOptimizer>::
SetStatisticEntryMainComponent(StatisticEntry& rStatisticEntry,
                                             ComponentType* pMainComponent,
                                             SessionComponentCache* pMainComponentCache,
                                             SessionInfo* pSessionInfo,
                                             StatisticDictionary& rDictionary) const
{
  ParameterArrayType parameters = pMainComponent->GetCurrentPosition();
  std::string sName = "Position #";
  std::string sIDPath = pMainComponentCache->GetIDPath();
  std::string sCommment = "Optimizer position. Meaning depends on chosen transformation";
  StatisticValueDefinition* pEntry = rDictionary.GetValueDefinitionByName(sIDPath,sName+"0");
    
  if (!pEntry) //Entry is not recorded yet, so do so.
  {
    pEntry = rDictionary.AddValueDefinition(sIDPath,sName+"0", sCommment);
    for (unsigned int i = 1; i<parameters.Size(); i++)
    {
      rDictionary.AddValueDefinition(sIDPath,sName+Convert::ToStr(i),sCommment);
    }
  }
  
  for (unsigned int i = 0; i<parameters.Size(); i++)
  {
    rStatisticEntry.AddValue(Convert::ToStr(parameters.GetElement(i)),pEntry->GetRefID()+i);
  }
};

template <class TControlledOptimizer>
typename OptimizerControllerBase<TControlledOptimizer>::ParametersType
OptimizerControllerBase<TControlledOptimizer>::
GetCurrentPosition(const SessionComponentCache* pComponentCache) const
{
        if (!pComponentCache) throwCtrlExceptionMacro("","Passed pComponentCache is NULL.");
        if (!pComponentCache->ComponentIsAssigned()) throwCtrlExceptionMacro("","Cache has no component assigned.");

        return GetCurrentPosition(dynamic_cast<TControlledOptimizer*>(pComponentCache->Component().GetPointer()));
};

template <class TControlledOptimizer>
typename OptimizerControllerBase<TControlledOptimizer>::ParametersType
OptimizerControllerBase<TControlledOptimizer>::
GetCurrentPosition(TControlledOptimizer* pOptimizer) const
{
        return pOptimizer->GetCurrentPosition();
};

template <class TControlledOptimizer>
typename OptimizerControllerBase<TControlledOptimizer>::MeasuresType
OptimizerControllerBase<TControlledOptimizer>::
GetCurrentValue(const SessionComponentCache* pComponentCache) const
{
        if (!pComponentCache) throwCtrlExceptionMacro("","Passed pComponentCache is NULL.");
        if (!pComponentCache->ComponentIsAssigned()) throwCtrlExceptionMacro("","Cache has no setup assigned.");

        return GetCurrentValue(static_cast<TControlledOptimizer*>(pComponentCache->Component().GetPointer()));
};

template <class TControlledOptimizer>
typename OptimizerControllerBase<TControlledOptimizer>::MeasuresType
OptimizerControllerBase<TControlledOptimizer>::
GetCurrentValue(TControlledOptimizer* pOptimizer) const
{
        //depends on the derivates class.
        MeasuresType values(1);
        values.Fill(0.0);
        return values;
};

template <class TControlledOptimizer>
long
OptimizerControllerBase<TControlledOptimizer>::
GetMaxIterationCount(const SessionComponentCache* pComponentCache, unsigned int iResolutionLevel) const
{
        if (!pComponentCache) throwCtrlExceptionMacro("","Passed pComponentCache is NULL.");
        if (!pComponentCache->SetupIsAssigned()) throwCtrlExceptionMacro("","Cache has no setup assigned.");

  long lIterations;

  try
  {
    SessionAccessor::GetParameterValue(pComponentCache,cParam_Iterations,lIterations,0,iResolutionLevel,true);
  }
  catch(...)
  {
    return -1;
  }

  return lIterations;
};

template <class TControlledOptimizer>
ParameterArrayType
OptimizerControllerBase<TControlledOptimizer>::
 GetTransformScales(SessionComponentCache* pOptimizerCache, const Parameter::LayerCountType& iCurLevel) const
{
  Parameter::Pointer param = SessionAccessor::GetParameterByIDPath(pOptimizerCache,IDPath("../"+ComponentID(cComp_MainTransform)+"/@"+cParam_TransformScale));
  if (param.IsNull()) throwCtrlExceptionMacro("","Error; no main transform or scale parameter found to retrieve the scaling.");

  Parameter::LayerCountType iActLevel = iCurLevel;

  if (param->LayerCount()<=iActLevel) iActLevel = param->LayerCount()-1;

  ParameterArrayType scales(0);
  
  if (param->LayerCount()>0) scales = Convert::ParameterLayerToArray<ParameterArrayType>(*(param->GetParameterLayer(iActLevel)));

  return scales;
};

} //end of namespace FREE

#endif

---