itkPDEDeformableRegistrationFilter.h

Go to the documentation of this file.

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

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

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

#include "itkDenseFiniteDifferenceImageFilter.h"
#include "itkPDEDeformableRegistrationFunction.h"

namespace itk {

template<class TFixedImage, class TMovingImage, class TDeformationField>
class ITK_EXPORT PDEDeformableRegistrationFilter : 
    public DenseFiniteDifferenceImageFilter<TDeformationField,TDeformationField>
{
public:

  typedef PDEDeformableRegistrationFilter    Self;
  typedef DenseFiniteDifferenceImageFilter<
    TDeformationField,TDeformationField>     Superclass;
  typedef SmartPointer<Self>                 Pointer;
  typedef SmartPointer<const Self>           ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro( PDEDeformableRegistrationFilter, 
                DenseFiniteDifferenceImageFilter );

  typedef TFixedImage                            FixedImageType;
  typedef typename FixedImageType::Pointer       FixedImagePointer;
  typedef typename FixedImageType::ConstPointer  FixedImageConstPointer;

  typedef TMovingImage                           MovingImageType;
  typedef typename MovingImageType::Pointer      MovingImagePointer;
  typedef typename MovingImageType::ConstPointer MovingImageConstPointer;

  typedef TDeformationField                       DeformationFieldType;
  typedef typename DeformationFieldType::Pointer  DeformationFieldPointer;

  typedef typename Superclass::OutputImageType    OutputImageType;

  typedef typename Superclass::FiniteDifferenceFunctionType
  FiniteDifferenceFunctionType;

  typedef PDEDeformableRegistrationFunction<FixedImageType,MovingImageType,
                                            DeformationFieldType>  PDEDeformableRegistrationFunctionType;

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

  void SetFixedImage( const FixedImageType * ptr );

  const FixedImageType * GetFixedImage(void) const;

  void SetMovingImage( const MovingImageType * ptr );

  const MovingImageType * GetMovingImage(void) const;

  void SetInitialDeformationField( DeformationFieldType * ptr )
  { this->SetInput( ptr ); }

  DeformationFieldType * GetDeformationField()
    { return this->GetOutput(); }

  virtual std::vector<SmartPointer<DataObject> >::size_type GetNumberOfValidRequiredInputs() const;

  itkSetMacro( SmoothDeformationField, bool );
  itkGetMacro( SmoothDeformationField, bool );
  itkBooleanMacro( SmoothDeformationField );

  itkSetVectorMacro( StandardDeviations, double, ImageDimension );
  virtual void SetStandardDeviations( double value );

  const double * GetStandardDeviations(void) 
    { return (double *) m_StandardDeviations; }

  itkSetMacro( SmoothUpdateField, bool );
  itkGetMacro( SmoothUpdateField, bool );
  itkBooleanMacro( SmoothUpdateField );

  itkSetVectorMacro( UpdateFieldStandardDeviations, double, ImageDimension );
  virtual void SetUpdateFieldStandardDeviations( double value );

  const double * GetUpdateFieldStandardDeviations(void) 
    { return (double *) m_UpdateFieldStandardDeviations; }

  

  virtual void StopRegistration()
    { m_StopRegistrationFlag = true; }

  itkSetMacro( MaximumError, double );
  itkGetMacro( MaximumError, double );

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


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

  virtual bool Halt()
    {

    if ( m_StopRegistrationFlag )
      {
      return true;
      }

    return this->Superclass::Halt();
    }

  virtual void CopyInputToOutput();

  virtual void InitializeIteration();

  virtual void SmoothDeformationField();

  virtual void SmoothUpdateField();

  virtual void PostProcessOutput();

  virtual void Initialize();

  virtual void GenerateOutputInformation();

  virtual void GenerateInputRequestedRegion();

private:
  PDEDeformableRegistrationFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  double                   m_StandardDeviations[ImageDimension];
  double                   m_UpdateFieldStandardDeviations[ImageDimension];

  bool m_SmoothDeformationField;
  bool m_SmoothUpdateField;

  
  DeformationFieldPointer   m_TempField;

private:
  double                    m_MaximumError;

  unsigned int              m_MaximumKernelWidth;

  bool                      m_StopRegistrationFlag;

};


} // end namespace itk

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

#endif