itkMIRegistrationFunction.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkMIRegistrationFunction.h,v $
  Language:  C++
  Date:      $Date: 2009-01-26 21:45:49 $
  Version:   $Revision: 1.7 $

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

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

namespace itk {

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

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

  itkNewMacro(Self);

  itkTypeMacro( MIRegistrationFunction, 
    PDEDeformableRegistrationFunction );

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

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

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

  void SetMovingImageInterpolator( InterpolatorType * ptr )
    { m_MovingImageInterpolator = 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();
    return global;
    }

  virtual void ReleaseGlobalDataPointer( void *GlobalData ) const
    { delete (GlobalDataStruct *) GlobalData;  }

  virtual void InitializeIteration();

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

  void SetMinNorm(float ts=1.0) { m_Minnorm=ts;}


  void SetDoInverse(bool b = false) { m_DoInverse=b;}


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

  typedef ConstNeighborhoodIterator<FixedImageType> FixedImageNeighborhoodIteratorType;

  struct GlobalDataStruct
    {
    FixedImageNeighborhoodIteratorType   m_FixedImageIterator;
    };

  TimeStepType                    m_TimeStep;


private:
  MIRegistrationFunction(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  SpacingType                     m_FixedImageSpacing;
  PointType                       m_FixedImageOrigin;

  GradientCalculatorPointer       m_FixedImageGradientCalculator;

  GradientCalculatorPointer       m_MovingImageGradientCalculator;

  InterpolatorPointer             m_MovingImageInterpolator;


  double                          m_DenominatorThreshold;

  double                          m_IntensityDifferenceThreshold;

  mutable double                          m_MetricTotal;

  unsigned int m_NumberOfSamples;
  unsigned int m_NumberOfBins;
  float        m_Minnorm;

  bool         m_DoInverse;
};


} // end namespace itk

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

#endif