#include <itkGPUImageDataManager.h>

Detailed Description

template<typename ImageType>
class itk::GPUImageDataManager< ImageType >

DataManager for GPUImage. This class will take care of data synchronization between CPU Image and GPU Image.

Definition at line 45 of file itkGPUImageDataManager.h.

Inheritance diagram for itk::GPUImageDataManager< ImageType >:

Collaboration diagram for itk::GPUImageDataManager< ImageType >:

Public Types
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = GPUImageDataManager

using	Superclass = GPUDataManager

Public Types inherited from itk::GPUDataManager
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
virtual::itk::LightObject::Pointer	CreateAnother () const

virtual const GPUDataManager *	GetGPUBufferedRegionIndex () const

virtual const GPUDataManager *	GetGPUBufferedRegionSize () const

ImageType *	GetImagePointer ()

virtual GPUDataManager *	GetModifiableGPUBufferedRegionIndex ()

virtual GPUDataManager *	GetModifiableGPUBufferedRegionSize ()

const char *	GetNameOfClass () const override

virtual void	MakeCPUBufferUpToDate ()

virtual void	MakeGPUBufferUpToDate ()

void	SetImagePointer (ImageType *img)

Public Member Functions inherited from itk::GPUDataManager
void	Allocate ()

unsigned int	GetBufferSize () const

void *	GetCPUBufferPointer ()

int	GetCurrentCommandQueueID () const

cl_mem *	GetGPUBufferPointer ()

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 void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::GPUDataManager
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 ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = ImageType::ImageDimension

Protected Member Functions
	GPUImageDataManager ()=default

	~GPUImageDataManager () override=default

Protected Member Functions inherited from itk::GPUDataManager
	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	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
int	m_BufferedRegionIndex [ImageType::ImageDimension] {}

int	m_BufferedRegionSize [ImageType::ImageDimension] {}

GPUDataManager::Pointer	m_GPUBufferedRegionIndex {}

GPUDataManager::Pointer	m_GPUBufferedRegionSize {}

WeakPointer< ImageType >	m_Image {}

Friends
class	GPUImage< typename ImageType::PixelType, ImageType::ImageDimension >

class	GPUKernelManager

Additional Inherited Members
Protected Attributes inherited from itk::GPUDataManager
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 {}

Member Typedef Documentation

◆ ConstPointer

template<typename ImageType>

using itk::GPUImageDataManager< ImageType >::ConstPointer = SmartPointer<const Self>

Definition at line 57 of file itkGPUImageDataManager.h.

◆ Pointer

template<typename ImageType>

using itk::GPUImageDataManager< ImageType >::Pointer = SmartPointer<Self>

Definition at line 56 of file itkGPUImageDataManager.h.

◆ Self

template<typename ImageType>

using itk::GPUImageDataManager< ImageType >::Self = GPUImageDataManager

Definition at line 54 of file itkGPUImageDataManager.h.

◆ Superclass

template<typename ImageType>

using itk::GPUImageDataManager< ImageType >::Superclass = GPUDataManager

Definition at line 55 of file itkGPUImageDataManager.h.

Constructor & Destructor Documentation

◆ GPUImageDataManager()

template<typename ImageType>

itk::GPUImageDataManager< ImageType >::GPUImageDataManager ( )

protecteddefault

◆ ~GPUImageDataManager()

template<typename ImageType>

itk::GPUImageDataManager< ImageType >::~GPUImageDataManager ( )

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename ImageType>

virtual::itk::LightObject::Pointer itk::GPUImageDataManager< ImageType >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::GPUDataManager.

◆ GetGPUBufferedRegionIndex()

template<typename ImageType>

virtual const GPUDataManager * itk::GPUImageDataManager< ImageType >::GetGPUBufferedRegionIndex ( ) const

virtual

◆ GetGPUBufferedRegionSize()

template<typename ImageType>

virtual const GPUDataManager * itk::GPUImageDataManager< ImageType >::GetGPUBufferedRegionSize ( ) const

virtual

◆ GetImagePointer()

template<typename ImageType>

ImageType * itk::GPUImageDataManager< ImageType >::GetImagePointer ( )

inline

Definition at line 71 of file itkGPUImageDataManager.h.

References GetImagePointer(), and m_Image.

Referenced by GetImagePointer().

◆ GetModifiableGPUBufferedRegionIndex()

template<typename ImageType>

virtual GPUDataManager * itk::GPUImageDataManager< ImageType >::GetModifiableGPUBufferedRegionIndex ( )

virtual

◆ GetModifiableGPUBufferedRegionSize()

template<typename ImageType>

virtual GPUDataManager * itk::GPUImageDataManager< ImageType >::GetModifiableGPUBufferedRegionSize ( )

virtual

◆ GetNameOfClass()

template<typename ImageType>

const char * itk::GPUImageDataManager< ImageType >::GetNameOfClass ( ) const

overridevirtual

Return the name of this class as a string. Used by the object factory (implemented in New()) to instantiate objects of a named type. Also used for debugging and other output information.

Reimplemented from itk::GPUDataManager.

◆ MakeCPUBufferUpToDate()

template<typename ImageType>

virtual void itk::GPUImageDataManager< ImageType >::MakeCPUBufferUpToDate ( )

virtual

actual GPU->CPU memory copy takes place here

◆ MakeGPUBufferUpToDate()

template<typename ImageType>

virtual void itk::GPUImageDataManager< ImageType >::MakeGPUBufferUpToDate ( )

virtual

actual CPU->GPU memory copy takes place here

◆ New()

template<typename ImageType>

static Pointer itk::GPUImageDataManager< ImageType >::New ( )

static

◆ SetImagePointer()

template<typename ImageType>

void itk::GPUImageDataManager< ImageType >::SetImagePointer ( ImageType * img )

References SetImagePointer().

Referenced by SetImagePointer().

Friends And Related Symbol Documentation

◆ GPUImage< typename ImageType::PixelType, ImageType::ImageDimension >

template<typename ImageType>

friend class GPUImage< typename ImageType::PixelType, ImageType::ImageDimension >

friend

Definition at line 48 of file itkGPUImageDataManager.h.

References GPUKernelManager.

◆ GPUKernelManager

template<typename ImageType>

friend class GPUKernelManager

friend

Definition at line 48 of file itkGPUImageDataManager.h.

Referenced by GPUImage< typename ImageType::PixelType, ImageType::ImageDimension >.

Member Data Documentation

◆ ImageDimension

template<typename ImageType>

unsigned int itk::GPUImageDataManager< ImageType >::ImageDimension = ImageType::ImageDimension

staticconstexpr

Definition at line 62 of file itkGPUImageDataManager.h.

◆ m_BufferedRegionIndex

template<typename ImageType>

int itk::GPUImageDataManager< ImageType >::m_BufferedRegionIndex[ImageType::ImageDimension] {}

private

Definition at line 91 of file itkGPUImageDataManager.h.

◆ m_BufferedRegionSize

template<typename ImageType>

int itk::GPUImageDataManager< ImageType >::m_BufferedRegionSize[ImageType::ImageDimension] {}

private

Definition at line 92 of file itkGPUImageDataManager.h.

◆ m_GPUBufferedRegionIndex

template<typename ImageType>

GPUDataManager::Pointer itk::GPUImageDataManager< ImageType >::m_GPUBufferedRegionIndex {}

private

Definition at line 93 of file itkGPUImageDataManager.h.

◆ m_GPUBufferedRegionSize

template<typename ImageType>

GPUDataManager::Pointer itk::GPUImageDataManager< ImageType >::m_GPUBufferedRegionSize {}

private

Definition at line 94 of file itkGPUImageDataManager.h.

◆ m_Image

template<typename ImageType>

WeakPointer<ImageType> itk::GPUImageDataManager< ImageType >::m_Image {}

private

Definition at line 89 of file itkGPUImageDataManager.h.

Referenced by GetImagePointer().

The documentation for this class was generated from the following file:

itkGPUImageDataManager.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ GPUImageDataManager()

◆ ~GPUImageDataManager()

Member Function Documentation

◆ CreateAnother()

◆ GetGPUBufferedRegionIndex()

◆ GetGPUBufferedRegionSize()

◆ GetImagePointer()

◆ GetModifiableGPUBufferedRegionIndex()

◆ GetModifiableGPUBufferedRegionSize()

◆ GetNameOfClass()

◆ MakeCPUBufferUpToDate()

◆ MakeGPUBufferUpToDate()

◆ New()

◆ SetImagePointer()

Friends And Related Symbol Documentation

◆ GPUImage< typename ImageType::PixelType, ImageType::ImageDimension >

◆ GPUKernelManager

Member Data Documentation

◆ ImageDimension

◆ m_BufferedRegionIndex

◆ m_BufferedRegionSize

◆ m_GPUBufferedRegionIndex

◆ m_GPUBufferedRegionSize

◆ m_Image