ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Compression::ZeroSuppress Namespace Reference

Routines related to the gzip compression algorith. More...

Typedefs

typedef boost::shared_array< CHAR_U > data_type
 
typedef data_type::element_type data_element_type
 
typedef INT_8U nbytes_type
 
typedef INT_8U ndata_type
 
typedef INT_4U data_type_type
 

Functions

template<int >
void Compress (const data_element_type *DataIn, nbytes_type NBytesIn, boost::shared_array< data_element_type > &DataOut, nbytes_type &NBytesOut)
 Compress the data with ZeroSuppress.
 
template<int >
void Compress (const data_element_type *DataIn, nbytes_type NBytesIn, data_type &DataOut, nbytes_type &NBytesOut)
 
template<int >
void Expand (const data_element_type *DataIn, nbytes_type DataInBytes, bool ByteSwap, boost::shared_array< data_element_type > &DataOut, ndata_type NDataOut, nbytes_type &NBytesOut)
 
template<int >
void Expand (const data_element_type *DataIn, nbytes_type DataInBytes, bool ByteSwap, data_type &DataOut, ndata_type NDataOut, nbytes_type &NBytesOut)
 
template<int >
void DiffCompress (const data_element_type *DataIn, nbytes_type NBytesIn, data_type_type DataType, boost::shared_array< data_element_type > &DataOut, nbytes_type &NBytesOut)
 
template<int >
void DiffCompress (const data_element_type *DataIn, nbytes_type NBytesIn, data_type_type DataType, data_type &DataOut, nbytes_type &NBytesOut)
 
template<int Size>
void DiffExpand (const data_element_type *DataIn, nbytes_type DataInBytes, bool ByteSwap, data_type_type DataType, boost::shared_array< data_element_type > &DataOut, ndata_type NDataOut, nbytes_type &NBytesOut)
 Expansion of the data.
 
template<int Size>
void DiffExpand (const data_element_type *DataIn, nbytes_type DataInBytes, bool ByteSwap, data_type_type DataType, data_type &DataOut, ndata_type NDataOut, nbytes_type &NBytesOut)
 Expansion of the data.
 
template<typename InType , typename OutType >
void diff_compress (const data_element_type *Source, INT_8U SourceLength, INT_4U DataType, boost::shared_array< data_element_type > &Dest, INT_8U &DestByteLength)
 
template<typename InType , typename OutType >
void expand (const data_element_type *DataIn, INT_8U DataInBytes, bool ByteSwap, boost::shared_array< data_element_type > &DataOut, INT_8U NDataOut, INT_8U &NBytesOut)
 
template<>
void Compress< 2 > (const data_element_type *Source, INT_8U SourceLength, boost::shared_array< data_element_type > &Dest, INT_8U &DestByteLength)
 
template<>
void Compress< 4 > (const data_element_type *Source, INT_8U SourceLength, boost::shared_array< data_element_type > &Dest, INT_8U &DestByteLength)
 
template<>
void Expand< 2 > (const data_element_type *DataIn, INT_8U DataInBytes, bool ByteSwap, boost::shared_array< data_element_type > &DataOut, ndata_type NDataOut, INT_8U &NBytesOut)
 
template<>
void Expand< 4 > (const data_element_type *DataIn, INT_8U DataInBytes, bool ByteSwap, boost::shared_array< data_element_type > &DataOut, ndata_type NDataOut, INT_8U &NBytesOut)
 
template<>
void Expand< 8 > (const data_element_type *DataIn, INT_8U DataInBytes, bool ByteSwap, boost::shared_array< data_element_type > &DataOut, ndata_type NDataOut, INT_8U &NBytesOut)
 
template<>
void DiffCompress< 2 > (const data_element_type *Source, INT_8U SourceLength, INT_4U DataType, boost::shared_array< data_element_type > &Dest, INT_8U &DestByteLength)
 
template<>
void DiffCompress< 4 > (const data_element_type *Source, INT_8U SourceLength, INT_4U DataType, boost::shared_array< data_element_type > &Dest, INT_8U &DestByteLength)
 
template<>
void DiffCompress< 8 > (const data_element_type *Source, INT_8U SourceLength, INT_4U DataType, boost::shared_array< data_element_type > &Dest, INT_8U &DestByteLength)
 
 INSTANTIATE (2)
 
 INSTANTIATE (4)
 
 INSTANTIATE (8)
 

Detailed Description

Routines related to the gzip compression algorith.

The routines defined in this namespace are specific to the ZeroSuppress compression algorithm. Routines are defined for both compression and decompression of data buffers.

Typedef Documentation

◆ data_element_type

◆ data_type

typedef boost::shared_array< CHAR_U > FrameCPP::Compression::ZeroSuppress::data_type

◆ data_type_type

◆ nbytes_type

◆ ndata_type

Function Documentation

◆ Compress() [1/2]

template<int >
void FrameCPP::Compression::ZeroSuppress::Compress ( const data_element_type * DataIn,
nbytes_type NBytesIn,
boost::shared_array< data_element_type > & DataOut,
nbytes_type & NBytesOut )

Compress the data with ZeroSuppress.

Parameters
[in]DataInPointer to the data to be compressed
[in]NBytesInThe number of bytes to be compressed. Upon return, the size of the compressed buffer is returned.
[out]DataOutPointer to the data to be compressed
[out]NBytesOutThe number of bytes to be compressed. Upon return, the size of the compressed buffer is returned.
Todo
Correct this documentation
Parameters
[in]DataInPointer to the data to be compressed
[in]NBytesInThe number of bytes to be compressed. Upon return, the size of the compressed buffer is returned.
[out]DataOutPointer to the data to be compressed
[out]NBytesOutThe number of bytes to be compressed. Upon return, the size of the compressed buffer is returned.
Todo
Correct this documentation

◆ Compress() [2/2]

template<int >
void FrameCPP::Compression::ZeroSuppress::Compress ( const data_element_type * DataIn,
nbytes_type NBytesIn,
data_type & DataOut,
nbytes_type & NBytesOut )

◆ Compress< 2 >()

template<>
void FrameCPP::Compression::ZeroSuppress::Compress< 2 > ( const data_element_type * Source,
INT_8U SourceLength,
boost::shared_array< data_element_type > & Dest,
INT_8U & DestByteLength )

◆ Compress< 4 >()

template<>
void FrameCPP::Compression::ZeroSuppress::Compress< 4 > ( const data_element_type * Source,
INT_8U SourceLength,
boost::shared_array< data_element_type > & Dest,
INT_8U & DestByteLength )

◆ diff_compress()

template<typename InType , typename OutType >
void FrameCPP::Compression::ZeroSuppress::diff_compress ( const data_element_type * Source,
INT_8U SourceLength,
INT_4U DataType,
boost::shared_array< data_element_type > & Dest,
INT_8U & DestByteLength )

◆ DiffCompress() [1/2]

template<int >
void FrameCPP::Compression::ZeroSuppress::DiffCompress ( const data_element_type * DataIn,
nbytes_type NBytesIn,
data_type_type DataType,
boost::shared_array< data_element_type > & DataOut,
nbytes_type & NBytesOut )

◆ DiffCompress() [2/2]

template<int >
void FrameCPP::Compression::ZeroSuppress::DiffCompress ( const data_element_type * DataIn,
nbytes_type NBytesIn,
data_type_type DataType,
data_type & DataOut,
nbytes_type & NBytesOut )

◆ DiffCompress< 2 >()

template<>
void FrameCPP::Compression::ZeroSuppress::DiffCompress< 2 > ( const data_element_type * Source,
INT_8U SourceLength,
INT_4U DataType,
boost::shared_array< data_element_type > & Dest,
INT_8U & DestByteLength )

◆ DiffCompress< 4 >()

template<>
void FrameCPP::Compression::ZeroSuppress::DiffCompress< 4 > ( const data_element_type * Source,
INT_8U SourceLength,
INT_4U DataType,
boost::shared_array< data_element_type > & Dest,
INT_8U & DestByteLength )

◆ DiffCompress< 8 >()

template<>
void FrameCPP::Compression::ZeroSuppress::DiffCompress< 8 > ( const data_element_type * Source,
INT_8U SourceLength,
INT_4U DataType,
boost::shared_array< data_element_type > & Dest,
INT_8U & DestByteLength )

◆ DiffExpand() [1/2]

template<int Size>
void FrameCPP::Compression::ZeroSuppress::DiffExpand ( const data_element_type * DataIn,
nbytes_type DataInBytes,
bool ByteSwap,
data_type_type DataType,
boost::shared_array< data_element_type > & DataOut,
ndata_type NDataOut,
nbytes_type & NBytesOut )

Expansion of the data.

Parameters
[in]DataInThe data to be expanded
[in]DataInBytesThen number of bytes in DataIn.
[in]ByteSwapIf true, then perform byte swapping; false otherwise
[in]DataTypeThe data type of the compressed data.
[out]DataOutIf DataIn is uncompressable, then the resulting uncompressed data is stored here. If DataIn is can not be uncompressed, then this will be set to a NULL pointer.
[in]NDataOutThe number of data elements expected to be in the uncompressed buffer.
[in]NBytesOutThen number of bytes allocated to DataOut.

◆ DiffExpand() [2/2]

template<int Size>
void FrameCPP::Compression::ZeroSuppress::DiffExpand ( const data_element_type * DataIn,
nbytes_type DataInBytes,
bool ByteSwap,
data_type_type DataType,
data_type & DataOut,
ndata_type NDataOut,
nbytes_type & NBytesOut )

Expansion of the data.

Parameters
[in]DataInThe data to be expanded
[in]DataInBytesThen number of bytes in DataIn.
[in]ByteSwapIf true, then perform byte swapping; false otherwise
[in]DataTypeThe data type of the compressed data.
[out]DataOutIf DataIn is uncompressable, then the resulting uncompressed data is stored here. If DataIn is can not be uncompressed, then this will be set to a NULL pointer.
[in]NDataOutThe number of data elements expected to be in the uncompressed buffer.
[in]NBytesOutThen number of bytes allocated to DataOut.

◆ Expand() [1/2]

template<int >
void FrameCPP::Compression::ZeroSuppress::Expand ( const data_element_type * DataIn,
nbytes_type DataInBytes,
bool ByteSwap,
boost::shared_array< data_element_type > & DataOut,
ndata_type NDataOut,
nbytes_type & NBytesOut )

◆ Expand() [2/2]

template<int >
void FrameCPP::Compression::ZeroSuppress::Expand ( const data_element_type * DataIn,
nbytes_type DataInBytes,
bool ByteSwap,
data_type & DataOut,
ndata_type NDataOut,
nbytes_type & NBytesOut )

◆ expand()

template<typename InType , typename OutType >
void FrameCPP::Compression::ZeroSuppress::expand ( const data_element_type * DataIn,
INT_8U DataInBytes,
bool ByteSwap,
boost::shared_array< data_element_type > & DataOut,
INT_8U NDataOut,
INT_8U & NBytesOut )

◆ Expand< 2 >()

template<>
void FrameCPP::Compression::ZeroSuppress::Expand< 2 > ( const data_element_type * DataIn,
INT_8U DataInBytes,
bool ByteSwap,
boost::shared_array< data_element_type > & DataOut,
ndata_type NDataOut,
INT_8U & NBytesOut )

◆ Expand< 4 >()

template<>
void FrameCPP::Compression::ZeroSuppress::Expand< 4 > ( const data_element_type * DataIn,
INT_8U DataInBytes,
bool ByteSwap,
boost::shared_array< data_element_type > & DataOut,
ndata_type NDataOut,
INT_8U & NBytesOut )

◆ Expand< 8 >()

template<>
void FrameCPP::Compression::ZeroSuppress::Expand< 8 > ( const data_element_type * DataIn,
INT_8U DataInBytes,
bool ByteSwap,
boost::shared_array< data_element_type > & DataOut,
ndata_type NDataOut,
INT_8U & NBytesOut )

◆ INSTANTIATE() [1/3]

FrameCPP::Compression::ZeroSuppress::INSTANTIATE ( 2 )

◆ INSTANTIATE() [2/3]

FrameCPP::Compression::ZeroSuppress::INSTANTIATE ( 4 )

◆ INSTANTIATE() [3/3]

FrameCPP::Compression::ZeroSuppress::INSTANTIATE ( 8 )