itkMultiStageImageRegistrationMethod.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 itkMultiStageImageRegistrationMethod_h
#define itkMultiStageImageRegistrationMethod_h


#include "itkMaskedImageRegistrationMethod.h"
#include <itkImageToImageMetric.h>
#include <itkEulerAffineTransform.h>
#include <itkUCLRegularStepOptimizer.h>

namespace itk
{

template <typename TInputImageType>
class ITK_EXPORT MultiStageImageRegistrationMethod 
: public MaskedImageRegistrationMethod<TInputImageType> 
{
public:

  typedef MultiStageImageRegistrationMethod                        Self;
  typedef MaskedImageRegistrationMethod<TInputImageType>           Superclass;
  typedef SmartPointer<Self>                                       Pointer;
  typedef SmartPointer<const Self>                                 ConstPointer;

  itkNewMacro(Self);
  
  itkTypeMacro(MultiStageImageRegistrationMethod, MaskedImageRegistrationMethod);

  typedef ImageToImageMetric< TInputImageType,
                              TInputImageType >                         MetricType;
  typedef typename MetricType::TransformParametersType                  ParametersType;
  typedef typename MetricType::DerivativeType                           DerivativeType;                                   
  
  typedef itk::EulerAffineTransform<double, 
                                       TInputImageType::ImageDimension,
                                       TInputImageType::ImageDimension> TransformType;
  typedef TransformType*                                                TransformPointer;

  typedef UCLRegularStepOptimizer                                       OptimizerType;
  typedef OptimizerType*                                                OptimizerPointer;
  typedef OptimizerType::ScalesType                                     ScalesType;


protected:

  MultiStageImageRegistrationMethod();
  virtual ~MultiStageImageRegistrationMethod() {};
  void PrintSelf(std::ostream& os, Indent indent) const;

  virtual void DoRegistration() throw (ExceptionObject);

  virtual void DoMultiStageRegistration(OptimizerPointer optimizer, TransformPointer transform) throw (ExceptionObject) {};
  
  itkSetMacro( LoopTolerance, double );
  itkGetMacro( LoopTolerance, double );

  itkSetMacro( MaxNumberOfLoops, unsigned int );
  itkGetMacro( MaxNumberOfLoops, unsigned int );

  itkSetMacro( LoopStepSizeReductionFactor, double);
  itkGetMacro( LoopStepSizeReductionFactor, double);
  
private:
  
  MultiStageImageRegistrationMethod(const Self&); // purposefully not implemented
  void operator=(const Self&);                    // purposefully not implemented

  unsigned int m_MaxNumberOfLoops;
  
  double m_LoopTolerance;
  
  double m_LoopStepSizeReductionFactor;
};


} // end namespace itk

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

#endif