itkGPUImage.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  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 itkGPUImage_h
#define itkGPUImage_h
 
#include "itkImage.h"
#include "itkGPUImageDataManager.h"
#include "itkVersion.h"
#include "itkObjectFactoryBase.h"
 
namespace itk
{
template <typename TPixel, unsigned int VImageDimension = 2>
class ITK_TEMPLATE_EXPORT ITKOpenCL_EXPORT GPUImage : public Image<TPixel, VImageDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GPUImage);
 
  using Self = GPUImage;
  using Superclass = Image<TPixel, VImageDimension>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using ConstWeakPointer = WeakPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkOverrideGetNameOfClassMacro(GPUImage);
 
  itkStaticConstMacro(ImageDimension, unsigned int, VImageDimension);
 
  using typename Superclass::PixelType;
  using typename Superclass::ValueType;
  using typename Superclass::InternalPixelType;
  using typename Superclass::IOPixelType;
  using typename Superclass::DirectionType;
  using typename Superclass::SpacingType;
  using typename Superclass::PixelContainer;
  using typename Superclass::SizeType;
  using typename Superclass::IndexType;
  using typename Superclass::OffsetType;
  using typename Superclass::RegionType;
  using PixelContainerPointer = typename PixelContainer::Pointer;
  using PixelContainerConstPointer = typename PixelContainer::ConstPointer;
  using typename Superclass::AccessorType;
 
  using AccessorFunctorType = DefaultPixelAccessorFunctor<Self>;
 
  using NeighborhoodAccessorFunctorType = NeighborhoodAccessorFunctor<Self>;

  template <typename UPixelType, unsigned int VUImageDimension = VImageDimension>
  struct Rebind
  {
    using Type = itk::GPUImage<UPixelType, VUImageDimension>;
  };
 
  template <typename UPixelType, unsigned int VUImageDimension = VImageDimension>
  using RebindImageType = itk::GPUImage<UPixelType, VUImageDimension>;
 

  void
  Allocate(bool initialize = false) override;
 
  void
  AllocateGPU();
 
  void
  Initialize() override;
 
  void
  FillBuffer(const TPixel & value);
 
  void
  SetPixel(const IndexType & index, const TPixel & value);
 
  const TPixel &
  GetPixel(const IndexType & index) const;
 
  TPixel &
  GetPixel(const IndexType & index);
 
  const TPixel &
  operator[](const IndexType & index) const;
 
  TPixel &
  operator[](const IndexType & index);

  void
  UpdateBuffers();

  void
  UpdateCPUBuffer();
 
  void
  UpdateGPUBuffer();

  TPixel *
  GetBufferPointer() override;
 
  const TPixel *
  GetBufferPointer() const override;

  AccessorType
  GetPixelAccessor()
  {
    m_DataManager->SetGPUBufferDirty();
    return Superclass::GetPixelAccessor();
  }
 

  const AccessorType
  GetPixelAccessor() const
  {
    m_DataManager->UpdateCPUBuffer();
    return Superclass::GetPixelAccessor();
  }
 

  NeighborhoodAccessorFunctorType
  GetNeighborhoodAccessor()
  {
    m_DataManager->SetGPUBufferDirty();
    return NeighborhoodAccessorFunctorType();
  }
 

  const NeighborhoodAccessorFunctorType
  GetNeighborhoodAccessor() const
  {
    m_DataManager->UpdateCPUBuffer();
    return NeighborhoodAccessorFunctorType();
  }
 
 
  void
  SetPixelContainer(PixelContainer * container);

  PixelContainer *
  GetPixelContainer()
  {
    m_DataManager->SetGPUBufferDirty();
    return Superclass::GetPixelContainer();
  }
 
 
  const PixelContainer *
  GetPixelContainer() const
  {
    m_DataManager->UpdateCPUBuffer();
    return Superclass::GetPixelContainer();
  }
 
 
  void
  SetCurrentCommandQueue(int queueid)
  {
    m_DataManager->SetCurrentCommandQueue(queueid);
  }
 
 
  int
  GetCurrentCommandQueueId()
  {
    return m_DataManager->GetCurrentCommandQueueId();
  }
 
 
  GPUDataManager::Pointer
  GetGPUDataManager() const;

  void
  DataHasBeenGenerated() override
  {
    Superclass::DataHasBeenGenerated();
 
    if (m_DataManager->IsCPUBufferDirty())
    {
      m_DataManager->Modified();
    }
  }
 

  void
  Graft(const DataObject * data) override;
 
  void
  GraftITKImage(const DataObject * data);

  void
  Modified() const override;

  itkGetConstReferenceMacro(IndexToPhysicalPoint, DirectionType);
  itkGetConstReferenceMacro(PhysicalPointToIndex, DirectionType);
 
protected:
  GPUImage();
  ~GPUImage() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  bool m_Graft{};
 
  typename GPUImageDataManager<GPUImage>::Pointer m_DataManager{};
};
 
//------------------------------------------------------------------------------
template <typename T>
class ITK_TEMPLATE_EXPORT GPUTraits
{
public:
  using Type = T;
};
 
template <typename TPixelType, unsigned int NDimension>
class ITK_TEMPLATE_EXPORT GPUTraits<Image<TPixelType, NDimension>>
{
public:
  using Type = GPUImage<TPixelType, NDimension>;
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGPUImage.hxx"
#endif
 
#endif