---

GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> QSEC / V3-1-1 > qsec / linux-gcc

---

         

---

expand.c File Reference

Reverse a previous compaction. More...

#include "expand_p.h"
#include "expand.h"
#include "decompress.h"
#include "LDT/APD.h"
#include "LSEC/enums.h"
#include <string.h>

Functions
static unsigned char *	addDcm (QSEC_decompression **pdcm, unsigned char *next, unsigned int nbits, const char *name)
	Construct a decompression structure.
static const unsigned int *	recoverUserGem (QSEC_expansion *exp, const unsigned int *buf)
	Unpack the tables against which the GEM data were encoded.
static const unsigned int *	recoverUserAcd (QSEC_expansion *exp, const unsigned int *buf)
	Unpack the tables against which the ACD contributions were encoded.
static const unsigned int *	recoverUserCal (QSEC_expansion *exp, const unsigned int *buf)
	Unpack the tables against which the CAL contributions were encoded.
static const unsigned int *	recoverUserTkr (QSEC_expansion *exp, const unsigned int *buf)
	Unpack the tables against which the TKR contributions were encoded.
size_t	QSEC_sizeofExpansion (unsigned cap)
	Calculate the size of the memory block required to accomodate the expansion structure.
QSEC_expansion *	QSEC_constructExpansion (void *buffer, unsigned cap)
	Construct a QSEC_expansion structure in a buffer.
QSEC_expansion *	QSEC_newExpansion (unsigned cap)
	Allocate memory for a QSEC_expansion structure and all the substructures.
void	QSEC_deleteExpansion (QSEC_expansion *exp)
	Free memory previously allocated with a call to QSEC_newExpansion.
void	QSEC_clearExpansion (QSEC_expansion *exp)
	Clear away any context from a previous cycle.
void	QSEC_reportExpansion (QSEC_expansion *exp, FILE *fp)
	Report the contents of an expansion.
void	QSEC_setMode (QSEC_expansion *exp, unsigned mode)
	Set the calibration mode of an expansion.
void	QSEC_setFourRange (QSEC_expansion *exp, unsigned rng)
	Set the range for a calibration expansion.
unsigned	QSEC_monitorExpansion (QSEC_expansion *exp, unsigned mon)
	Set the monitoring level for the expansion.
const unsigned int *	QSEC_recoverUser (QSEC_expansion *exp, const unsigned int *buf)
	Unpack the tables against which the events were encoded.
const unsigned int *	decodeCalMeans (QSEC_expansion *exp, const unsigned int *buf)
	Decompress the calorimeter log mean values.

---

Detailed Description

Reverse a previous compaction.

Author:

James Swain & Owen Saxton

Id

---

Function Documentation

unsigned char * addDcm	(	QSEC_decompression **	pdcm,
		unsigned char *	next,
		unsigned int	nbits,
		const char *	name
	)			[inline, static]

Construct a decompression structure.

Constructs a decompression structure within the memory allocated for the expansion structure and returns a pointer to the location to place the next decompression

Parameters:

	pdcm	Pointer to the location to place the pointer to the decompression structure
	next	Pointer to the start of the memory to use for this decompression structure
	nbits	Number of bits in the symbols handled by this decompression structure
	name	String identifying the decompression structure

Returns:

Pointer to the location to place the next decompression structure

const unsigned int* decodeCalMeans	(	QSEC_expansion *	exp,
		const unsigned int *	buf
	)

Decompress the calorimeter log mean values.

Parameters:

	exp	Pointer to the expansion structure
	buf	Pointer to the compressed data

void QSEC_clearExpansion

(

QSEC_expansion *

exp

)

Clear away any context from a previous cycle.

Parameters:

exp

Pointer to a expansion object

QSEC_expansion* QSEC_constructExpansion	(	void *	buffer,
		unsigned	cap
	)

Construct a QSEC_expansion structure in a buffer.

Parameters:

	cap	Capacity of the decompression, maximum number of events in a single cycle
	buffer	Uninitialised memory large enough to hold the expansion structure

Returns:

Pointer to an initialised expansion structure

void QSEC_deleteExpansion

(

QSEC_expansion *

exp

)

Free memory previously allocated with a call to QSEC_newExpansion.

Parameters:

exp

Pointer to a expansion structure previously created by a call to QSEC_newExpansion

unsigned QSEC_monitorExpansion	(	QSEC_expansion *	exp,
		unsigned	mon
	)

Set the monitoring level for the expansion.

Parameters:

	exp	Pointer to an initialised expansion
	mon	Monitoring level

Returns:

Previous monitoring level

QSEC_expansion* QSEC_newExpansion

(

unsigned

cap

)

Allocate memory for a QSEC_expansion structure and all the substructures.

Parameters:

cap

Capacity of the decompression, maximum number of events in a single cycle

Returns:

Pointer to an allocated, initialise, QSEC_expansion structure

const unsigned int* QSEC_recoverUser	(	QSEC_expansion *	exp,
		const unsigned int *	buf
	)

Unpack the tables against which the events were encoded.

Parameters:

	buf	Pointer to the buffer where the context is held
	exp	Pointer to the structure containing the tables (an expansion)

Returns:

Pointer to the next input location to be read or NULL if there was an error during recovery of User data

void QSEC_reportExpansion	(	QSEC_expansion *	exp,
		FILE *	fp
	)

Report the contents of an expansion.

Parameters:

	exp	Pointer to a expansion object
	fp	Pointer to the destination file

void QSEC_setFourRange	(	QSEC_expansion *	exp,
		unsigned	rng
	)

Set the range for a calibration expansion.

Parameters:

	exp	Pointer to a expansion structure
	rng	Flag indicating 4-range or auto-range

void QSEC_setMode	(	QSEC_expansion *	exp,
		unsigned	mode
	)

Set the calibration mode of an expansion.

Parameters:

	exp	Pointer to a expansion structure
	mode	Type of calibration

size_t QSEC_sizeofExpansion

(

unsigned

cap

)

Calculate the size of the memory block required to accomodate the expansion structure.

Parameters:

cap

Capacity of the decompression, maximum number of events in a single cycle

Returns:

Size of the memory block required to accomodate the expansion structure

const unsigned int * recoverUserAcd	(	QSEC_expansion *	exp,
		const unsigned int *	buf
	)			[inline, static]

Unpack the tables against which the ACD contributions were encoded.

Parameters:

	buf	Pointer to the buffer where the context is held
	exp	Pointer to the structure containing the tables (an expansion)

Returns:

Pointer to the next input location to read or NULL if there is an error in the unpacking.

const unsigned int * recoverUserCal	(	QSEC_expansion *	exp,
		const unsigned int *	buf
	)			[inline, static]

Unpack the tables against which the CAL contributions were encoded.

Parameters:

	buf	Pointer to the buffer where the context is held
	exp	Pointer to the structure containing the tables (an expansion)

Returns:

Pointer to the next input location to read or NULL if there is an error in the unpacking.

const unsigned int * recoverUserGem	(	QSEC_expansion *	exp,
		const unsigned int *	buf
	)			[inline, static]

Unpack the tables against which the GEM data were encoded.

Parameters:

	buf	Pointer to the buffer where the context is held
	exp	Pointer to the structure containing the tables (an expansion)

Returns:

Pointer to the next input location to read or NULL if there is an error in the unpacking

const unsigned int * recoverUserTkr	(	QSEC_expansion *	exp,
		const unsigned int *	buf
	)			[inline, static]

Unpack the tables against which the TKR contributions were encoded.

Parameters:

	buf	Pointer to the buffer where the context is held
	exp	Pointer to the structure containing the tables (an expansion)

Returns:

Pointer to the next input location to read or NULL if there is an error in the unpacking.

---