mitkOclImage.h

Go to the documentation of this file.

/*===================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

===================================================================*/

#ifndef __mitkOclImage_h
#define __mitkOclImage_h

#define GPU_DATA 0
#define CPU_DATA 1

#define MAX_DIMS 20

#include <mitkImage.h>
#include "MitkOpenCLExports.h"

#include "mitkOclBaseData.h"
#include "mitkOclImageFormats.h"
#include "mitkOpenCLActivator.h"

#include <mitkException.h>


#define SHORT_IM mitk::MakeScalarPixelType<short>()
#define FLOAT_IM mitk::MakeScalarPixelType<float>()

namespace mitk {

class MITKOPENCL_EXPORT OclImage : public OclBaseData
{
public:
  mitkClassMacro(OclImage, OclBaseData);
  itkFactorylessNewMacro(Self)
  itkCloneMacro(Self)

  
  virtual int TransferDataToGPU(cl_command_queue);

  virtual void* TransferDataToCPU(cl_command_queue);

  Image::Pointer GetMITKImage()
  {
    return m_Image;
  }

  cl_mem GetGPUImage(cl_command_queue);

  cl_mem GetGPUBuffer()
  {
    return this->m_gpuImage;
  }

  cl_mem CreateGPUImage(unsigned int, unsigned int, unsigned int, unsigned int);

  bool IsModified(int _type);

  void Modified(int _type);

  void InitializeMITKImage();

  void InitializeByMitkImage(mitk::Image::Pointer _image);

  int GetDimension(int) const;

  int GetDimension() const
  {
    return this->m_dim;
  }

  unsigned int* GetDimensions(){ return this->m_Dims; }

  float GetSpacing(int);

  void GetOffset(float*) const;

  void SetPixelType(const cl_image_format*);

  short GetBytesPerPixel() const
  {
    return this->m_BpE;
  }

  const cl_image_format* GetPixelType() const
  {
    return &(this->m_proposedFormat);
  }

  void SetDimensions(unsigned int* Dims);

  void SetDimension(unsigned short dim);

protected:
  OclImage();

  virtual ~OclImage();

  cl_mem m_gpuImage;

  cl_context m_context;

  unsigned int m_bufferSize;

private:

  cl_image_format ConvertPixelTypeToOCLFormat();

  bool m_gpuModified;
  bool m_cpuModified;

  Image::Pointer m_Image;

  unsigned short m_dim;

  unsigned int* m_Dims;

  unsigned short m_BpE;

  cl_int AllocateGPUImage();

  bool m_formatSupported;

  cl_image_format m_supportedFormat;

  cl_image_format m_proposedFormat;
};

class ImageTypeIsNotSupportedByGPU : public Exception
{
public:
  mitkExceptionClassMacro(ImageTypeIsNotSupportedByGPU,Exception)
};

}
#endif //__mitkOclImage_h