Point Cloud Library (PCL)  1.9.1-dev
List of all members | Public Types | Public Member Functions
pcl::gpu::DeviceArray2D< T > Class Template Reference

DeviceArray2D class More...

#include </__w/1/s/gpu/containers/include/pcl/gpu/containers/device_array.h>

+ Inheritance diagram for pcl::gpu::DeviceArray2D< T >:

Public Types

enum  { elem_size = sizeof(T) }
 Element size. More...
 
typedef T type
 Element type. More...
 

Public Member Functions

 DeviceArray2D ()
 Empty constructor. More...
 
 DeviceArray2D (int rows, int cols)
 Allocates internal buffer in GPU memory. More...
 
 DeviceArray2D (int rows, int cols, void *data, size_t stepBytes)
 Initializes with user allocated buffer. More...
 
 DeviceArray2D (const DeviceArray2D &other)
 Copy constructor. More...
 
DeviceArray2Doperator= (const DeviceArray2D &other)
 Assignment operator. More...
 
void create (int rows, int cols)
 Allocates internal buffer in GPU memory. More...
 
void release ()
 Decrements reference counter and releases internal buffer if needed. More...
 
void copyTo (DeviceArray2D &other) const
 Performs data copying. More...
 
void upload (const void *host_ptr, size_t host_step, int rows, int cols)
 Uploads data to internal buffer in GPU memory. More...
 
void download (void *host_ptr, size_t host_step) const
 Downloads data from internal buffer to CPU memory. More...
 
void swap (DeviceArray2D &other_arg)
 Performs swap of data pointed with another device array. More...
 
template<class A >
void upload (const std::vector< T, A > &data, int cols)
 Uploads data to internal buffer in GPU memory. More...
 
template<class A >
void download (std::vector< T, A > &data, int &cols) const
 Downloads data from internal buffer to CPU memory. More...
 
T * ptr (int y=0)
 Returns pointer to given row in internal buffer. More...
 
const T * ptr (int y=0) const
 Returns const pointer to given row in internal buffer. More...
 
 operator T * ()
 Returns pointer for internal buffer in GPU memory. More...
 
 operator const T * () const
 Returns const pointer for internal buffer in GPU memory. More...
 
int cols () const
 Returns number of elements in each row. More...
 
int rows () const
 Returns number of rows. More...
 
size_t elem_step () const
 Returns step in elements. More...
 
- Public Member Functions inherited from pcl::gpu::DeviceMemory2D
 DeviceMemory2D ()
 Empty constructor. More...
 
 ~DeviceMemory2D ()
 Destructor. More...
 
 DeviceMemory2D (int rows_arg, int colsBytes_arg)
 Allocates internal buffer in GPU memory. More...
 
 DeviceMemory2D (int rows_arg, int colsBytes_arg, void *data_arg, size_t step_arg)
 Initializes with user allocated buffer. More...
 
 DeviceMemory2D (const DeviceMemory2D &other_arg)
 Copy constructor. More...
 
DeviceMemory2Doperator= (const DeviceMemory2D &other_arg)
 Assignment operator. More...
 
void create (int rows_arg, int colsBytes_arg)
 Allocates internal buffer in GPU memory. More...
 
void release ()
 Decrements reference counter and releases internal buffer if needed. More...
 
void copyTo (DeviceMemory2D &other) const
 Performs data copying. More...
 
void upload (const void *host_ptr_arg, size_t host_step_arg, int rows_arg, int colsBytes_arg)
 Uploads data to internal buffer in GPU memory. More...
 
void download (void *host_ptr_arg, size_t host_step_arg) const
 Downloads data from internal buffer to CPU memory. More...
 
void swap (DeviceMemory2D &other_arg)
 Performs swap of data pointed with another device memory. More...
 
template<class T >
T * ptr (int y_arg=0)
 Returns pointer to given row in internal buffer. More...
 
template<class T >
const T * ptr (int y_arg=0) const
 Returns constant pointer to given row in internal buffer. More...
 
template<class U >
 operator PtrStep< U > () const
 Conversion to PtrStep for passing to kernel functions. More...
 
template<class U >
 operator PtrStepSz< U > () const
 Conversion to PtrStepSz for passing to kernel functions. More...
 
bool empty () const
 Returns true if unallocated otherwise false. More...
 
int colsBytes () const
 Returns number of bytes in each row. More...
 
int rows () const
 Returns number of rows. More...
 
size_t step () const
 Returns stride between two consecutive rows in bytes for internal buffer. More...
 

Detailed Description

template<class T>
class pcl::gpu::DeviceArray2D< T >

DeviceArray2D class

Note
Typed container for pitched GPU memory with reference counting.
Author
Anatoly Baksheev

Definition at line 153 of file device_array.h.

Member Typedef Documentation

template<class T>
typedef T pcl::gpu::DeviceArray2D< T >::type

Element type.

Definition at line 157 of file device_array.h.

Member Enumeration Documentation

template<class T>
anonymous enum

Element size.

Enumerator
elem_size 

Definition at line 160 of file device_array.h.

Constructor & Destructor Documentation

template<class T >
pcl::gpu::DeviceArray2D< T >::DeviceArray2D ( )
inline

Empty constructor.

Definition at line 76 of file device_array.hpp.

template<class T >
pcl::gpu::DeviceArray2D< T >::DeviceArray2D ( int  rows,
int  cols 
)
inline

Allocates internal buffer in GPU memory.

Parameters
rowsnumber of rows to allocate
colsnumber of elements in each row

Definition at line 77 of file device_array.hpp.

template<class T >
pcl::gpu::DeviceArray2D< T >::DeviceArray2D ( int  rows,
int  cols,
void *  data,
size_t  stepBytes 
)
inline

Initializes with user allocated buffer.

Reference counting is disabled in this case.

Parameters
rowsnumber of rows
colsnumber of elements in each row
datapointer to buffer
stepBytesstride between two consecutive rows in bytes

Definition at line 78 of file device_array.hpp.

template<class T >
pcl::gpu::DeviceArray2D< T >::DeviceArray2D ( const DeviceArray2D< T > &  other)
inline

Copy constructor.

Just increments reference counter.

Definition at line 79 of file device_array.hpp.

Member Function Documentation

template<class T >
int pcl::gpu::DeviceArray2D< T >::cols ( ) const
inline
template<class T >
void pcl::gpu::DeviceArray2D< T >::copyTo ( DeviceArray2D< T > &  other) const
inline

Performs data copying.

If destination size differs it will be reallocated.

Parameters
otherdestination container

Definition at line 88 of file device_array.hpp.

References pcl::gpu::DeviceMemory2D::copyTo().

template<class T >
void pcl::gpu::DeviceArray2D< T >::create ( int  rows,
int  cols 
)
inline

Allocates internal buffer in GPU memory.

If internal buffer was created before the function recreates it with new size. If new and old sizes are equal it does nothing.

Parameters
rowsnumber of rows to allocate
colsnumber of elements in each row

Definition at line 83 of file device_array.hpp.

References pcl::gpu::DeviceMemory2D::create(), and pcl::gpu::DeviceArray2D< T >::elem_size.

template<class T >
void pcl::gpu::DeviceArray2D< T >::download ( void *  host_ptr,
size_t  host_step 
) const
inline

Downloads data from internal buffer to CPU memory.

User is responsible for correct host buffer size.

Parameters
host_ptrpointer to host buffer to download
host_stepstride between two consecutive rows in bytes for host buffer

Definition at line 92 of file device_array.hpp.

References pcl::gpu::DeviceMemory2D::download().

Referenced by pcl::gpu::DeviceArray2D< T >::download().

template<class T>
template<class A >
void pcl::gpu::DeviceArray2D< T >::download ( std::vector< T, A > &  data,
int &  cols 
) const
inline

Downloads data from internal buffer to CPU memory.

Parameters
datahost vector to download to
colsOutput stride in elements between two consecutive rows for host vector.

Definition at line 98 of file device_array.hpp.

References pcl::gpu::DeviceArray2D< T >::cols(), pcl::gpu::DeviceMemory2D::colsBytes(), pcl::gpu::DeviceArray2D< T >::download(), and pcl::gpu::DeviceArray2D< T >::rows().

template<class T >
size_t pcl::gpu::DeviceArray2D< T >::elem_step ( ) const
inline

Returns step in elements.

Definition at line 112 of file device_array.hpp.

References pcl::gpu::DeviceArray2D< T >::elem_size, and pcl::gpu::DeviceMemory2D::step().

template<class T >
pcl::gpu::DeviceArray2D< T >::operator const T * ( ) const
inline

Returns const pointer for internal buffer in GPU memory.

Definition at line 107 of file device_array.hpp.

References pcl::gpu::DeviceArray2D< T >::ptr().

template<class T >
pcl::gpu::DeviceArray2D< T >::operator T * ( )
inline

Returns pointer for internal buffer in GPU memory.

Definition at line 106 of file device_array.hpp.

References pcl::gpu::DeviceArray2D< T >::ptr().

template<class T >
pcl::gpu::DeviceArray2D< T > & pcl::gpu::DeviceArray2D< T >::operator= ( const DeviceArray2D< T > &  other)
inline

Assignment operator.

Just increments reference counter.

Definition at line 80 of file device_array.hpp.

References pcl::gpu::DeviceMemory2D::operator=().

template<class T >
T * pcl::gpu::DeviceArray2D< T >::ptr ( int  y = 0)
inline
template<class T >
const T * pcl::gpu::DeviceArray2D< T >::ptr ( int  y = 0) const
inline

Returns const pointer to given row in internal buffer.

Parameters
yrow index

Definition at line 104 of file device_array.hpp.

template<class T >
void pcl::gpu::DeviceArray2D< T >::release ( )
inline

Decrements reference counter and releases internal buffer if needed.

Definition at line 85 of file device_array.hpp.

References pcl::gpu::DeviceMemory2D::release().

template<class T >
int pcl::gpu::DeviceArray2D< T >::rows ( ) const
inline
template<class T >
void pcl::gpu::DeviceArray2D< T >::swap ( DeviceArray2D< T > &  other_arg)

Performs swap of data pointed with another device array.

Parameters
other_argdevice array to swap with

Definition at line 101 of file device_array.hpp.

References pcl::gpu::DeviceMemory2D::swap().

template<class T >
void pcl::gpu::DeviceArray2D< T >::upload ( const void *  host_ptr,
size_t  host_step,
int  rows,
int  cols 
)
inline

Uploads data to internal buffer in GPU memory.

It calls create() inside to ensure that intenal buffer size is enough.

Parameters
host_ptrpointer to host buffer to upload
host_stepstride between two consecutive rows in bytes for host buffer
rowsnumber of rows to upload
colsnumber of elements in each row

Definition at line 90 of file device_array.hpp.

References pcl::gpu::DeviceArray2D< T >::elem_size, and pcl::gpu::DeviceMemory2D::upload().

Referenced by pcl::gpu::DeviceArray2D< T >::upload().

template<class T>
template<class A >
void pcl::gpu::DeviceArray2D< T >::upload ( const std::vector< T, A > &  data,
int  cols 
)
inline

Uploads data to internal buffer in GPU memory.

It calls create() inside to ensure that intenal buffer size is enough.

Parameters
datahost vector to upload from
colsstride in elements between two consecutive rows for host buffer

Definition at line 95 of file device_array.hpp.

References pcl::gpu::DeviceArray2D< T >::cols(), pcl::gpu::DeviceArray2D< T >::elem_size, and pcl::gpu::DeviceArray2D< T >::upload().


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