freVersorRigid3DTransformController.cxx

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: freVersorRigid3DTransformController.cxx,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.

=========================================================================*/

#include "freVersorRigid3DTransformController.h"

#include "freIntensityImageMediaController.h"
#include "freTransformSetupAdaptor.h"

#include "itkCenteredTransformInitializer.h"
#include "itkLandmarkBasedTransformInitializer.h"

namespace FREE
{

DefineParameterMacro(VersorRigid3DTransformController,CenterInitializationType,"CenterInitializationType","Type of rotation center computation and translation initialisation, if not set via ITV.\n0: Use the center specified via the parameter 'Center' (translation is zero).\n1: use geometrical center for calculation\n2: use center of mass of images for calculation.\n3: center and translation is computet via LandmarkBasedInitializer using the initial point sets.\n4: center and translation are defined via the first point in the initial point sets.");
DefineParameterMacro(VersorRigid3DTransformController,Center,"Center","Coordinates of the center used as rotation center if CenterInitializationType = 0.");

VersorRigid3DTransformController::
VersorRigid3DTransformController()
{
  this->UpdateControllerID(ControllerID::VersorRigid3DTransformController);
  this->m_Description = "A versor based rotations and translation in 3 dimensional space.";
};

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

  //Parameters
  profile.Parameters().AddParameter(cParam_CenterInitializationType,Parameter::PVTInteger,cParamDsc_CenterInitializationType,1,"0");
  profile.Parameters().AddParameter(cParam_Center,Parameter::PVTInteger,cParamDsc_Center,3,"0");
  profile.Parameters().AddParameter(cParam_InitialisationMethod,Parameter::PVTInteger,std::string(cParamDsc_InitialisationMethod)+"\n1: rotation (versors) is set by itv\n2: translation is set by itv\n3: versors and translation are set by itv.",1,"0");
  profile.Parameters().AddParameter(cParam_InitialTransformValues,CtrlProfile::Parameter::PVTDouble,"1..3: versor\n4..6: translation vector (x|y|z)",6,"0");
  profile.Parameters().AddParameter(cParam_CurrentTransformValues,CtrlProfile::Parameter::PVTDouble,"1..3: versor\n4..6: translation vector (x|y|z)",6,"0");
  profile.Parameters().AddParameter(cParam_TransformScale,CtrlProfile::Parameter::PVTDouble,"1..3: versor\n4..6: translation vector (x|y|z)",6,"1",-1,true);

  //Media
  profile.MediaMap().AddMedia("movingInitialImage",ControllerID::IntensityImage3DMediaController,DASet,3);
  profile.MediaMap().AddMedia("fixedInitialImage",ControllerID::IntensityImage3DMediaController,DASet,3);

  //Only verso optimizer are allowed to interact with these transformers
  //of the same registration processor  
        CtrlProfile::ProfileOption* pOption = profile.Requirements().AddRequirement(std::string("../")+cComp_MainOptimizer)->AddProfileOption();
        pOption->Inheritance().AddAncestor("VersorRigid3DTransformOptimizerBase");
        pOption->CheckForInheritance();
};

bool
VersorRigid3DTransformController::
SetInitialTransformValues( ComponentType* pTransformComponent,
                           SessionComponentCache* pComponentCache,
                           SessionInfo* pSessionInfo,
                           const int& iInitializeByITV) const
{
  int iCenterType;

  if (!pComponentCache->SetupIsAssigned()) throwCtrlExceptionMacro("","Cannot initialize transform values, transform setup is not assigned in cache.");
  ComponentSetup* pTransformSetup = pComponentCache->Setup();

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

  TransformSetupAdaptor adaptor(pTransformSetup);

  ParameterArrayType itv = adaptor.GetInitialTransformParameters();
  ParameterArrayType fixedCenter(3);
  ParameterArrayType movingCenter(3);

  ReferencePointsAccessor<3> pointsAccessor(pComponentCache);

  typedef ImageTypes<3>::InternalImageType InternalImageType;

  pTransformComponent->SetIdentity();

  if ((1!=(iInitializeByITV&1))||((2!=(iInitializeByITV&2))&&(iCenterType==3)))
  { //rotation and/or translation should be initialized via LandmarkBasedTransformInitializer
    typedef itk::LandmarkBasedTransformInitializer<ComponentType, InternalImageType, InternalImageType> LandmarkInitializerType;
    LandmarkInitializerType::Pointer lmInitializer = LandmarkInitializerType::New();

    if (!pointsAccessor.MovingPointsExist()) throwCtrlExceptionMacro("","Cannot compute rotation via reference points. No moving reference point set defined. Please check media linkage.");
    if (!pointsAccessor.FixedPointsExist()) throwCtrlExceptionMacro("","Cannot compute rotation via reference points. No fixed reference point set defined. Please check media linkage.");

    lmInitializer->SetFixedLandmarks(pointsAccessor.GetFixedPoints()->GetPoints()->CastToSTLContainer());
    lmInitializer->SetMovingLandmarks(pointsAccessor.GetMovingPoints()->GetPoints()->CastToSTLContainer());
    lmInitializer->SetTransform(pTransformComponent);
    lmInitializer->InitializeTransform();
  }

  if (1==(iInitializeByITV&1))
  { //set rotation via ITV
    for (int iIndex=0; iIndex<3; iIndex++)
    {
      pTransformSetup->Parameters().SetParameterValue(cParam_CurrentTransformValues,itv[iIndex],iIndex);
    };
  }
  else
  { //rotation has been initialized via itk::LandmarkBasedTransformInitializer
    for (int iIndex=0; iIndex<3; iIndex++)
    {
      pTransformSetup->Parameters().SetParameterValue(cParam_CurrentTransformValues,pTransformComponent->GetParameters().GetElement(iIndex),iIndex);
    };
  }

  if (2==(iInitializeByITV&2))
  { //set translation via ITV; override any settings done via itk::LandmarkBasedTransformInitializer
    for (int iIndex=0; iIndex<3; iIndex++)
    {
      pTransformSetup->Parameters().SetParameterValue(cParam_CurrentTransformValues,itv[iIndex+3],iIndex+3);
    };
  }
  else
  {
    if (iCenterType==0)
    { //no translation, center via "Center" parameter
      try
      {
        double dCenterValue;
        ImageTypes<3>::PointType centerPoint;
      
        for (int iIndex=0; iIndex<3; iIndex++)
        {
          SessionAccessor::GetParameterValue(pComponentCache,cParam_Center,dCenterValue,iIndex);
          centerPoint[iIndex] = dCenterValue;
        }
        pTransformComponent->SetCenter(centerPoint);
      }
      catchAllNPassMacro("Error while retrieving center point parameter values.");
    }
    else if ((iCenterType==1)||(iCenterType==2))
    { //intitalize center and translation via itk::CenteredTransformInitializer
      typedef itk::CenteredTransformInitializer< ComponentType, InternalImageType, InternalImageType> TransformInitializerType;
      TransformInitializerType::Pointer initializer = TransformInitializerType::New();

      SessionAccessor::GenericMediaPointer smpGenericInitialFixedImage = SessionAccessor::GetLinkedMedia("fixedInitialImage",pComponentCache,pSessionInfo);
      if (smpGenericInitialFixedImage.IsNull()) throwCtrlExceptionMacro("","Cannot set fixed center via initial image. No initial fixed image linked. Please check media linkage.");
      SessionAccessor::GenericMediaPointer smpGenericInitialMovingImage = SessionAccessor::GetLinkedMedia("movingInitialImage",pComponentCache,pSessionInfo);
      if (smpGenericInitialMovingImage.IsNull()) throwCtrlExceptionMacro("","Cannot set moving center via initial image. No initial fixed image linked. Please check media linkage.");
      
      InternalImageType* pInitialFixedImage = 0;
      InternalImageType* pInitialMovingImage = 0;

      try
      {
        pInitialFixedImage = dynamic_cast<InternalImageType*>(smpGenericInitialFixedImage.GetPointer());
      }
      catchAllNPassMacro("Error while casting initial fixed image");
      if (!pInitialFixedImage) throwCtrlExceptionMacro("","Error while casting initial fixed image.");

      try
      {
        pInitialMovingImage = dynamic_cast<InternalImageType*>(smpGenericInitialMovingImage.GetPointer());
      }
      catchAllNPassMacro("Error while casting initial fixed image");
      if (!pInitialMovingImage) throwCtrlExceptionMacro("","Error while casting initial fixed image.");

      initializer->SetTransform( pTransformComponent );
      initializer->SetFixedImage( pInitialFixedImage );
      initializer->SetMovingImage( pInitialMovingImage );

      if (iCenterType==1) initializer->GeometryOn();
      else initializer->MomentsOn();

      initializer->InitializeTransform();

      //write parameters
      for (int iIndex=0; iIndex<3; iIndex++)
      {
        pTransformSetup->Parameters().SetParameterValue(cParam_CurrentTransformValues,pTransformComponent->GetTranslation().GetElement(iIndex),iIndex+3);
      }
    }
    else if (iCenterType==3)
    { //translation and center have been calculated via itk::LandmarkBasedTransformInitializer
      //center is already set only copy translation to the transformvalues parameter
      for (int iIndex=0; iIndex<3; iIndex++)
      {
        pTransformSetup->Parameters().SetParameterValue(cParam_CurrentTransformValues,pTransformComponent->GetTranslation().GetElement(iIndex),iIndex+3);
      }
    }
    else if (iCenterType==4)
    { //First reference is the center point
      if (!pointsAccessor.MovingPointsExist()) throwCtrlExceptionMacro("","Cannot set moving center via reference points. No moving reference point set defined. Please check media linkage.");
      if (!pointsAccessor.FixedPointsExist()) throwCtrlExceptionMacro("","Cannot set fixed center via reference points. No fixed reference point set defined. Please check media linkage.");
      fixedCenter = pointsAccessor.GetFixedPointArray(0);
      movingCenter = pointsAccessor.GetMovingPointArray(0);

      pTransformComponent->SetCenter(pointsAccessor.GetFixedPoint(0));

      //set the translation
      for (int iIndex=0; iIndex<3; iIndex++)
      {
        pTransformSetup->Parameters().SetParameterValue(cParam_CurrentTransformValues,movingCenter[iIndex]-fixedCenter[iIndex],3+iIndex);
      };
    }
  }
  return true;
};

} //end of namespace free

---