itkFFDMultiResolutionMethod.h

Go to the documentation of this file.

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

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

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

#ifndef itkFFDMultiResolutionMethod_h
#define itkFFDMultiResolutionMethod_h

#include "itkMultiResolutionDeformableImageRegistrationMethod.h"
#include <itkUCLBSplineTransform.h>

namespace itk
{

template <typename TInputImageType, class TScalarType, unsigned int NDimensions, class TDeformationScalar>
class ITK_EXPORT FFDMultiResolutionMethod : 
public MultiResolutionDeformableImageRegistrationMethod<TInputImageType, TScalarType, NDimensions, TDeformationScalar> 
{
public:
  typedef FFDMultiResolutionMethod                                             Self;
  typedef MultiResolutionDeformableImageRegistrationMethod<TInputImageType, 
                                                           TScalarType, 
                                                           NDimensions,
                                                           TDeformationScalar> Superclass;
  typedef SmartPointer<Self>                                                   Pointer;
  typedef SmartPointer<const Self>                                             ConstPointer;

  itkNewMacro(Self);
  
  itkTypeMacro(FFDMultiResolutionMethod, MultiResolutionDeformableImageRegistrationMethod);

  typedef TInputImageType                                                      InputImageType;
  typedef typename InputImageType::SpacingType                                 InputImageSpacingType;

  typedef UCLBSplineTransform<TInputImageType, TScalarType, 
                           NDimensions, TDeformationScalar >                   UCLBSplineTransformType;
  typedef typename UCLBSplineTransformType::Pointer                               UCLBSplineTransformPointer;

  typedef LocalSimilarityMeasureGradientDescentOptimizer<TInputImageType, 
                                                         TInputImageType,
                                                         TScalarType,
                                                         TDeformationScalar>   OptimizerType;
  typedef OptimizerType*                                                       OptimizerPointer;
  
  itkSetObjectMacro( Transform, UCLBSplineTransformType );
  itkGetObjectMacro( Transform, UCLBSplineTransformType );

  itkSetMacro(MaxStepSizeFactor, TScalarType);
  itkGetMacro(MaxStepSizeFactor, TScalarType);

  itkSetMacro(MinStepSizeFactor, TScalarType);
  itkGetMacro(MinStepSizeFactor, TScalarType);

  void WriteControlPointImage(std::string filename);

  itkSetMacro(FinalControlPointSpacing, InputImageSpacingType);
  itkGetMacro(FinalControlPointSpacing, InputImageSpacingType);
  
protected:
  FFDMultiResolutionMethod();
  virtual ~FFDMultiResolutionMethod() {};

  virtual void BeforeSingleResolutionRegistration();
  
private:
  FFDMultiResolutionMethod(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  UCLBSplineTransformPointer m_Transform;
  
  TScalarType m_MinStepSizeFactor;
  
  TScalarType m_MaxStepSizeFactor;
  
  InputImageSpacingType m_FinalControlPointSpacing;
  
};

} // end namespace itk

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

#endif