itkGPUPDEDeformableRegistrationFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 ITK_TEMPLATE_EXPORT GPUPDEDeformableRegistrationFilter
  : public GPUDenseFiniteDifferenceImageFilter<TDisplacementField, TDisplacementField, TParentImageFilter>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GPUPDEDeformableRegistrationFilter);

  using Self = GPUPDEDeformableRegistrationFilter;
  using GPUSuperclass = GPUDenseFiniteDifferenceImageFilter<TDisplacementField, TDisplacementField, TParentImageFilter>;
  using CPUSuperclass = TParentImageFilter;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(GPUPDEDeformableRegistrationFilter);

  using FixedImageType = TFixedImage;
  using FixedImagePointer = typename FixedImageType::Pointer;
  using FixedImageConstPointer = typename FixedImageType::ConstPointer;

  using MovingImageType = TMovingImage;
  using MovingImagePointer = typename MovingImageType::Pointer;
  using MovingImageConstPointer = typename MovingImageType::ConstPointer;

  using DisplacementFieldType = TDisplacementField;
  using DisplacementFieldPointer = typename DisplacementFieldType::Pointer;
  using DeformationVectorType = typename TDisplacementField::PixelType;
  using DeformationScalarType = typename TDisplacementField::PixelType::ValueType;

  using OutputImageType = typename GPUSuperclass::OutputImageType;

  using FiniteDifferenceFunctionType = typename GPUSuperclass::FiniteDifferenceFunctionType;

  using GPUPDEDeformableRegistrationFunctionType =
    GPUPDEDeformableRegistrationFunction<FixedImageType, MovingImageType, DisplacementFieldType>;

  static constexpr unsigned int ImageDimension = GPUSuperclass::ImageDimension;

  itkGetOpenCLSourceFromKernelMacro(GPUPDEDeformableRegistrationFilterKernel);

  DisplacementFieldType *
  GetDisplacementField()
  {
    return this->GetOutput();
  }
 
  using StandardDeviationsType = FixedArray<double, ImageDimension>;
 
protected:
  GPUPDEDeformableRegistrationFilter();
  ~GPUPDEDeformableRegistrationFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  CopyInputToOutput() override;

  void
  InitializeIteration() override;

  void
  SmoothDisplacementField() override;

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

  void
  SmoothUpdateField() override;

  void
  PostProcessOutput() override;

  void
  Initialize() override;

  void
  GenerateOutputInformation() override;

  void
  GenerateInputRequestedRegion() override;
 
private:
  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