ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
itk::GPUDataManager Class Reference
Group Core » Module ITKGPUCommon

#include <itkGPUDataManager.h>

Detailed Description

GPU memory manager implemented using OpenCL. Required by GPUImage class.

This class serves as a base class for GPU data container for GPUImage class, which is similar to ImageBase class for Image class. However, all the image-related meta data will be already stored in image class (parent of GPUImage), therefore we did not name it GPUImageBase. Rather, this class is a GPU-specific data manager that provides functionalities for CPU-GPU data synchronization and grafting GPU data.

Definition at line 42 of file itkGPUDataManager.h.

+ Inheritance diagram for itk::GPUDataManager:
+ Collaboration diagram for itk::GPUDataManager:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using MutexHolderType = std::lock_guard< std::mutex >
 
using Pointer = SmartPointer< Self >
 
using Self = GPUDataManager
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

void Allocate ()
 
unsigned int GetBufferSize () const
 
void * GetCPUBufferPointer ()
 
int GetCurrentCommandQueueID () const
 
cl_mem * GetGPUBufferPointer ()
 
const char * GetNameOfClass () const override
 
virtual void Graft (const GPUDataManager *data)
 
virtual void Initialize ()
 
bool IsCPUBufferDirty () const
 
bool IsGPUBufferDirty () const
 
void SetBufferFlag (cl_mem_flags flags)
 
void SetBufferSize (unsigned int num)
 
void SetCPUBufferDirty ()
 
void SetCPUBufferPointer (void *ptr)
 
void SetCPUDirtyFlag (bool isDirty)
 
void SetCurrentCommandQueue (int queueid)
 
void SetGPUBufferDirty ()
 
void SetGPUDirtyFlag (bool isDirty)
 
bool Update ()
 
virtual void UpdateCPUBuffer ()
 
virtual void UpdateGPUBuffer ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 GPUDataManager ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GPUDataManager () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

unsigned int m_BufferSize {}
 
int m_CommandQueueId {}
 
GPUContextManager * m_ContextManager {}
 
void * m_CPUBuffer {}
 
cl_mem m_GPUBuffer {}
 
bool m_IsCPUBufferDirty {}
 
bool m_IsGPUBufferDirty {}
 
cl_mem_flags m_MemFlags {}
 
std::mutex m_Mutex {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Friends

class GPUKernelManager
 

Member Typedef Documentation

◆ ConstPointer

using itk::GPUDataManager::ConstPointer = SmartPointer<const Self>

Definition at line 53 of file itkGPUDataManager.h.

◆ MutexHolderType

using itk::GPUDataManager::MutexHolderType = std::lock_guard<std::mutex>

Definition at line 58 of file itkGPUDataManager.h.

◆ Pointer

using itk::GPUDataManager::Pointer = SmartPointer<Self>

Definition at line 52 of file itkGPUDataManager.h.

◆ Self

using itk::GPUDataManager::Self = GPUDataManager

Definition at line 50 of file itkGPUDataManager.h.

◆ Superclass

using itk::GPUDataManager::Superclass = Object

Definition at line 51 of file itkGPUDataManager.h.

Constructor & Destructor Documentation

◆ GPUDataManager()

itk::GPUDataManager::GPUDataManager ( )
protected

◆ ~GPUDataManager()

itk::GPUDataManager::~GPUDataManager ( )
overrideprotected

Member Function Documentation

◆ Allocate()

void itk::GPUDataManager::Allocate ( )

◆ GetBufferSize()

unsigned int itk::GPUDataManager::GetBufferSize ( ) const
inline

Definition at line 65 of file itkGPUDataManager.h.

References m_BufferSize.

◆ GetCPUBufferPointer()

void * itk::GPUDataManager::GetCPUBufferPointer ( )

Get GPU buffer pointer

◆ GetCurrentCommandQueueID()

int itk::GPUDataManager::GetCurrentCommandQueueID ( ) const

◆ GetGPUBufferPointer()

cl_mem * itk::GPUDataManager::GetGPUBufferPointer ( )

Get GPU buffer pointer

◆ GetNameOfClass()

const char * itk::GPUDataManager::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

Reimplemented in itk::GPUImageDataManager< ImageType >, and itk::GPUImageDataManager< itk::GPUImage >.

◆ Graft()

virtual void itk::GPUDataManager::Graft ( const GPUDataManager *  data)
virtual

Method for grafting the content of one GPUDataManager into another one

◆ Initialize()

virtual void itk::GPUDataManager::Initialize ( )
virtual

Initialize GPUDataManager

◆ IsCPUBufferDirty()

bool itk::GPUDataManager::IsCPUBufferDirty ( ) const
inline

Definition at line 93 of file itkGPUDataManager.h.

References m_IsCPUBufferDirty.

◆ IsGPUBufferDirty()

bool itk::GPUDataManager::IsGPUBufferDirty ( ) const
inline

Definition at line 99 of file itkGPUDataManager.h.

References m_IsGPUBufferDirty.

◆ New()

static Pointer itk::GPUDataManager::New ( )
static

◆ PrintSelf()

void itk::GPUDataManager::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

◆ SetBufferFlag()

void itk::GPUDataManager::SetBufferFlag ( cl_mem_flags  flags)

◆ SetBufferSize()

void itk::GPUDataManager::SetBufferSize ( unsigned int  num)

total buffer size in bytes

◆ SetCPUBufferDirty()

void itk::GPUDataManager::SetCPUBufferDirty ( )

Make GPU up-to-date and mark CPU as dirty. Call this function when you want to modify CPU data

◆ SetCPUBufferPointer()

void itk::GPUDataManager::SetCPUBufferPointer ( void *  ptr)

◆ SetCPUDirtyFlag()

void itk::GPUDataManager::SetCPUDirtyFlag ( bool  isDirty)

◆ SetCurrentCommandQueue()

void itk::GPUDataManager::SetCurrentCommandQueue ( int  queueid)

◆ SetGPUBufferDirty()

void itk::GPUDataManager::SetGPUBufferDirty ( )

Make CPU up-to-date and mark GPU as dirty. Call this function when you want to modify GPU data

◆ SetGPUDirtyFlag()

void itk::GPUDataManager::SetGPUDirtyFlag ( bool  isDirty)

◆ Update()

bool itk::GPUDataManager::Update ( )

Synchronize CPU and GPU buffers (using dirty flags)

◆ UpdateCPUBuffer()

virtual void itk::GPUDataManager::UpdateCPUBuffer ( )
virtual

actual GPU->CPU memory copy takes place here

◆ UpdateGPUBuffer()

virtual void itk::GPUDataManager::UpdateGPUBuffer ( )
virtual

actual CPU->GPU memory copy takes place here

Friends And Related Function Documentation

◆ GPUKernelManager

friend class GPUKernelManager
friend

allow GPUKernelManager to access GPU buffer pointer

Definition at line 45 of file itkGPUDataManager.h.

Member Data Documentation

◆ m_BufferSize

unsigned int itk::GPUDataManager::m_BufferSize {}
protected

Definition at line 150 of file itkGPUDataManager.h.

Referenced by GetBufferSize().

◆ m_CommandQueueId

int itk::GPUDataManager::m_CommandQueueId {}
protected

Definition at line 154 of file itkGPUDataManager.h.

◆ m_ContextManager

GPUContextManager* itk::GPUDataManager::m_ContextManager {}
protected

Definition at line 152 of file itkGPUDataManager.h.

◆ m_CPUBuffer

void* itk::GPUDataManager::m_CPUBuffer {}
protected

Definition at line 161 of file itkGPUDataManager.h.

◆ m_GPUBuffer

cl_mem itk::GPUDataManager::m_GPUBuffer {}
protected

buffer pointers

Definition at line 160 of file itkGPUDataManager.h.

◆ m_IsCPUBufferDirty

bool itk::GPUDataManager::m_IsCPUBufferDirty {}
protected

Definition at line 165 of file itkGPUDataManager.h.

Referenced by IsCPUBufferDirty().

◆ m_IsGPUBufferDirty

bool itk::GPUDataManager::m_IsGPUBufferDirty {}
protected

checks if buffer needs to be updated

Definition at line 164 of file itkGPUDataManager.h.

Referenced by IsGPUBufferDirty().

◆ m_MemFlags

cl_mem_flags itk::GPUDataManager::m_MemFlags {}
protected

buffer type

Definition at line 157 of file itkGPUDataManager.h.

◆ m_Mutex

std::mutex itk::GPUDataManager::m_Mutex {}
protected

Mutex lock to prevent r/w hazard for multithreaded code

Definition at line 168 of file itkGPUDataManager.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3