Point Cloud Library (PCL)  1.3.1
Public Member Functions
pcl::octree::ColorCoding Class Reference

ColorCoding class More...

#include <pcl/compression/color_coding.h>

List of all members.

Public Member Functions

 ColorCoding ()
 Constructor.
virtual ~ColorCoding ()
 Empty class constructor.
void setBitDepth (unsigned char bitDepth_arg)
 Define color bit depth of encoded color information.
unsigned char getBitDepth ()
 Retrieve color bit depth of encoded color information.
void setVoxelCount (unsigned int voxelCount_arg)
 Set amount of voxels containing point color information and reserve memory.
void setPointCount (unsigned int pointCount_arg)
 Set amount of points within point cloud to be encoded and reserve memory.
void initializeEncoding ()
 Initialize encoding of color information.
void initializeDecoding ()
 Initialize decoding of color information.
std::vector< char > & getAverageDataVector ()
 Get reference to vector containing averaged color data.
std::vector< char > & getDifferentialDataVector ()
 Get reference to vector containing differential color data.
void encodeAverageOfPoints (const typename std::vector< int > &indexVector_arg, unsigned char rgba_offset_arg, PointCloudConstPtr inputCloud_arg)
 Encode averaged color information for a subset of points from point cloud.
void encodePoints (const typename std::vector< int > &indexVector_arg, unsigned char rgba_offset_arg, PointCloudConstPtr inputCloud_arg)
 Encode color information of a subset of points from point cloud.
void decodePoints (PointCloudPtr outputCloud_arg, std::size_t beginIdx_arg, std::size_t endIdx_arg, unsigned char rgba_offset_arg)
 Decode color information.
void setDefaultColor (PointCloudPtr outputCloud_arg, std::size_t beginIdx_arg, std::size_t endIdx_arg, unsigned char rgba_offset_arg)
 Set default color to points.

Detailed Description

ColorCoding class

Note:
This class encodes 8-bit color information for octree-based point cloud compression.
typename: PointT: type of point used in pointcloud
Author:
Julius Kammerl (julius@kammerl.de)

Constructor & Destructor Documentation

pcl::octree::ColorCoding::ColorCoding ( ) [inline]

Constructor.

Definition at line 76 of file color_coding.h.

virtual pcl::octree::ColorCoding::~ColorCoding ( ) [inline, virtual]

Empty class constructor.

Definition at line 83 of file color_coding.h.


Member Function Documentation

void pcl::octree::ColorCoding::decodePoints ( PointCloudPtr  outputCloud_arg,
std::size_t  beginIdx_arg,
std::size_t  endIdx_arg,
unsigned char  rgba_offset_arg 
) [inline]

Decode color information.

Parameters:
outputCloud_argoutput point cloud
beginIdx_argindex indicating first point to be assiged with color information
endIdx_argindex indicating last point to be assiged with color information
rgba_offset_argoffset to color information

Definition at line 303 of file color_coding.h.

void pcl::octree::ColorCoding::encodeAverageOfPoints ( const typename std::vector< int > &  indexVector_arg,
unsigned char  rgba_offset_arg,
PointCloudConstPtr  inputCloud_arg 
) [inline]

Encode averaged color information for a subset of points from point cloud.

Parameters:
indexVector_argindices defining a subset of points from points cloud
rgba_offset_argoffset to color information
inputCloud_arginput point cloud

Definition at line 170 of file color_coding.h.

void pcl::octree::ColorCoding::encodePoints ( const typename std::vector< int > &  indexVector_arg,
unsigned char  rgba_offset_arg,
PointCloudConstPtr  inputCloud_arg 
) [inline]

Encode color information of a subset of points from point cloud.

Parameters:
indexVector_argindices defining a subset of points from points cloud
rgba_offset_argoffset to color information
inputCloud_arginput point cloud

Definition at line 222 of file color_coding.h.

std::vector<char>& pcl::octree::ColorCoding::getAverageDataVector ( ) [inline]

Get reference to vector containing averaged color data.

Definition at line 151 of file color_coding.h.

unsigned char pcl::octree::ColorCoding::getBitDepth ( ) [inline]

Retrieve color bit depth of encoded color information.

Returns:
amounts of bits for representing one color component

Definition at line 103 of file color_coding.h.

std::vector<char>& pcl::octree::ColorCoding::getDifferentialDataVector ( ) [inline]

Get reference to vector containing differential color data.

Definition at line 159 of file color_coding.h.

void pcl::octree::ColorCoding::initializeDecoding ( ) [inline]

Initialize decoding of color information.

Definition at line 141 of file color_coding.h.

void pcl::octree::ColorCoding::initializeEncoding ( ) [inline]

Initialize encoding of color information.

Definition at line 131 of file color_coding.h.

void pcl::octree::ColorCoding::setBitDepth ( unsigned char  bitDepth_arg) [inline]

Define color bit depth of encoded color information.

Parameters:
bitDepth_arg,:amounts of bits for representing one color component

Definition at line 92 of file color_coding.h.

void pcl::octree::ColorCoding::setDefaultColor ( PointCloudPtr  outputCloud_arg,
std::size_t  beginIdx_arg,
std::size_t  endIdx_arg,
unsigned char  rgba_offset_arg 
) [inline]

Set default color to points.

Parameters:
outputCloud_argoutput point cloud
beginIdx_argindex indicating first point to be assiged with color information
endIdx_argindex indicating last point to be assiged with color information
rgba_offset_argoffset to color information

Definition at line 364 of file color_coding.h.

void pcl::octree::ColorCoding::setPointCount ( unsigned int  pointCount_arg) [inline]

Set amount of points within point cloud to be encoded and reserve memory.

Parameters:
pointCount_arg,:amounts of points within point cloud

Definition at line 123 of file color_coding.h.

void pcl::octree::ColorCoding::setVoxelCount ( unsigned int  voxelCount_arg) [inline]

Set amount of voxels containing point color information and reserve memory.

Parameters:
voxelCount_arg,:amounts of voxels

Definition at line 113 of file color_coding.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines