freSetupTransformController.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: freSetupTransformController.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 __freSetupTransformController_h
#define __freSetupTransformController_h

#include "freControllerBase.h"

#include "freSetupTransform.h"

namespace FREE
{

freControllerIDMacro(SetupTransformControllerBase, "SetupTransformBase");

template <class TTransformComponent>
class SetupTransformControllerBase : public ComponentControllerBase<TTransformComponent>
{
public:  
  itkTypeMacro(SetupTransformControllerBase, ComponentControllerBase);

  typedef TTransformComponent ComponentType;
  typedef ComponentControllerBase<TTransformComponent> Superclass;

  DeclareParameterMacro(ParameterIDs);
  DeclareParameterMacro(AutoInitialValues);

        SetupTransformControllerBase()
        {
                //Profile settings
                this->UpdateControllerID(ControllerID::SetupTransformControllerBase);
                this->m_Description = "Base controler for a transform of free setups, by changing specified parameters.";
};

protected:
  virtual void GenerateProfile(CtrlProfile::ControllerProfile& profile,
                               const SessionComponentCache* pComponentCache,
                               bool bRegardOldSetup) const
  {
          //Parameters
          profile.Parameters().AddParameter(cParam_ParameterIDs,CtrlProfile::Parameter::PVTString,cParamDsc_ParameterIDs,1,"");
          profile.Parameters().AddParameter(cParam_AutoInitialValues,CtrlProfile::Parameter::PVTBool,cParamDsc_AutoInitialValues,1,"true");

    if (bRegardOldSetup)
    {
      profile.Parameters().AddParameter(cParam_InitialTransformValues,CtrlProfile::Parameter::PVTDouble,"",1,"0.0",-1);
            profile.Parameters().AddParameter(cParam_CurrentTransformValues,CtrlProfile::Parameter::PVTDouble,"",1,"0.0",-1);
    }
    else
    {
      Parameter* pParam = pComponentCache->Setup()->Parameters().GetParameter(cParam_ParameterIDs);
      if (!pParam) throwCtrlExceptionMacro("","Error. Cannot retrieve parameter \"ParameterIDs\". Please ensure that component is properly initialized.");
    
      profile.Parameters().AddParameter(cParam_InitialTransformValues,CtrlProfile::Parameter::PVTDouble,"",1,"0.0",pParam->LayerCount());
            profile.Parameters().AddParameter(cParam_CurrentTransformValues,CtrlProfile::Parameter::PVTDouble,"",1,"0.0",pParam->LayerCount());
    }
  };

        virtual void ActualizeMainComponent(ComponentType* pMainComponent,
                                      SessionComponentCache* pComponentCache,
                                      SessionInfo* pSessionInfo,
                                                                                                                                                        const unsigned int& iActLevel) const
        {
                typedef typename ComponentType::ParametersType ComponentParameterType;
    ComponentParameterType values;
                bool bAutoInitValues;

    try
    {
      SessionAccessor::GetParameterValue(pComponentCache,cParam_AutoInitialValues,bAutoInitValues);
    }
    catchAllNPassMacro("Error while retrieving parameter values.");

                pMainComponent->SetAutoInitialValues(bAutoInitValues);

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

          for (unsigned int index = 0; index < smpParameter->ParameterSize(); index++)
    {
      std::string id;
      smpParameter->GetParameterValue(id,index);
                  pMainComponent->AddParameterID(IDPath(id));
    }

    //set initial values, if needed.
    if (!bAutoInitValues)
    {
      smpParameter = SessionAccessor::GetParameter(pComponentCache,cParam_InitialTransformValues);
      if (smpParameter.IsNull()) throwExceptionMacro("Missing parameter: " << cParam_InitialTransformValues);
            ComponentParameterType values = Convert::ParameterLayerToArray<ComponentParameterType>(*(smpParameter->GetParameterLayer(0)));

      pMainComponent->SetParameters( values );
    }
        };
};  

DefineParameterTemplateMacro(SetupTransformControllerBase<TTransformComponent>, class TTransformComponent,ParameterIDs,"ParameterIDs","Determines parameter values that should be changed.");
DefineParameterTemplateMacro(SetupTransformControllerBase<TTransformComponent>, class TTransformComponent,AutoInitialValues,"AutoInitialValues","Determines if the transform should use the values of the passed setup (true) as initial transform values.");

  freControllerIDMacro(SetupTransformController, "Setup Transform");
class SetupTransformController : public SetupTransformControllerBase<SetupTransform>
{
public:  
  itkTypeMacro(SetupTransformController, SetupTransformControllerBase);

  typedef SetupTransform ComponentType;
  typedef SetupTransformControllerBase<ComponentType> Superclass;

        SetupTransformController();
};  

} //end of namespace free

#endif

---