itkFastSymmetricForcesDemonsRegistrationFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkFastSymmetricForcesDemonsRegistrationFilter.h,v $
  Language:  C++
  Date:      $Date: 2008-12-06 13:28:10 $
  Version:   $Revision: 1.3 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/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 __itkFastSymmetricForcesDemonsRegistrationFilter_h
#define __itkFastSymmetricForcesDemonsRegistrationFilter_h

#include "itkPDEDeformableRegistrationFilter.h"
#include "itkESMDemonsRegistrationFunction.h"

#include "itkMultiplyByConstantImageFilter.h"
#include "itkExponentialDeformationFieldImageFilter.h"
#include "itkWarpVectorImageFilter.h"
#include "itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h"
#include "itkAddImageFilter.h"

namespace itk {

template<class TFixedImage, class TMovingImage, class TDeformationField>
class ITK_EXPORT FastSymmetricForcesDemonsRegistrationFilter : 
    public PDEDeformableRegistrationFilter< TFixedImage, TMovingImage,
                                            TDeformationField>
{
public:
  typedef FastSymmetricForcesDemonsRegistrationFilter     Self;
  typedef PDEDeformableRegistrationFilter<
    TFixedImage, TMovingImage,TDeformationField>          Superclass;
  typedef SmartPointer<Self>                              Pointer;
  typedef SmartPointer<const Self>                        ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro( FastSymmetricForcesDemonsRegistrationFilter, 
                PDEDeformableRegistrationFilter );

  typedef typename Superclass::FixedImageType             FixedImageType;
  typedef typename Superclass::FixedImagePointer          FixedImagePointer;

  typedef typename Superclass::MovingImageType            MovingImageType;
  typedef typename Superclass::MovingImagePointer         MovingImagePointer;

  typedef typename Superclass::DeformationFieldType       DeformationFieldType;
  typedef typename Superclass::DeformationFieldPointer    DeformationFieldPointer;

  virtual double GetMetric() const;
  virtual const double &GetRMSChange() const;

  typedef ESMDemonsRegistrationFunction<
    FixedImageType, 
    MovingImageType, DeformationFieldType>                DemonsRegistrationFunctionType;

  typedef typename DemonsRegistrationFunctionType::GradientType GradientType;
  virtual void SetUseGradientType( GradientType gtype );
  virtual GradientType GetUseGradientType() const;

  virtual void SetIntensityDifferenceThreshold(double);
  virtual double GetIntensityDifferenceThreshold() const;

  virtual void SetMaximumUpdateStepLength(double);
  virtual double GetMaximumUpdateStepLength() const;

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

  virtual void InitializeIteration();

  virtual void AllocateUpdateBuffer();

  typedef typename 
    Superclass::FiniteDifferenceFunctionType              FiniteDifferenceFunctionType;

  typedef typename 
    FiniteDifferenceFunctionType::TimeStepType            TimeStepType;

  virtual void ApplyUpdate(TimeStepType dt);

  typedef MultiplyByConstantImageFilter<
    DeformationFieldType, 
    TimeStepType, DeformationFieldType >                  MultiplyByConstantType;

  typedef AddImageFilter<
     DeformationFieldType, 
     DeformationFieldType, DeformationFieldType>          AdderType;


  typedef typename MultiplyByConstantType::Pointer        MultiplyByConstantPointer;
  typedef typename AdderType::Pointer                     AdderPointer;


private:
  FastSymmetricForcesDemonsRegistrationFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  DemonsRegistrationFunctionType *  DownCastDifferenceFunctionType();
  const DemonsRegistrationFunctionType *  DownCastDifferenceFunctionType() const;

  MultiplyByConstantPointer         m_Multiplier;
  AdderPointer                      m_Adder;
};


} // end namespace itk

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

#endif