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 ITKOpenCL_EXPORT GPUImage : public Image< TPixel, VImageDimension >
{
public:
 
  typedef GPUImage                         Self;
  typedef Image< TPixel, VImageDimension > Superclass;
  typedef SmartPointer< Self >             Pointer;
  typedef SmartPointer< const Self >       ConstPointer;
  typedef WeakPointer< const Self >        ConstWeakPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( GPUImage, Image );
 
  itkStaticConstMacro( ImageDimension, unsigned int, VImageDimension );
 
  typedef typename Superclass::PixelType         PixelType;
  typedef typename Superclass::ValueType         ValueType;
  typedef typename Superclass::InternalPixelType InternalPixelType;
  typedef typename Superclass::IOPixelType       IOPixelType;
  typedef typename Superclass::DirectionType     DirectionType;
  typedef typename Superclass::SpacingType       SpacingType;
  typedef typename Superclass::PixelContainer    PixelContainer;
  typedef typename Superclass::SizeType          SizeType;
  typedef typename Superclass::IndexType         IndexType;
  typedef typename Superclass::OffsetType        OffsetType;
  typedef typename Superclass::RegionType        RegionType;
  typedef typename PixelContainer::Pointer       PixelContainerPointer;
  typedef typename PixelContainer::ConstPointer  PixelContainerConstPointer;
  typedef typename Superclass::AccessorType      AccessorType;
 
  typedef DefaultPixelAccessorFunctor< Self > AccessorFunctorType;
 
  typedef NeighborhoodAccessorFunctor< Self > NeighborhoodAccessorFunctorType;
 
  void Allocate( bool initialize = false ) override;
 
  void AllocateGPU( void );
 
  virtual void Initialize( void );
 
  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 );
 
  void UpdateCPUBuffer( void );
 
  void UpdateGPUBuffer( void );
 
  TPixel * GetBufferPointer( void );
 
  const TPixel * GetBufferPointer( void ) const;
 
  AccessorType GetPixelAccessor( void )
  {
    m_DataManager->SetGPUBufferDirty();
    return Superclass::GetPixelAccessor();
  }
 
 
  const AccessorType GetPixelAccessor( void ) const
  {
    m_DataManager->UpdateCPUBuffer();
    return Superclass::GetPixelAccessor();
  }
 
 
  NeighborhoodAccessorFunctorType GetNeighborhoodAccessor( void )
  {
    m_DataManager->SetGPUBufferDirty();
    return NeighborhoodAccessorFunctorType();
  }
 
 
  const NeighborhoodAccessorFunctorType GetNeighborhoodAccessor( void ) const
  {
    m_DataManager->UpdateCPUBuffer();
    return NeighborhoodAccessorFunctorType();
  }
 
 
  void SetPixelContainer( PixelContainer * container );
 
  PixelContainer * GetPixelContainer( void )
  {
    m_DataManager->SetGPUBufferDirty(); return Superclass::GetPixelContainer();
  }
 
 
  const PixelContainer * GetPixelContainer( void ) const
  {
    m_DataManager->UpdateCPUBuffer();
    return Superclass::GetPixelContainer();
  }
 
 
  void SetCurrentCommandQueue( int queueid )
  {
    m_DataManager->SetCurrentCommandQueue( queueid );
  }
 
 
  int GetCurrentCommandQueueId( void )
  {
    return m_DataManager->GetCurrentCommandQueueId();
  }
 
 
  GPUDataManager::Pointer GetGPUDataManager( void ) const;
 
  void DataHasBeenGenerated( void )
  {
    Superclass::DataHasBeenGenerated();
 
    if( m_DataManager->IsCPUBufferDirty() )
    {
      m_DataManager->Modified();
    }
 
  }
 
 
  virtual void Graft( const DataObject * data );
 
  void GraftITKImage( const DataObject * data );
 
  virtual void Modified( void ) const;
 
  itkGetConstReferenceMacro( IndexToPhysicalPoint, DirectionType );
  itkGetConstReferenceMacro( PhysicalPointToIndex, DirectionType );
 
protected:
 
  GPUImage();
  virtual ~GPUImage() {}
 
  virtual void PrintSelf( std::ostream & os, Indent indent ) const;
 
private:
 
  GPUImage( const Self & );       // purposely not implemented
  void operator=( const Self & ); // purposely not implemented
 
  bool m_Graft;
 
  typename GPUImageDataManager< GPUImage >::Pointer m_DataManager;
};
 
//------------------------------------------------------------------------------
template< typename T >
class GPUTraits
{
public:
 
  typedef T Type;
};
 
template< typename TPixelType, unsigned int NDimension >
class GPUTraits< Image< TPixelType, NDimension > >
{
public:
 
  typedef GPUImage< TPixelType, NDimension > Type;
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkGPUImage.hxx"
#endif
 
#endif