Routines related to the gzip compression algorith.
More...
|
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 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.
|
|
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.
◆ Compress()
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] | DataIn | Pointer to the data to be compressed |
[in] | NBytesIn | The number of bytes to be compressed. Upon return, the size of the compressed buffer is returned. |
[out] | DataOut | Pointer to the data to be compressed |
[out] | NBytesOut | The number of bytes to be compressed. Upon return, the size of the compressed buffer is returned. |
- Todo
- Correct this documentation
- Parameters
-
[in] | DataIn | Pointer to the data to be compressed |
[in] | NBytesIn | The number of bytes to be compressed. Upon return, the size of the compressed buffer is returned. |
[out] | DataOut | Pointer to the data to be compressed |
[out] | NBytesOut | The number of bytes to be compressed. Upon return, the size of the compressed buffer is returned. |
- Todo
- Correct this documentation
◆ 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] | DataIn | The data to be expanded |
[in] | DataInBytes | Then number of bytes in DataIn. |
[in] | ByteSwap | If true, then perform byte swapping; false otherwise |
[in] | DataType | The data type of the compressed data. |
[out] | DataOut | If 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] | NDataOut | The number of data elements expected to be in the uncompressed buffer. |
[in] | NBytesOut | Then 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] | DataIn | The data to be expanded |
[in] | DataInBytes | Then number of bytes in DataIn. |
[in] | ByteSwap | If true, then perform byte swapping; false otherwise |
[in] | DataType | The data type of the compressed data. |
[out] | DataOut | If 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] | NDataOut | The number of data elements expected to be in the uncompressed buffer. |
[in] | NBytesOut | Then number of bytes allocated to DataOut. |