itkFFDDerivativeBridge.h

Go to the documentation of this file.

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

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

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

#ifndef itkFFDDerivativeBridge_h
#define itkFFDDerivativeBridge_h


#include "itkMetricDerivativeBridge.h"
#include <itkRegistrationForceFilter.h>
#include <itkBSplineSmoothVectorFieldFilter.h>
#include <itkInterpolateVectorFieldFilter.h>
#include <itkUCLBSplineTransform.h>

namespace itk
{
template < typename TFixedImage, typename TMovingImage > 
class ITK_EXPORT FFDDerivativeBridge : 
    public MetricDerivativeBridge<TFixedImage, TMovingImage>
{
public:

  typedef FFDDerivativeBridge                                Self;
  typedef MetricDerivativeBridge<TFixedImage, TMovingImage>  Superclass;
  typedef SmartPointer<Self>                                 Pointer;
  typedef SmartPointer<const Self>                           ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(FFDDerivativeBridge, MetricDerivativeBridge);

  itkStaticConstMacro(Dimension, unsigned int, TFixedImage::ImageDimension);
  
  typedef typename Superclass::SimilarityMeasureType            SimilarityMeasureType;
  typedef typename Superclass::SimilarityMeasurePointer         SimilarityMeasurePointer;
  typedef typename Superclass::DerivativeType                   DerivativeType;
  typedef typename Superclass::ParametersType                   ParametersType;
  typedef UCLBSplineTransform<TFixedImage, double, Dimension>   UCLBSplineTransformType;
  typedef typename UCLBSplineTransformType::Pointer             UCLBSplineTransformPointer;
  typedef typename UCLBSplineTransformType::GridImageType       GridImageType;
  typedef typename GridImageType::Pointer                       GridImagePointer;
  
  typedef RegistrationForceFilter<TFixedImage, TMovingImage> ForceFilterType;
  typedef typename ForceFilterType::Pointer                  ForceFilterPointer;
  
  typedef BSplineSmoothVectorFieldFilter<double, Dimension>  SmoothFilterType;
  typedef typename SmoothFilterType::Pointer                 SmoothFilterPointer;
  
  typedef InterpolateVectorFieldFilter<double, Dimension>    InterpolateFilterType;
  typedef typename InterpolateFilterType::Pointer            InterpolateFilterPointer;  
  typedef typename InterpolateFilterType::OutputImageType    OutputImageType;
  typedef typename OutputImageType::PixelType                OutputImagePixelType;
  typedef typename OutputImageType::Pointer                  OutputImagePointer;
  typedef ImageRegionIterator<OutputImageType>               OutputImageIteratorType;
  typedef typename OutputImageType::SizeType                 OutputImageSizeType;
  
  void GetCostFunctionDerivative(SimilarityMeasurePointer similarityMeasure,
                                         const ParametersType &parameters,
                                         DerivativeType &derivative) const;

  itkSetObjectMacro( Grid, GridImageType );
  itkGetConstObjectMacro( Grid, GridImageType );

  itkSetObjectMacro( ForceFilter, ForceFilterType );
  itkGetConstObjectMacro( ForceFilter, ForceFilterType );

  itkSetObjectMacro( SmoothFilter, SmoothFilterType );
  itkGetConstObjectMacro( SmoothFilter, SmoothFilterType );
  
  itkSetObjectMacro( InterpolatorFilter, InterpolateFilterType );
  itkGetConstObjectMacro( InterpolatorFilter, InterpolateFilterType );
  
protected:
  
  FFDDerivativeBridge();
  virtual ~FFDDerivativeBridge() {};

  GridImagePointer m_Grid;
  
  ForceFilterPointer m_ForceFilter;
  
  SmoothFilterPointer m_SmoothFilter;
  
  InterpolateFilterPointer m_InterpolatorFilter;
  
private:
  
  FFDDerivativeBridge(const Self&); // purposefully not implemented
  void operator=(const Self&);    // purposefully not implemented
  void PrintSelf(std::ostream& os, Indent indent) const;

};

} // end namespace itk

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

#endif