itkESMDemonsRegistrationFunction.h

Go to the documentation of this file.

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

Program:   Insight Segmentation & Registration Toolkit
Module:    $RCSfile: itkESMDemonsRegistrationFunction.h,v $
Language:  C++
Date:      $Date: 2008-11-12 13:59:47 $
Version:   $Revision: 1.6 $

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 __itkESMDemonsRegistrationFunction_h
#define __itkESMDemonsRegistrationFunction_h

#include "itkPDEDeformableRegistrationFunction.h"
#include "itkPoint.h"
#include "itkCovariantVector.h"
#include "itkInterpolateImageFunction.h"
#include "itkLinearInterpolateImageFunction.h"
#include "itkCentralDifferenceImageFunction.h"
#include "itkWarpImageFilter.h"

namespace itk {
template<class TFixedImage, class TMovingImage, class TDeformationField>
class ITK_EXPORT ESMDemonsRegistrationFunction :
      public PDEDeformableRegistrationFunction< TFixedImage,
                                                TMovingImage, TDeformationField>
{
public:

  typedef ESMDemonsRegistrationFunction               Self;
  typedef PDEDeformableRegistrationFunction<
    TFixedImage, TMovingImage, TDeformationField >    Superclass;
  typedef SmartPointer<Self>                          Pointer;
  typedef SmartPointer<const Self>                    ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro( ESMDemonsRegistrationFunction,
    PDEDeformableRegistrationFunction );

  typedef typename Superclass::MovingImageType      MovingImageType;
  typedef typename Superclass::MovingImagePointer   MovingImagePointer;
  typedef typename MovingImageType::PixelType       MovingPixelType;

  typedef typename Superclass::FixedImageType       FixedImageType;
  typedef typename Superclass::FixedImagePointer    FixedImagePointer;
  typedef typename FixedImageType::IndexType        IndexType;
  typedef typename FixedImageType::SizeType         SizeType;
  typedef typename FixedImageType::SpacingType      SpacingType;
  typedef typename FixedImageType::DirectionType    DirectionType;

  typedef typename Superclass::DeformationFieldType    DeformationFieldType;
  typedef typename Superclass::DeformationFieldTypePointer
    DeformationFieldTypePointer;

  itkStaticConstMacro(ImageDimension, unsigned int,Superclass::ImageDimension);

  typedef typename Superclass::PixelType            PixelType;
  typedef typename Superclass::RadiusType           RadiusType;
  typedef typename Superclass::NeighborhoodType     NeighborhoodType;
  typedef typename Superclass::FloatOffsetType      FloatOffsetType;
  typedef typename Superclass::TimeStepType         TimeStepType;

  typedef double                                    CoordRepType;
  typedef InterpolateImageFunction<
    MovingImageType,CoordRepType>                   InterpolatorType;
  typedef typename InterpolatorType::Pointer        InterpolatorPointer;
  typedef typename InterpolatorType::PointType      PointType;
  typedef LinearInterpolateImageFunction<
    MovingImageType,CoordRepType>                   DefaultInterpolatorType;

  typedef WarpImageFilter<
    MovingImageType,
    MovingImageType,DeformationFieldType>           WarperType;
  typedef typename WarperType::Pointer              WarperPointer;

  typedef CovariantVector<double,itkGetStaticConstMacro(ImageDimension)> CovariantVectorType;

  typedef CentralDifferenceImageFunction<FixedImageType> GradientCalculatorType;
  typedef typename GradientCalculatorType::Pointer   GradientCalculatorPointer;

  typedef CentralDifferenceImageFunction<MovingImageType,CoordRepType>
    MovingImageGradientCalculatorType;
  typedef typename MovingImageGradientCalculatorType::Pointer
    MovingImageGradientCalculatorPointer;

  void SetMovingImageInterpolator( InterpolatorType * ptr )
    { m_MovingImageInterpolator = ptr; m_MovingImageWarper->SetInterpolator( ptr ); }

  InterpolatorType * GetMovingImageInterpolator(void)
    { return m_MovingImageInterpolator; }

  virtual TimeStepType ComputeGlobalTimeStep(void * itkNotUsed(GlobalData)) const
    { return m_TimeStep; }

  virtual void *GetGlobalDataPointer() const
    {
    GlobalDataStruct *global = new GlobalDataStruct();
    global->m_SumOfSquaredDifference  = 0.0;
    global->m_NumberOfPixelsProcessed = 0L;
    global->m_SumOfSquaredChange      = 0;
    return global;
    }

  virtual void ReleaseGlobalDataPointer( void *GlobalData ) const;

  virtual void InitializeIteration();

  virtual PixelType  ComputeUpdate(const NeighborhoodType &neighborhood,
    void *globalData,
    const FloatOffsetType &offset = FloatOffsetType(0.0));

  virtual double GetMetric() const
    { return m_Metric; }

  virtual const double &GetRMSChange() const
    { return m_RMSChange; }

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

  virtual void SetMaximumUpdateStepLength(double sm)
    {
    this->m_MaximumUpdateStepLength =sm;
    }
  virtual double GetMaximumUpdateStepLength() const
    {
    return this->m_MaximumUpdateStepLength;
    }

  enum GradientType {
    Symmetric=0,
    Fixed=1,
    WarpedMoving=2,
    MappedMoving=3
  };

  virtual void SetUseGradientType( GradientType gtype )
    { m_UseGradientType = gtype; }
  virtual GradientType GetUseGradientType() const
    { return m_UseGradientType; }

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

  typedef ConstNeighborhoodIterator<FixedImageType> FixedImageNeighborhoodIteratorType;

  struct GlobalDataStruct
    {
    double          m_SumOfSquaredDifference;
    unsigned long   m_NumberOfPixelsProcessed;
    double          m_SumOfSquaredChange;
    };

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

  PointType                       m_FixedImageOrigin;
  SpacingType                     m_FixedImageSpacing;
  DirectionType                   m_FixedImageDirection;
  double                          m_Normalizer;

  GradientCalculatorPointer       m_FixedImageGradientCalculator;

  MovingImageGradientCalculatorPointer m_MappedMovingImageGradientCalculator;

  GradientType                    m_UseGradientType;

  InterpolatorPointer             m_MovingImageInterpolator;

  WarperPointer                   m_MovingImageWarper;

  TimeStepType                    m_TimeStep;

  double                          m_DenominatorThreshold;

  double                          m_IntensityDifferenceThreshold;

  double                          m_MaximumUpdateStepLength;

  mutable double                  m_Metric;
  mutable double                  m_SumOfSquaredDifference;
  mutable unsigned long           m_NumberOfPixelsProcessed;
  mutable double                  m_RMSChange;
  mutable double                  m_SumOfSquaredChange;

  mutable SimpleFastMutexLock     m_MetricCalculationLock;
};

} // end namespace itk

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

#endif