itkGPUDemonsRegistrationFunction.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkGPUDemonsRegistrationFunction_h
#define __itkGPUDemonsRegistrationFunction_h

#include "itkGPUPDEDeformableRegistrationFunction.h"
#include "itkPoint.h"
#include "itkLinearInterpolateImageFunction.h"
#include "itkCentralDifferenceImageFunction.h"
#include "itkGPUReduction.h"

namespace itk
{
itkGPUKernelClassMacro(GPUDemonsRegistrationFunctionKernel);

template< typename TFixedImage, typename TMovingImage, typename TDisplacementField >
class GPUDemonsRegistrationFunction :
  public GPUPDEDeformableRegistrationFunction< TFixedImage,
                                               TMovingImage,
                                               TDisplacementField >
{
public:
  typedef GPUDemonsRegistrationFunction Self;
  typedef GPUPDEDeformableRegistrationFunction< TFixedImage, TMovingImage,
                                                TDisplacementField>                  Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(GPUDemonsRegistrationFunction,
               DemonsRegistrationFunction);

  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::DisplacementFieldType DisplacementFieldType;
  typedef typename Superclass::DisplacementFieldTypePointer
  DisplacementFieldTypePointer;

  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;

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

  typedef GPUDataManager::Pointer GPUDataPointer;

  itkGetOpenCLSourceFromKernelMacro(GPUDemonsRegistrationFunctionKernel);

  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();

    global->m_SumOfSquaredDifference  = 0.0;
    global->m_NumberOfPixelsProcessed = 0L;
    global->m_SumOfSquaredChange      = 0;
    return global;
  }

  virtual void ReleaseGlobalDataPointer(void *GlobalData) const;

  virtual void GPUAllocateMetricData(unsigned int numPixels);

  virtual void GPUReleaseMetricData();

  virtual void InitializeIteration();

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

  virtual void GPUComputeUpdate( const DisplacementFieldTypePointer output,
                                 DisplacementFieldTypePointer update,
                                 void *gd);

  virtual double GetMetric() const
  {
    return m_Metric;
  }

  virtual double GetRMSChange() const
  {
    return m_RMSChange;
  }

  virtual void SetUseMovingImageGradient(bool flag)
  {
    m_UseMovingImageGradient = flag;
  }
  virtual bool GetUseMovingImageGradient() const
  {
    return m_UseMovingImageGradient;
  }

  virtual void SetIntensityDifferenceThreshold(double);

  virtual double GetIntensityDifferenceThreshold() const;

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

  typedef ConstNeighborhoodIterator< FixedImageType >
  FixedImageNeighborhoodIteratorType;

  struct GlobalDataStruct {
    double m_SumOfSquaredDifference;
    SizeValueType m_NumberOfPixelsProcessed;
    double m_SumOfSquaredChange;
    };

  /* GPU kernel handle for GPUComputeUpdate */
  int m_ComputeUpdateGPUKernelHandle;

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

  //SpacingType                  m_FixedImageSpacing;
  //PointType                    m_FixedImageOrigin;
  PixelType m_ZeroUpdateReturn;
  double    m_Normalizer;

  GradientCalculatorPointer m_FixedImageGradientCalculator;

  MovingImageGradientCalculatorPointer m_MovingImageGradientCalculator;
  bool                                 m_UseMovingImageGradient;

  InterpolatorPointer m_MovingImageInterpolator;

  TimeStepType m_TimeStep;

  double m_DenominatorThreshold;

  double m_IntensityDifferenceThreshold;

  mutable double        m_Metric;
  mutable double        m_SumOfSquaredDifference;
  mutable SizeValueType m_NumberOfPixelsProcessed;
  mutable double        m_RMSChange;
  mutable double        m_SumOfSquaredChange;

  mutable GPUReduction<int>::Pointer   m_GPUPixelCounter;
  mutable GPUReduction<float>::Pointer m_GPUSquaredChange;
  mutable GPUReduction<float>::Pointer m_GPUSquaredDifference;

  mutable SimpleFastMutexLock m_MetricCalculationLock;

};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkGPUDemonsRegistrationFunction.hxx"
#endif

#endif