freDifferenceHistogramMetricControllerBase.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: freDifferenceHistogramMetricControllerBase.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 __freDifferenceHistogramMetricControllerBase_txx
#define __freDifferenceHistogramMetricControllerBase_txx

#include "freDifferenceHistogramMetricControllerBase.h"
#include "freExceptions.h"

namespace FREE
{

template <class TMetric>
const char* const DifferenceHistogramMetricControllerBase<TMetric> :: cParam_UseMask = "UseMask";
template <class TMetric>
const char* const DifferenceHistogramMetricControllerBase<TMetric> :: cParamDsc_UseMask = "Skip all pixels (of moving/fixed image) with values between masked minimum and maximum for the calculation of the metric measure.";
template <class TMetric>
const char* const DifferenceHistogramMetricControllerBase< TMetric > :: cParam_MaskedMinimum = "MaskedMinimum";
template <class TMetric>
const char* const DifferenceHistogramMetricControllerBase< TMetric > :: cParamDsc_MaskedMinimum = "";
template <class TMetric>
const char* const DifferenceHistogramMetricControllerBase< TMetric > :: cParam_MaskedMaximum = "MaskedMaximum";
template <class TMetric>
const char* const DifferenceHistogramMetricControllerBase< TMetric > :: cParamDsc_MaskedMaximum = "";
template <class TMetric>
const char* const DifferenceHistogramMetricControllerBase< TMetric > :: cParam_UpperBoundIncreaseFactor = "UpperBoundIncreaseFactor";
template <class TMetric>
const char* const DifferenceHistogramMetricControllerBase< TMetric > :: cParamDsc_UpperBoundIncreaseFactor = "Increase factor for the estimation of the upper of the histogram";
template <class TMetric>
const char* const DifferenceHistogramMetricControllerBase< TMetric > :: cParam_DerivativeStepLength = "DerivativeStepLength";
template <class TMetric>
const char* const DifferenceHistogramMetricControllerBase< TMetric > :: cParamDsc_DerivativeStepLength = "Step length for the calculation/estimation of the parameter derivates.";
template <class TMetric>
const char* const DifferenceHistogramMetricControllerBase< TMetric > :: cParam_HistogramSize = "HistogramSize";
template <class TMetric>
const char* const DifferenceHistogramMetricControllerBase< TMetric > :: cParamDsc_HistogramSize = "Size of the histogram; number of bins to use.";

template <class TMetric>
DifferenceHistogramMetricControllerBase< TMetric >::
DifferenceHistogramMetricControllerBase()
{
    //Profile settings
    this->UpdateControllerID(ControllerID::DifferenceHistogramMetricControllerBase);
    this->m_Description = "Basic controller for difference histogram metrics.";
};

template <class TMetric>
void
DifferenceHistogramMetricControllerBase< TMetric >::
GenerateProfile(CtrlProfile::ControllerProfile& profile,
                const SessionComponentCache* pComponentCache,
                bool bRegardOldSetup) const
{
  Superclass::GenerateProfile(profile,pComponentCache,bRegardOldSetup);

  //Parameters
  profile.Parameters().AddParameter(cParam_HistogramSize,Parameter::PVTLong,cParamDsc_HistogramSize,1,"512");
  profile.Parameters().AddParameter(cParam_MaskedMinimum,Parameter::PVTDouble,cParamDsc_MaskedMinimum,1,"0.0");
  profile.Parameters().AddParameter(cParam_MaskedMaximum,Parameter::PVTDouble,cParamDsc_MaskedMaximum,1,"0.0");
  profile.Parameters().AddParameter(cParam_UseMask,Parameter::PVTBool,cParamDsc_MaskedMaximum,1,"false");
  profile.Parameters().AddParameter(cParam_UpperBoundIncreaseFactor,Parameter::PVTDouble,cParamDsc_UpperBoundIncreaseFactor,1,"0.001");
  profile.Parameters().AddParameter(cParam_DerivativeStepLength,Parameter::PVTDouble,cParamDsc_DerivativeStepLength,1,"0.1");
};

template <class TMetric>
void
DifferenceHistogramMetricControllerBase< TMetric >::
ActualizeMainComponent(ComponentType* pMainComponent,
                       SessionComponentCache* pComponentCache,
                       SessionInfo* pSessionInfo,
                       const unsigned int& iActLevel) const
{
    long lHistogramSize;
    double dMaskedMinimum;
    double dMaskedMaximum;
    bool bUseMask;
    double dUpperBoundIncreaseFactor;
    double dDerivativeStepLength;

    try
    {
        SessionAccessor::GetParameterValue(pComponentCache,cParam_HistogramSize,lHistogramSize,0,iActLevel,true);
        SessionAccessor::GetParameterValue(pComponentCache,cParam_UseMask,bUseMask,0,iActLevel,true);
        SessionAccessor::GetParameterValue(pComponentCache,cParam_UpperBoundIncreaseFactor,dUpperBoundIncreaseFactor,0,iActLevel,true);
        SessionAccessor::GetParameterValue(pComponentCache,cParam_DerivativeStepLength,dDerivativeStepLength,0,iActLevel,true);
        SessionAccessor::GetParameterValue(pComponentCache,cParam_MaskedMinimum,dMaskedMinimum,0,iActLevel,true);
        SessionAccessor::GetParameterValue(pComponentCache,cParam_MaskedMaximum,dMaskedMaximum,0,iActLevel,true);
    }
    catchAllNPassMacro("Error while retrieving parameter values.");

    typename ComponentType::HistogramSizeType size;
    size.Fill(lHistogramSize);

    pMainComponent->SetHistogramSize(size);
    pMainComponent->SetUseMask( bUseMask );
    pMainComponent->SetMaskedMinimum( dMaskedMinimum );
    pMainComponent->SetMaskedMaximum( dMaskedMaximum );
    pMainComponent->SetUpperBoundIncreaseFactor( dUpperBoundIncreaseFactor );
    pMainComponent->SetDerivativeStepLength( dDerivativeStepLength );
};


} //end of namespace free

#endif

---