frePrecisionSOMetricController.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: frePrecisionSOMetricController.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 "frePrecisionSOMetricController.h"
#include "freExceptions.h"

namespace FREE
{

DefineParameterMacro(PrecisionSOMetricController,SampleSize,"SampleSize","Number of metric evaluations that will be used to compute the precision.");

PrecisionSOMetricController::
PrecisionSOMetricController()
{
        //Profile settings
        this->UpdateControllerID(ControllerID::PrecisionSOMetricController);
        this->m_Description = "Controller for a precision metric.";
};

void
PrecisionSOMetricController::
GenerateProfile(CtrlProfile::ControllerProfile& profile,
                const SessionComponentCache* pComponentCache,
                bool bRegardOldSetup) const
{
  Superclass::GenerateProfile(profile,pComponentCache,bRegardOldSetup);

        //Parameters
  unsigned int iCount = 0;
  if (bRegardOldSetup)
  {
    IDPath paramPath = pComponentCache->GetIDPath();
    paramPath = paramPath+IDPath("./EvaluationMetric/@MetricScales");
    Parameter::Pointer metricScales = SessionAccessor::GetParameterByIDPath(pComponentCache,paramPath);

    if ( metricScales.IsNotNull()) iCount = metricScales->ParameterSize();
  }
  profile.Parameters().AddParameter(Superclass::cParam_MetricScales,CtrlProfile::Parameter::PVTDouble,Superclass::cParamDsc_MetricScales,iCount,"1.0");
        profile.Parameters().AddParameter(cParam_SampleSize,CtrlProfile::Parameter::PVTULong,cParamDsc_SampleSize,1,"10");

  //Subcomponents
  profile.SubComponents().AddSubComponent("EvaluationMetric");

  //Requirements
        CtrlProfile::ProfileOption* pOption;
    //metric
        pOption = profile.Requirements().AddRequirement("EvaluationMetric")->AddProfileOption();
        pOption->Inheritance().AddAncestor(ControllerID::SetupOptimizationMetricControllerBase);
        pOption->CheckForInheritance();
};

PrecisionSOMetricController::GenericComponentType* 
PrecisionSOMetricController::
GetSubComponentCasted(ComponentType* pMainComponent, const ComponentID& compID,
                      SessionComponentCache* pMainComponentCache) const
{
        if (compID == "EvaluationMetric") return pMainComponent->GetEvaluationMetric();

        return ComponentControllerBase<ComponentType>::GetSubComponentCasted(pMainComponent, compID, pMainComponentCache);
}; 

void
PrecisionSOMetricController::
SetSubComponentCasted(GenericComponentType* pSubComponent, ComponentType* pMainComponent,
                      const ComponentID compID, SessionComponentCache* pMainComponentCache) const
{
  if (compID == "EvaluationMetric") pMainComponent->SetEvaluationMetric(static_cast<SetupOptimizationMetric*>(pSubComponent));
  else ComponentControllerBase<ComponentType>::SetSubComponentCasted(pSubComponent, pMainComponent, compID, pMainComponentCache);
}; 

void
PrecisionSOMetricController::
ActualizeMainComponent(ComponentType* pMainComponent,
                       SessionComponentCache* pComponentCache,
                       SessionInfo* pSessionInfo,
                                                                                 const unsigned int& iActLevel) const
{
        Superclass::ActualizeMainComponent(pMainComponent, pComponentCache,
                                                                                                                                                 pSessionInfo, iActLevel);

  unsigned long lSampleSize;

        if (!pComponentCache->Setup()->Parameters().GetParameterValue(cParam_SampleSize,lSampleSize)) throwExceptionMacro("Missing parameter: " << cParam_SampleSize);

        pMainComponent->SetSampleSize(lSampleSize);
};

void
PrecisionSOMetricController::
SetStatisticEntryMainComponent(StatisticEntry& rStatisticEntry,
                              ComponentType* pMainComponent,
                              SessionComponentCache* pMainComponentCache,
                              SessionInfo* pSessionInfo,
                              StatisticDictionary& rDictionary) const
{
        ComponentType::DecomposedMeasureType values = pMainComponent->GetCurrentDecomposedValue();

  std::string sIDPath = pMainComponentCache->GetIDPath();
  StatisticValueDefinition* pEntry = rDictionary.GetValueDefinitionByName(sIDPath,"mean #1");
    
        if (!pEntry && values.Size()!=0) //Entry is not recorded yet, so do so.
        {
    unsigned int iValueNr = 1;
    for (unsigned int i = 0; i<values.Size(); i=i+4)
    {
      rDictionary.AddValueDefinition(sIDPath,"mean #"+Convert::ToStr(iValueNr), "mean of evaluation metric value #"+Convert::ToStr(iValueNr));
      rDictionary.AddValueDefinition(sIDPath,"std dev #"+Convert::ToStr(iValueNr), "standard deviation of evaluation metric value #"+Convert::ToStr(iValueNr));
      rDictionary.AddValueDefinition(sIDPath,"min #"+Convert::ToStr(iValueNr), "minimum of evaluation metric value #"+Convert::ToStr(iValueNr));
      rDictionary.AddValueDefinition(sIDPath,"max #"+Convert::ToStr(iValueNr), "maximum of evaluation metric value #"+Convert::ToStr(iValueNr));
      iValueNr++;
    }
        }

  pEntry = rDictionary.GetValueDefinitionByName(sIDPath,"mean #1");

        for (unsigned int i = 0; i<values.Size(); i++)
        {
                rStatisticEntry.AddValue(Convert::ToStr(values[i]),pEntry->GetRefID()+i);
        }
};



} //end of namespace free

---