GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LDT / V0-4-0
Constituent: encdec     Tag: rad750
Classes | |
struct | _HDE_assay |
The result of the histogram assessment. More... | |
Typedefs | |
typedef struct _HDE | HDE |
Typedef for struct _HDE. | |
typedef struct _HDE_assay | HDE_assay |
Typedef for _struct _HDE_assay. | |
Functions | |
void * | HDE_construct (HDE *hde, unsigned int huffman_nbins) |
Constructs (initializes) the specified HDE structure. | |
unsigned int | HDE_sizeof (unsigned int huffman_nbins) |
Returns the size, in bytes, for a handle to hold a Huffman distribution of huffman_bins. | |
unsigned int | HDE_encodeSS (HDE *hde, unsigned int *buf, unsigned int pos, unsigned int huffman_bins, const unsigned short int *hist, int nbins, const short int *symbols, int nsymbols) |
Encodes the specified symbols symbols using the specified histogram of frequencies. Both the symbols and the histogram are presented as 16-bit values. | |
const HDE_assay * | HDE_assayLocate (const HDE *hde) |
Returns a pointer to the publically defined piece of this structure. This can be a one-time call, i.e. for any given HDE structure, this routine always returns the same value. | |
void | HDE_histClearS (const HDE *hde, unsigned short int *hist) |
Clears the histogram using the active bin range stored in the HDE_assay block of the HDE structure. | |
void | HDE_histClearL (const HDE *hde, unsigned int *hist) |
Clears the histogram using the active bin range stored in the HDE_assay block of the HDE structure. | |
void | HDE_tableConstructL (HDE *hde, unsigned int nhuff, const unsigned int *hist, int nbins, int nentries) |
Constructs HDE Huffman Table associated with the specified distribution. | |
unsigned int | HDE_tableEncode (HDE *hde, unsigned int *buf, unsigned int pos) |
Encodes a previously constructed table. | |
unsigned int | HDE_symbolsEncodeS (HDE *hde, unsigned int *buf, unsigned int pos, const unsigned short int *symbols, int nsymbols) |
Encodes the set of symbols using the encoding information in hde. This encoding information must have been previously setup using HDE_encodeTable. |
CVS $Id: HDE.h,v 1.3 2009/04/29 23:18:27 russell Exp $
Typedef for _struct _HDE_assay.
Returns a pointer to the publically defined piece of this structure. This can be a one-time call, i.e. for any given HDE structure, this routine always returns the same value.
hde | The HDE control structure |
void HDE_construct | ( | HDE * | hde, | |
unsigned int | nhuff | |||
) |
Constructs (initializes) the specified HDE structure.
hde | The HDE control structure to construct | |
nhuff | The maximum number of Huffman encoding bins that this control structure is meant to support. |
unsigned int HDE_encodeSS | ( | HDE * | hde, | |
unsigned int * | buf, | |||
unsigned int | pos, | |||
unsigned int | nhuff, | |||
const unsigned short int * | hist, | |||
int | nbins, | |||
const short int * | symbols, | |||
int | nsymbols | |||
) |
Encodes the specified symbols symbols using the specified histogram of frequencies. Both the symbols and the histogram are presented as 16-bit values.
hde | The HDE control structure | |
buf | The output buffer address | |
pos | The current write bit offset | |
nhuff | Provides a means to limit the size of the huffman encoding region to a region that is smaller than what was specified during the HDE construction (i.e. the nhuff parameter) The construction value is used, if this value is 0 or larger. | |
hist | The frequency histogram. The histogram is such that it extends -/+ nbins from this pointer. That is, this is the center of the histogram. | |
nbins | The half width of the histogram | |
symbols | The array of symbols | |
nsymbols | The number of symbols |
void HDE_histClearL | ( | const HDE * | hde, | |
unsigned int * | hist | |||
) |
Clears the histogram using the active bin range stored in the HDE_assay block of the HDE structure.
hde | The HDE control handle | |
hist | The histogram to clear |
void HDE_histClearS | ( | const HDE * | hde, | |
unsigned short int * | hist | |||
) |
Clears the histogram using the active bin range stored in the HDE_assay block of the HDE structure.
hde | The HDE control handle | |
hist | The histogram to clear |
unsigned int HDE_sizeof | ( | unsigned int | nhuff | ) |
Returns the size, in bytes, for a handle to hold a Huffman distribution of huffman_bins.
nhuff | The maximum size of the Huffman encoding area Suggested values are small powers of 2 like 32, 64, 128. Note also up to 3 bins may be used to hold describe the underflow, overflow and exception areas. Currently these 3 are mapped into 1 bin, but this may change in a future implementation |
unsigned int HDE_symbolsEncodeS | ( | HDE * | hde, | |
unsigned int * | buf, | |||
unsigned int | pos, | |||
const unsigned short int * | symbols, | |||
int | nsymbols | |||
) |
Encodes the set of symbols using the encoding information in hde. This encoding information must have been previously setup using HDE_encodeTable.
hde | The HDE control structure | |
symbols | The array of symbols | |
nsymbols | The number of symbols | |
buf | The output buffer address | |
pos | The current write bit offset |
void HDE_tableConstructL | ( | HDE * | hde, | |
unsigned int | nhuff, | |||
const unsigned int * | hist, | |||
int | nbins, | |||
int | nentries | |||
) |
Constructs HDE Huffman Table associated with the specified distribution.
hde | The HDE control structure | |
nhuff | Provides a means to limit the size of the huffman encoding region to a region that is smaller than what was specified during the HDE construction (i.e. the nhuff parameter) The construction value is used, if this value is 0 or larger. | |
hist | The frequency histogram. The histogram is such that it extends -/+ nbins from this pointer. That is, this is the center of the histogram. | |
nbins | The half width of the histogram | |
nentries | The number of entries in the histogram |
unsigned int HDE_tableEncode | ( | HDE * | hde, | |
unsigned int * | buf, | |||
unsigned int | pos | |||
) |
Encodes a previously constructed table.
hde | The HDE control structure | |
buf | The output buffer address | |
pos | The current write bit offset |