Point Cloud Library (PCL)  1.9.1-dev
List of all members | Public Member Functions | Protected Types | Protected Member Functions
pcl::StaticRangeCoder Class Reference

StaticRangeCoder compression class More...

#include <pcl/compression/entropy_range_coder.h>

Public Member Functions

 StaticRangeCoder ()
 Constructor. More...
 
virtual ~StaticRangeCoder ()
 Empty deconstructor. More...
 
unsigned long encodeIntVectorToStream (std::vector< unsigned int > &inputIntVector_arg, std::ostream &outputByterStream_arg)
 Encode integer vector to output stream. More...
 
unsigned long decodeStreamToIntVector (std::istream &inputByteStream_arg, std::vector< unsigned int > &outputIntVector_arg)
 Decode stream to output integer vector. More...
 
unsigned long encodeCharVectorToStream (const std::vector< char > &inputByteVector_arg, std::ostream &outputByteStream_arg)
 Encode char vector to output stream. More...
 
unsigned long decodeStreamToCharVector (std::istream &inputByteStream_arg, std::vector< char > &outputByteVector_arg)
 Decode char stream to output vector. More...
 

Protected Types

using DWord = boost::uint32_t
 

Protected Member Functions

double Log2 (double n_arg)
 Helper function to calculate the binary logarithm. More...
 

Detailed Description

StaticRangeCoder compression class

Note
This class provides static range coding functionality.
Its symbol probability/frequency table is precomputed and encoded to the output stream
Author
Julius Kammerl (juliu.nosp@m.s@ka.nosp@m.mmerl.nosp@m..de)

Definition at line 117 of file entropy_range_coder.h.

Member Typedef Documentation

◆ DWord

using pcl::StaticRangeCoder::DWord = boost::uint32_t
protected

Definition at line 165 of file entropy_range_coder.h.

Constructor & Destructor Documentation

◆ StaticRangeCoder()

pcl::StaticRangeCoder::StaticRangeCoder ( )
inline

Constructor.

Definition at line 121 of file entropy_range_coder.h.

◆ ~StaticRangeCoder()

virtual pcl::StaticRangeCoder::~StaticRangeCoder ( )
inlinevirtual

Member Function Documentation

◆ decodeStreamToCharVector()

unsigned long pcl::StaticRangeCoder::decodeStreamToCharVector ( std::istream &  inputByteStream_arg,
std::vector< char > &  outputByteVector_arg 
)

Decode char stream to output vector.

Parameters
inputByteStream_arginput stream of compressed data
outputByteVector_argdecompressed output vector
Returns
amount of bytes read from input stream

Definition at line 545 of file entropy_range_coder.hpp.

◆ decodeStreamToIntVector()

unsigned long pcl::StaticRangeCoder::decodeStreamToIntVector ( std::istream &  inputByteStream_arg,
std::vector< unsigned int > &  outputIntVector_arg 
)

Decode stream to output integer vector.

Parameters
inputByteStream_arginput stream of compressed data
outputIntVector_argdecompressed output vector
Returns
amount of bytes read from input stream

Definition at line 356 of file entropy_range_coder.hpp.

◆ encodeCharVectorToStream()

unsigned long pcl::StaticRangeCoder::encodeCharVectorToStream ( const std::vector< char > &  inputByteVector_arg,
std::ostream &  outputByteStream_arg 
)

Encode char vector to output stream.

Parameters
inputByteVector_arginput vector
outputByteStream_argoutput stream containing compressed data
Returns
amount of bytes written to output stream

Definition at line 446 of file entropy_range_coder.hpp.

◆ encodeIntVectorToStream()

unsigned long pcl::StaticRangeCoder::encodeIntVectorToStream ( std::vector< unsigned int > &  inputIntVector_arg,
std::ostream &  outputByterStream_arg 
)

Encode integer vector to output stream.

Parameters
[in]inputIntVector_arginput vector
[out]outputByterStream_argoutput stream containing compressed data
Returns
amount of bytes written to output stream

Definition at line 225 of file entropy_range_coder.hpp.

◆ Log2()

double pcl::StaticRangeCoder::Log2 ( double  n_arg)
inlineprotected

Helper function to calculate the binary logarithm.

Parameters
n_argsome value
Returns
binary logarithm (log2) of argument n_arg

Definition at line 173 of file entropy_range_coder.h.


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