itkLevelSetMotionRegistrationFunction.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkLevelSetMotionRegistrationFunction.h,v $
  Language:  C++
  Date:      $Date: 2009-10-20 20:39:08 $
  Version:   $Revision: 1.5 $

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

#include "itkPDEDeformableRegistrationFunction.h"
#include "itkPoint.h"
#include "itkVector.h"
#include "itkCovariantVector.h"
#include "itkInterpolateImageFunction.h"
#include "itkLinearInterpolateImageFunction.h"
#include "itkSmoothingRecursiveGaussianImageFilter.h"

namespace itk {

template<class TFixedImage, class TMovingImage, class TDeformationField>
class ITK_EXPORT LevelSetMotionRegistrationFunction :
    public PDEDeformableRegistrationFunction< TFixedImage,
                                              TMovingImage, 
TDeformationField>
{
public:

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

  itkNewMacro(Self);

  itkTypeMacro( LevelSetMotionRegistrationFunction,
                PDEDeformableRegistrationFunction );

  typedef typename Superclass::MovingImageType     MovingImageType;
  typedef typename Superclass::MovingImagePointer  MovingImagePointer;
  typedef typename MovingImageType::SpacingType    MovingSpacingType;

  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 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 Vector<double,itkGetStaticConstMacro(ImageDimension)> VectorType;
  typedef CovariantVector<double,itkGetStaticConstMacro(ImageDimension)>
      CovariantVectorType;

  typedef SmoothingRecursiveGaussianImageFilter<MovingImageType>
      MovingImageSmoothingFilterType;
  typedef typename MovingImageSmoothingFilterType::Pointer
      MovingImageSmoothingFilterPointer;

  void SetMovingImageInterpolator( InterpolatorType * ptr )
  { m_MovingImageInterpolator = ptr; }

  InterpolatorType * GetMovingImageInterpolator(void)
  { return m_MovingImageInterpolator; }

  virtual TimeStepType ComputeGlobalTimeStep(void * GlobalData) const;

  virtual void *GetGlobalDataPointer() const
    {
    GlobalDataStruct *global = new GlobalDataStruct();
    global->m_SumOfSquaredDifference  = 0.0;
    global->m_NumberOfPixelsProcessed = 0L;
    global->m_SumOfSquaredChange      = 0;
    global->m_MaxL1Norm            = NumericTraits<double>::NonpositiveMin();
    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 double GetRMSChange() const
    { return m_RMSChange; }

  virtual void SetAlpha(double);
  virtual double GetAlpha() const;

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

  virtual void SetGradientMagnitudeThreshold(double);
  virtual double GetGradientMagnitudeThreshold() const;

  virtual void SetGradientSmoothingStandardDeviations(double);
  virtual double GetGradientSmoothingStandardDeviations() const;

  void SetUseImageSpacing( bool);
  bool GetUseImageSpacing() const;


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

  typedef ConstNeighborhoodIterator<FixedImageType>
        FixedImageNeighborhoodIteratorType;

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

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

  SpacingType                     m_FixedImageSpacing;
  PointType                       m_FixedImageOrigin;

  MovingImageSmoothingFilterPointer          m_MovingImageSmoothingFilter;

  InterpolatorPointer             m_MovingImageInterpolator;
  InterpolatorPointer             m_SmoothMovingImageInterpolator;

  double                          m_Alpha;

  double                          m_GradientMagnitudeThreshold;

  double                          m_IntensityDifferenceThreshold;

  double                          m_GradientSmoothingStandardDeviations;

  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;

  bool                            m_UseImageSpacing;
};


} // end namespace itk

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

#endif