itkGPUPDEDeformableRegistrationFilter.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 __itkGPUPDEDeformableRegistrationFilter_h
#define __itkGPUPDEDeformableRegistrationFilter_h

#include "itkGPUDenseFiniteDifferenceImageFilter.h"
#include "itkGPUPDEDeformableRegistrationFunction.h"
#include "itkPDEDeformableRegistrationFilter.h"

namespace itk
{
itkGPUKernelClassMacro(GPUPDEDeformableRegistrationFilterKernel);

template< typename TFixedImage, typename TMovingImage, typename TDisplacementField,
          typename TParentImageFilter = PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
          >
class GPUPDEDeformableRegistrationFilter :
  public GPUDenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter >
{
public:
  typedef GPUPDEDeformableRegistrationFilter                                                              Self;
  typedef GPUDenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField, TParentImageFilter > GPUSuperclass;
  typedef TParentImageFilter                                                                              CPUSuperclass;
  typedef SmartPointer< Self >                                                                            Pointer;
  typedef SmartPointer< const Self >                                                                      ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(GPUPDEDeformableRegistrationFilter,
               GPUDenseFiniteDifferenceImageFilter);

  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 TDisplacementField                      DisplacementFieldType;
  typedef typename DisplacementFieldType::Pointer DisplacementFieldPointer;
  typedef typename TDisplacementField::PixelType  DeformationVectorType;
  typedef typename TDisplacementField::PixelType::ValueType
                                                 DeformationScalarType;

  typedef typename GPUSuperclass::OutputImageType OutputImageType;

  typedef typename GPUSuperclass::FiniteDifferenceFunctionType
  FiniteDifferenceFunctionType;

  typedef GPUPDEDeformableRegistrationFunction< FixedImageType, MovingImageType,
                                                DisplacementFieldType >  GPUPDEDeformableRegistrationFunctionType;

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

  itkGetOpenCLSourceFromKernelMacro(GPUPDEDeformableRegistrationFilterKernel);

  void SetFixedImage(const FixedImageType *ptr);

  const FixedImageType * GetFixedImage(void) const;

  void SetMovingImage(const MovingImageType *ptr);

  const MovingImageType * GetMovingImage(void) const;

  void SetInitialDisplacementField(const DisplacementFieldType *ptr)
  {
    this->SetInput(ptr);
  }

  DisplacementFieldType * GetDisplacementField()
  {
    return this->GetOutput();
  }

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

  typedef FixedArray< double, ImageDimension > StandardDeviationsType;

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

  virtual void CopyInputToOutput();

  virtual void InitializeIteration();

  virtual void SmoothDisplacementField();

  virtual void GPUSmoothVectorField(DisplacementFieldPointer field,
    typename GPUDataManager::Pointer GPUSmoothingKernels[],
    int GPUSmoothingKernelSizes[]);

  virtual void AllocateSmoothingBuffer();

  virtual void SmoothUpdateField();

  virtual void PostProcessOutput();

  virtual void Initialize();

  virtual void GenerateOutputInformation();

  virtual void GenerateInputRequestedRegion();

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

  DisplacementFieldPointer m_TempField;

private:
  int                              m_SmoothingKernelSizes[ImageDimension];
  DeformationScalarType*           m_SmoothingKernels[ImageDimension];
  typename GPUDataManager::Pointer m_GPUSmoothingKernels[ImageDimension];

  int                              m_UpdateFieldSmoothingKernelSizes[ImageDimension];
  DeformationScalarType*           m_UpdateFieldSmoothingKernels[ImageDimension];
  typename GPUDataManager::Pointer m_UpdateFieldGPUSmoothingKernels[ImageDimension];

  int*                             m_ImageSizes;
  typename GPUDataManager::Pointer m_GPUImageSizes;

  /* GPU kernel handle for GPUSmoothDisplacementField */
  int m_SmoothDisplacementFieldGPUKernelHandle;

};
} // end namespace itk

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

#endif