freOptimizerControllerBase.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: freOptimizerControllerBase.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 __freOptimizerControllerBase_h
#define __freOptimizerControllerBase_h

#include "freControllerBase.h"
#include "freOptimizerControllerInterface.h"

#include "itkOptimizer.h"

namespace FREE
{

  freControllerIDMacro(OptimizerControllerBase, "OptimizerBase");
template <class TControlledOptimizer>
class OptimizerControllerBase : public ComponentControllerBase<TControlledOptimizer>,
                                public OptimizerControllerInterface
{
public:  
  itkTypeMacro(OptimizerControllerBase, ComponentControllerBase);

  typedef ComponentControllerBase<TControlledOptimizer> Superclass;
  typedef typename Superclass::ComponentType ComponentType;
  
  typedef OptimizerControllerInterface::ParametersType ParametersType;
        typedef OptimizerControllerInterface::MeasuresType MeasuresType;

        virtual ~OptimizerControllerBase()
  {};

        virtual ParametersType GetCurrentPosition(const SessionComponentCache* pComponentCache) const;
        virtual MeasuresType GetCurrentValue(const SessionComponentCache* pComponentCache) const;

        virtual ParametersType GetCurrentPosition(TControlledOptimizer* pOptimizer) const;
        virtual MeasuresType GetCurrentValue(TControlledOptimizer* pOptimizer) const;

  virtual long GetMaxIterationCount(const SessionComponentCache* pComponentCache, unsigned int iResolutionLevel = 0) const;

protected:
  OptimizerControllerBase();

  virtual void SetStatisticEntryMainComponent(StatisticEntry& rStatisticEntry,
                                             ComponentType* pMainComponent,
                                             SessionComponentCache* pMainComponentCache,
                                             SessionInfo* pSessionInfo,
                                             StatisticDictionary& rDictionary) const;
  /* Searches for the main transform within the same section, and returns the scales of the
   * current layer/level as an itk:Array.
   * \param pComponentCache Pointer to the optimizer
   * \param iCurLevel Current level index for which the scales are needed.
   * \return The Scaling as itk:Array. If the scaling cannot be retreived, an exception
   * will be thrown.*/
  ParameterArrayType GetTransformScales(SessionComponentCache* pOptimizerCache, const Parameter::LayerCountType& iCurLevel) const;

};

//The generic controller of the base class of all optimizers
typedef OptimizerControllerInterface GenericOptimizerController;

} //end of namespace FREE

#ifndef ITK_MANUAL_INSTANTIATION
#include "freOptimizerControllerBase.txx"
#endif

#endif

---