itkGPUFiniteDifferenceFunction.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 itkGPUFiniteDifferenceFunction_h
#define itkGPUFiniteDifferenceFunction_h
 
#include "itkFiniteDifferenceFunction.h"
#include "itkLightObject.h"
#include "itkConstNeighborhoodIterator.h"
#include "itkVector.h"
 
#include "itkGPUDataManager.h"
#include "itkGPUKernelManager.h"
 
namespace itk
{
template <typename TImageType>
class ITK_TEMPLATE_EXPORT GPUFiniteDifferenceFunction : public FiniteDifferenceFunction<TImageType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GPUFiniteDifferenceFunction);

  using Self = GPUFiniteDifferenceFunction;
  using Superclass = FiniteDifferenceFunction<TImageType>;
  using DifferenceFunctionType = Superclass;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(GPUFiniteDifferenceFunction);

  using typename Superclass::ImageType;
  using typename Superclass::PixelType;
  using typename Superclass::PixelRealType;

  static constexpr unsigned int ImageDimension = ImageType::ImageDimension;

  using typename Superclass::TimeStepType;

  using typename Superclass::DefaultBoundaryConditionType;

  using typename Superclass::RadiusType;

  using typename Superclass::NeighborhoodType;

  using typename Superclass::FloatOffsetType;
 
#if !defined(ITK_WRAPPING_PARSER)
  PixelType
  ComputeUpdate(const NeighborhoodType & itkNotUsed(neighborhood),
                void *                   itkNotUsed(globalData),
                const FloatOffsetType &  itkNotUsed(offset) = FloatOffsetType(0.0)) override
  {
    PixelType pix{};
    return pix;
  }
#endif

  virtual void
  GPUComputeUpdate(const typename TImageType::Pointer output, typename TImageType::Pointer update, void * gd) = 0;

  virtual void
  GPUAllocateMetricData(unsigned int itkNotUsed(numPixels))
  {}

  virtual void
  GPUReleaseMetricData()
  {}
 
protected:
  GPUFiniteDifferenceFunction() { m_GPUKernelManager = GPUKernelManager::New(); }
  ~GPUFiniteDifferenceFunction() override = default;

  typename GPUKernelManager::Pointer m_GPUKernelManager{};

  int m_ComputeUpdateGPUKernelHandle{};
};
} // end namespace itk
 
#endif