expand.h File Reference

Expansion routines. More...

#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>

Typedefs
typedef struct QSEC_expansion_	QSEC_expansion
	Declaration of the opaque expansion structure.
Functions
void	QSEC_clearExpansion (QSEC_expansion *exp)
	Clear away any context from a previous cycle.
QSEC_expansion *	QSEC_constructExpansion (void *buffer, unsigned cap)
	Construct a QSEC_expansion structure in a buffer.
const unsigned int *	QSEC_recoverUser (QSEC_expansion *exp, const unsigned int *buf)
	Unpack the tables against which the events were encoded.
void	QSEC_reportExpansion (QSEC_expansion *exp, FILE *fp)
	Report the contents of an expansion.
void	QSEC_reportExpCtx (QSEC_expansion *exp, FILE *fp)
	Report the contents of the expansion context.
void	QSEC_setMode (QSEC_expansion *exp, unsigned mode)
	Set the calibration mode of an expansion.
size_t	QSEC_sizeofExpansion (unsigned cap)
	Calculate the size of the memory block required to accomodate the expansion structure.

---

Detailed Description

Expansion routines.

Author:

James Swain & Owen Saxton

Id

expand.h,v 1.5 2010/05/27 20:37:14 saxton Exp

---

Function Documentation

void QSEC_clearExpansion

(

QSEC_expansion *

exp

)

Clear away any context from a previous cycle.

Parameters:

exp

Pointer to a expansion object

References QSEC_calDecompress::accepts, QSEC_expansion_::acd, QSEC_acdDecompress::cables, QSEC_expansion_::cal, QSEC_acdDecompress::chns, QSEC_gemDecompress::cno, QSEC_calDecompress::columns, QSEC_gemDecompress::cond, QSEC_tkrDecompress::diags, QSEC_calDecompress::diags, QSEC_expansion_::dtx, QSEC_expansion_::gem, QSEC_gemDecompress::high, QSEC_calDecompress::layCnts, QSEC_tkrDecompress::layers, QSEC_calDecompress::logs, QSEC_gemDecompress::low, QSEC_calDecompress::mean, QSEC_calDecompress::means, QSEC_acdDecompress::phas, QSEC_acdDecompress::pvahs, QSEC_clearDecompression(), QSEC_calDecompress::ranges, QSEC_gemDecompress::rbn, QSEC_tkrDecompress::requests, QSEC_gemDecompress::roi, QSEC_tkrDecompress::strips, QSEC_expansion_::tkr, QSEC_gemDecompress::tkr, QSEC_tkrDecompress::tots, QSEC_tkrDecompress::towers, QSEC_calDecompress::towers, QSEC_gemDecompress::xy0, QSEC_gemDecompress::xy1, QSEC_gemDecompress::xzm, QSEC_gemDecompress::xzp, QSEC_gemDecompress::yzm, and QSEC_gemDecompress::yzp.

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

References QSEC_calDecompress::accepts, QSEC_expansion_::acd, addDcm(), QSEC_acdDecompress::cables, QSEC_expansion_::cal, QSEC_acdDecompress::chns, QSEC_gemDecompress::cno, QSEC_calDecompress::columns, QSEC_gemDecompress::cond, QSEC_tkrDecompress::diags, QSEC_calDecompress::diags, QSEC_expansion_::gem, QSEC_gemDecompress::high, QSEC_calDecompress::layCnts, QSEC_tkrDecompress::layers, QSEC_calDecompress::logs, QSEC_gemDecompress::low, QSEC_calDecompress::means, QSEC_acdDecompress::phas, QSEC_acdDecompress::pvahs, QSEC_CURRENT_VERSION, QSEC_calDecompress::ranges, QSEC_gemDecompress::rbn, QSEC_tkrDecompress::requests, QSEC_gemDecompress::roi, QSEC_tkrDecompress::strips, QSEC_expansion_::tkr, QSEC_gemDecompress::tkr, QSEC_tkrDecompress::tots, QSEC_tkrDecompress::towers, QSEC_calDecompress::towers, QSEC_expansion_::ver, QSEC_gemDecompress::xy0, QSEC_gemDecompress::xy1, QSEC_gemDecompress::xzm, QSEC_gemDecompress::xzp, QSEC_gemDecompress::yzm, and QSEC_gemDecompress::yzp.

Referenced by QSEC_construct().

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

References QSEC_expansion_::mode, QSEC_CURRENT_VERSION, QSEC_VERS_ALL_RAW, recoverUserAcd(), recoverUserCal(), recoverUserTkr(), and QSEC_expansion_::ver.

Referenced by QSEC_updateAtContribution().

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

References QSEC_calDecompress::accepts, QSEC_expansion_::acd, QSEC_acdDecompress::cables, QSEC_expansion_::cal, QSEC_acdDecompress::chns, QSEC_gemDecompress::cno, QSEC_calDecompress::columns, QSEC_gemDecompress::cond, QSEC_tkrDecompress::diags, QSEC_calDecompress::diags, QSEC_expansion_::gem, QSEC_gemDecompress::high, QSEC_calDecompress::layCnts, QSEC_tkrDecompress::layers, QSEC_calDecompress::logs, QSEC_gemDecompress::low, QSEC_calDecompress::means, QSEC_acdDecompress::phas, QSEC_acdDecompress::pvahs, QSEC_reportDecompression(), QSEC_calDecompress::ranges, QSEC_gemDecompress::rbn, QSEC_tkrDecompress::requests, QSEC_gemDecompress::roi, QSEC_tkrDecompress::strips, QSEC_expansion_::tkr, QSEC_gemDecompress::tkr, QSEC_tkrDecompress::tots, QSEC_tkrDecompress::towers, QSEC_calDecompress::towers, QSEC_gemDecompress::xy0, QSEC_gemDecompress::xy1, QSEC_gemDecompress::xzm, QSEC_gemDecompress::xzp, QSEC_gemDecompress::yzm, and QSEC_gemDecompress::yzp.

Referenced by QSEC_reportExpand().

void QSEC_reportExpCtx	(	QSEC_expansion *	exp,
		FILE *	fp
	)

Report the contents of the expansion context.

Parameters:

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

References QSEC_CURRENT_VERSION, QSEC_VERS_ALL_RAW, QSEC_VERS_FIXED_CAL, QSEC_VERS_NEW_SCHEME, QSEC_VERS_NEWER, QSEC_VERS_ORIGINAL, and QSEC_expansion_::ver.

Referenced by QSEC_reportExp().

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

References QSEC_expansion_::mode.

Referenced by QSEC_updateAtContribution().

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

References QSEC_sizeofDecompression().

Referenced by QSEC_sizeof().