freConstrainedImageDifferenceSOMetricController.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: freConstrainedImageDifferenceSOMetricController.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 __freConstrainedImageDifferenceSOMetricController_h
#define __freConstrainedImageDifferenceSOMetricController_h

#include "freImageDifferenceSOMetricController.h"

#include "freConstrainedImageDifferenceSOMetric.h"

namespace FREE
{

        freControllerIDMacro(ConstrainedImageDifferenceSOMetricControllerBase, "ConstrainedImageDifferenceSOMetricBase");
template <class TControlledMetric>
class ConstrainedImageDifferenceSOMetricControllerBase : public ImageDifferenceSOMetricControllerBase<TControlledMetric>
{
public:  
  DeclareParameterMacro(MaxConstraintPenalty);
  DeclareParameterMacro(FailureThreshold);
  DeclareParameterMacro(Constraints);

        typedef TControlledMetric ComponentType;
  typedef ImageDifferenceSOMetricControllerBase<ComponentType> Superclass;

        itkTypeMacro(ConstrainedImageDifferenceSOMetricControllerBase, ImageDifferenceSOMetricControllerBase);

protected:
        ConstrainedImageDifferenceSOMetricControllerBase()
        {
                //Profile settings
                this->UpdateControllerID(ControllerID::ConstrainedSetupOptimizationMetricControllerBase);
                this->UpdateControllerID(ControllerID::ImageDifferenceSOMetricControllerBase);
                this->UpdateControllerID(ControllerID::ConstrainedImageDifferenceSOMetricControllerBase);
                this->m_Description = "Base class for image difference setup optimization metric which supports constraints.";
        };

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

                //Parameters
                profile.Parameters().AddParameter(cParam_Constraints,CtrlProfile::Parameter::PVTString,cParamDsc_Constraints,4,"",-1);
                profile.Parameters().AddParameter(cParam_MaxConstraintPenalty,CtrlProfile::Parameter::PVTDouble,cParamDsc_MaxConstraintPenalty,1,"0");
                profile.Parameters().AddParameter(cParam_FailureThreshold,CtrlProfile::Parameter::PVTDouble,cParamDsc_FailureThreshold,1,"0.0");
  };

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

                double dMaxPenalty;
                double dThreshold;

    Parameter::Pointer smpConstraints = SessionAccessor::GetParameter(pComponentCache,cParam_Constraints);
                if (smpConstraints.IsNull()) throwExceptionMacro("Missing parameter: " << cParam_Constraints);

                for (unsigned int index = 0; index < smpConstraints->LayerCount(); index++)
                {
                        int iParamID;
                        std::string sRelationType;
                        std::string sTerm;
                        double dBarrierSize;

                        if (!smpConstraints->GetParameterValue(iParamID,0,index)) throwExceptionMacro("Faulty parameter; cannot retrieve parameter id. constraint #: " << index);
                        if (!smpConstraints->GetParameterValue(sRelationType,1,index)) throwExceptionMacro("Faulty parameter; cannot retrieve relation type. constraint #: " << index);
                        if (!smpConstraints->GetParameterValue(sTerm,2,index)) throwExceptionMacro("Faulty parameter; cannot retrieve constraint term. constraint #: " << index);
                        if (!smpConstraints->GetParameterValue(dBarrierSize,3,index)) throwExceptionMacro("Faulty parameter; cannot retrieve barrier size. constraint #: " << index);

      SetupParameterConstraint::Pointer smpNewCnstr = SetupParameterConstraint::New(iParamID,Convert::ToRelationType(sRelationType),sTerm);
                        pMainComponent->AddConstraint(*(smpNewCnstr.GetPointer()),dBarrierSize);
                }

    try
    {
      SessionAccessor::GetParameterValue(pComponentCache,cParam_MaxConstraintPenalty,dMaxPenalty);
      SessionAccessor::GetParameterValue(pComponentCache,cParam_FailureThreshold,dThreshold);
    }
    catchAllNPassMacro("Error while retrieving parameter values.");    

                pMainComponent->SetMaxConstraintPenalty(dMaxPenalty);
                pMainComponent->SetFailureThreshold(dThreshold);
        };

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

                std::string sIDPath = pMainComponentCache->GetIDPath();
                StatisticValueDefinition* pEntry = rDictionary.GetValueDefinitionByName(sIDPath,"mean error");
            
                if (!pEntry) //Entry is not recorded yet, so do so.
                {
                        pEntry = rDictionary.AddValueDefinition(sIDPath,"mean error", "mean pixel difference");
                        rDictionary.AddValueDefinition(sIDPath,"std error", "standard deviation of the pixel difference.");
                        rDictionary.AddValueDefinition(sIDPath,"min error", "minimum pixel difference");
                        rDictionary.AddValueDefinition(sIDPath,"max error", "maximum pixel difference");
                        rDictionary.AddValueDefinition(sIDPath,"mean image error", "mean sum of differences in images)");
                        rDictionary.AddValueDefinition(sIDPath,"std image error", "standard deviation of the image difference");
                        rDictionary.AddValueDefinition(sIDPath,"min image error", "minimum image difference");
                        rDictionary.AddValueDefinition(sIDPath,"max image error", "maximum image difference");
                        rDictionary.AddValueDefinition(sIDPath,"failure", "number of failed evaluations");
                        rDictionary.AddValueDefinition(sIDPath,"mean duration", "mean duration of an evaluation (tenth of a second).");
                        rDictionary.AddValueDefinition(sIDPath,"std duration", "standard deviation of an evaluation (tenth of a second).");
                        rDictionary.AddValueDefinition(sIDPath,"min duration", "minimum duration of an evaluation (tenth of a second).");
                        rDictionary.AddValueDefinition(sIDPath,"max duration", "maximum duration of an evaluation (tenth of a second).");
 
                        for (unsigned int i = 0; i<values.Size()-13; i++)
                        {
                                rDictionary.AddValueDefinition(sIDPath,"constraint penalty #"+Convert::ToStr(i), "penalty of the constraint #"+Convert::ToStr(i));
                        }
                }
          
                for (unsigned int i = 0; i<values.Size(); i++)
                {
                        rStatisticEntry.AddValue(Convert::ToStr(values[i]),pEntry->GetRefID()+i);
                }
        };

};

template <class TControlledMetric>
const char* const ConstrainedImageDifferenceSOMetricControllerBase<TControlledMetric>::cParam_Constraints = "Constraints";
template <class TControlledMetric>
const char* const ConstrainedImageDifferenceSOMetricControllerBase<TControlledMetric>::cParamDsc_Constraints = "The constraints of the metric. First element is the ID of the constrained parameter, second value indicates the type of relation (0: equal; 1: lesser or equal; 2: greater or equal). The third value is the constraint term. The fourth value is the barrier size.\nParameter IDs, if used in the term have an underscore as prefix.\nExample: 1 | 2 | (_2 * 4) + _3\nBy this constrained parameter 1 should be greater or equal four times parameter 2 + parameter 3.";

template <class TControlledMetric>
const char* const ConstrainedImageDifferenceSOMetricControllerBase<TControlledMetric>::cParam_MaxConstraintPenalty = "MaxConstraintPenalty";
template <class TControlledMetric>
const char* const ConstrainedImageDifferenceSOMetricControllerBase<TControlledMetric>::cParamDsc_MaxConstraintPenalty = "Maximum penalty the barrier function of a constraint can return. This value will be scaled be metric scales, if there is any defined for a constrained.";

template <class TControlledMetric>
const char* const ConstrainedImageDifferenceSOMetricControllerBase<TControlledMetric>::cParam_FailureThreshold = "FailureThreshold";
template <class TControlledMetric>
const char* const ConstrainedImageDifferenceSOMetricControllerBase<TControlledMetric>::cParamDsc_FailureThreshold = "Threshold for the penalty computation, if the penalty is equal or above this threshold, the computation will be accounted as a failure. No evaluations of the adaptations will be done. A value of 0.0 or less deactivates the threshold.";


        freControllerIDMacro(ConstrainedImageDifference2DSOMetricController, "Constrained Image Difference 2D SO Metric");
class ConstrainedImageDifference2DSOMetricController : public ConstrainedImageDifferenceSOMetricControllerBase< ConstrainedImageDifferenceSOMetric<2> >
{
public:  
  typedef ConstrainedImageDifferenceSOMetric<2> ComponentType;
  typedef ConstrainedImageDifferenceSOMetricControllerBase<ComponentType> Superclass;

        itkTypeMacro(ConstrainedConstrainedImageDifference2DSOMetricController, ConstrainedImageDifferenceSOMetricControllerBase);

  ConstrainedImageDifference2DSOMetricController();

};

        freControllerIDMacro(ConstrainedImageDifference3DSOMetricController, "Constrained Image Difference 3D SO Metric");
class ConstrainedImageDifference3DSOMetricController : public ConstrainedImageDifferenceSOMetricControllerBase< ConstrainedImageDifferenceSOMetric<3> >
{
public:  
  typedef ConstrainedImageDifferenceSOMetric<3> ComponentType;
  typedef ConstrainedImageDifferenceSOMetricControllerBase<ComponentType> Superclass;

        itkTypeMacro(ConstrainedConstrainedImageDifference3DSOMetricController, ConstrainedImageDifferenceSOMetricControllerBase);

  ConstrainedImageDifference3DSOMetricController();

};

} //end of namespace free

#endif

---