freHistogramMetricControllerBase.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: freHistogramMetricControllerBase.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 __freHistogramMetricControllerBase_h
#define __freHistogramMetricControllerBase_h

#include "freImageToImageMetricControllerBase.h"
#include "freTransformSetupAdaptor.h"

#include "itkHistogramImageToImageMetric.h"

namespace FREE
{

  freControllerIDMacro( HistogramMetricControllerBase, "HistogramMetricBase");
template <class TControlledMetric>
class HistogramMetricControllerBase : public ImageToImageMetricControllerBase< TControlledMetric >
{
public:  
  typedef TControlledMetric ComponentType;
  typedef ImageToImageMetricControllerBase<ComponentType> Superclass;

  itkTypeMacro( HistogramMetricControllerBase, ImageToImageMetricControllerBase);

protected:
  HistogramMetricControllerBase()
  {
                //Profile settings
    this->UpdateControllerID(ControllerID::HistogramMetricControllerBase);
    this->m_Description = "Base class for metrics using the intensity histograms.";
        };

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

      //Parameters
      profile.Parameters().AddParameter(cParam_HistSize,Parameter::PVTULong,cParamDsc_HistSize,2,"255",-1,true);
      profile.Parameters().AddParameter(cParam_HistPadValue,Parameter::PVTLong,cParamDsc_HistPadValue,1,"-1",-1,true);
      profile.Parameters().AddParameter(cParam_HistDerivativeStep,Parameter::PVTDouble,cParamDsc_HistDerivativeStep,1,"0.1",-1,true);
                  profile.Parameters().AddParameter(cParam_UpperBoundIncreaseFactor,Parameter::PVTDouble,cParamDsc_UpperBoundIncreaseFactor,1,"0.001");

      //The number of scales must be equal to the number of transformations added to the registration "MainTransform"
      int iScaleCount = 1;
      if (pComponentCache)
      {
        Parameter::Pointer smpTransformParams = SessionAccessor::GetParameterByIDPath(pComponentCache,IDPath("../MainTransform/TransformScale"));
        if (smpTransformParams.IsNotNull())
        {
          iScaleCount = smpTransformParams->ParameterSize();
        }
      }

      profile.Parameters().AddParameter(cParam_HistDerivativeScales,Parameter::PVTDouble,cParamDsc_HistDerivativeScales,iScaleCount,"0",-1,true);
  };

        virtual void ActualizeMainComponent(ComponentType* pMainComponent,
                                      SessionComponentCache* pComponentCache,
                                      SessionInfo* pSessionInfo,
                                                                                                                                                        const unsigned int& iActLevel) const
        {
                unsigned long lHistSize;
    long lPadValue;
    double dDerivativeStep;
    bool bDerivativeScales;
                double dUpperBoundFactor;
    itk::Size<2> histSize;
    try
    {
      SessionAccessor::GetParameterValue(pComponentCache,cParam_HistSize,lHistSize,0,iActLevel,true);
      histSize[0] = lHistSize;
      SessionAccessor::GetParameterValue(pComponentCache,cParam_HistSize,lHistSize,1,iActLevel,true);
      histSize[1] = lHistSize;

      SessionAccessor::GetParameterValue(pComponentCache,cParam_HistPadValue,lPadValue,0,iActLevel,true);
      SessionAccessor::GetParameterValue(pComponentCache,cParam_HistDerivativeStep,dDerivativeStep,0,iActLevel,true);
      SessionAccessor::GetParameterValue(pComponentCache,cParam_HistDerivativeScales,bDerivativeScales,0,iActLevel,true);
      SessionAccessor::GetParameterValue(pComponentCache,cParam_UpperBoundIncreaseFactor,dUpperBoundFactor,0,iActLevel,true);
    }
    catchAllNPassMacro("Error while retrieving parameter values.");   

    TransformSetupAdaptor adaptor(pComponentCache->Setup()->GetComponentByIDPath("../"+ComponentID(cComp_MainTransform)));
    if (adaptor.GetActualComponent()==NULL) throwCtrlExceptionMacro("","No main transform found to get the number of transform parameters. Ensure to use the metric with a rigid registration processor.");

    itk::Array<double> scales = adaptor.GetScales(iActLevel);
    if (!bDerivativeScales) scales.Fill(1); //if !bDerivativeScales, all parameters should be treated equal

    pMainComponent->SetHistogramSize( histSize );
    pMainComponent->SetPaddingValue( lPadValue );
    pMainComponent->SetUsePaddingValue( lPadValue>-1 );
    pMainComponent->SetDerivativeStepLength( dDerivativeStep );
    pMainComponent->SetDerivativeStepLengthScales( scales );
                pMainComponent->SetUpperBoundIncreaseFactor( dUpperBoundFactor );
  };
};

} //end of namespace free

#endif

---