QDF_cal.h File Reference

Interface to the CAL decoding routines. More...

#include "LDT/BFU.h"

Include dependency graph for QDF_cal.h:

This graph shows which files directly or indirectly include this file:


Typedefs
typedef _QDF_calEvt	QDF_calEvt
typedef _QDF_calCtx	QDF_calCtx
typedef _QDF_calEvtCopyDir	QDF_calEvtCopyDir
typedef _QDF_esbEvt	QDF_esbEvt
typedef _QDF_gemEvt	QDF_gemEvt
typedef _QFR_fileCtx	QFR_fileCtx
typedef _QSE_ctx	QSE_ctx
typedef _QDF_exc	QDF_exc
typedef _CDF_calBdy	CDF_calBdy
Functions
int	QDF_calCtxSizeof (unsigned int level, void *prm)
	Returns the size, in bytes of the CAL decoding context needed to support the specified compression level.
QDF_calCtx *	QDF_calCtxConstruct (QDF_calCtx ctx, unsigned int level, void prm, const QSE_ctx *qse)
	Constructs (initializes) the specified CAL decoding context structure.
int	QDF_calCtxUpdate (QDF_calCtx cal, QFR_fileCtx qfr, const CDF_calBdy *bdy)
	Updates the CAL context from the datagram contribution.
int	QDF_calEvtSizeof (unsigned int level, void *prm)
	Returns the size, in bytes of QDF_cal event needed to support the specified compression level.
QDF_calEvt *	QDF_calEvtConstruct (QDF_calEvt evt, unsigned int level, void prm, QDF_exc exc, QDF_esbEvt esb, QDF_gemEvt *gem)
	Constructs (initializes) the specified CAL event structure.
BFU	QDF_calEvtCopyDirForm (QDF_calEvtCopyDir dir, unsigned int map, unsigned int four_range, const unsigned int src, int max, BFU bfu)
	Forms the directory of copy descriptors for CAL data that was just copied into the output stream.
BFU	QDF_calStd1Decode (QDF_calCtx ctx, QDF_calEvt evt, const unsigned int *src, unsigned int max, BFU bfu)
	Decodes the CAL.
BFU	QDF_calStd4Decode (QDF_calCtx ctx, QDF_calEvt evt, const unsigned int *src, unsigned int max, BFU bfu)
	Decodes the CAL.
BFU	QDF_calPed1Decode (QDF_calCtx ctx, QDF_calEvt evt, const unsigned int *src, unsigned int max, BFU bfu)
	Decodes the CAL when the data was acquired with zero-suppression disabled and single range readout.
BFU	QDF_calPed4Decode (QDF_calCtx ctx, QDF_calEvt evt, const unsigned int *src, unsigned int max, BFU bfu)
	Decodes the CAL when the data was acquired with zero-suppression disabled and four range readout.

Detailed Description

Interface to the CAL decoding routines.

Author:: JJRussell - russell@slac.stanford.edu

   CVS $Id: QDF_cal.h,v 1.2 2006/12/07 00:24:36 russell Exp $

Function Documentation

QDF_calCtx * QDF_calCtxConstruct ( QDF_calCtx * ctx,

unsigned int level,

void * prm,

const QSE_ctx * qse

)

Constructs (initializes) the specified CAL decoding context structure.

Returns:
Pointer to the context structure to construct

Parameters:

ctx The context structure to construct.

level The maximum level of compression that will be supported.

prm Additional configuation parameter, unused as of now

qse Pointer to the public/generic QSE context parameter

int QDF_calCtxSizeof ( unsigned int level,

void * prm

)

Returns the size, in bytes of the CAL decoding context needed to support the specified compression level.

Returns:
The size, in bytes, of the CAL decoding context

Parameters:

level The maximum level of compression that needs to be supported

prm Additional configuation parameter, unused as of now

int QDF_calCtxUpdate ( QDF_calCtx * ctx,

QFR_fileCtx * qfr,

const CDF_calBdy * bdy

)

Updates the CAL context from the datagram contribution.

Return values:

0,Success

0x80000010,Pedestal file error, file not found

0x80000020,Pedestal file error, checksum mismatch

0x80000040,Gain file error, file not found

0x80000080,Gain file error, checksum mismatch

Parameters:

ctx The context to update

qfr The file translation context

bdy The update information

QDF_esbCtx * QDF_calEvtConstruct ( QDF_calEvt * evt,

unsigned int level,

void * prm,

QDF_exc * exc,

QDF_esbEvt * esb,

QDF_gemEvt * gem

)

Constructs (initializes) the specified CAL event structure.

Returns:
Pointer to the context structure to construct

Parameters:

evt The CAL event structure to construct.

level The maximum level of compression that will be supported.

prm Additional configuation parameter, unused as of now

exc Pointer to the global exception handling context

esb Pointer to the Event Summary Data for this event

gem Pointer to the GEM data for this event

BFU QDF_calEvtCopyDirForm ( QDF_calEvtCopyDir * dir,

unsigned int map,

unsigned int four_range,

const unsigned int * src,

int max,

BFU bfu

)

Forms the directory of copy descriptors for CAL data that was just copied into the output stream.

Returns:
The updated bit position and current deblocked 32-bit buffer

Parameters:

dir The copy directory to fill out

map Left-justified, big-endian map of the active towers

four_range 0, 0 if single range, 1 if four-range

src The data source, i.e. the bit stream

max The maximum bit position

bfu The current bit position and temporary buffer

int QDF_calEvtSizeof ( unsigned int level,

void * prm

)

Returns the size, in bytes of QDF_cal event needed to support the specified compression level.

Returns:
The size, in bytes, of the CAL event

Parameters:

level The maximum level of compression that needs to be supported

prm Additional configuation parameter, unused as of now

BFU QDF_calPed1Decode ( QDF_calCtx * ctx,

QDF_calEvt * evt,

const unsigned int * src,

const unsigned int max,

BFU bfu

)

Decodes the CAL when the data was acquired with zero-suppression disabled and single range readout.

Returns:
The updated bit position and current deblocked 32-bit buffer

Parameters:

ctx The compressed data decoding context

evt The CAL event block to fill in

src The data source, i.e. the bit stream

max The maximum bit position

bfu The current bit position and temporary buffer

This routine is a simple dispatcher, extracting the formatting style, then dispatching to the appropriate decoding routine.

BFU QDF_calPed4Decode ( QDF_calCtx * ctx,

QDF_calEvt * evt,

const unsigned int * src,

const unsigned int max,

BFU bfu

)

Decodes the CAL when the data was acquired with zero-suppression disabled and four range readout.

Returns:
The updated bit position and current deblocked 32-bit buffer

Parameters:

ctx The compressed data decoding context

evt The CAL event block to fill in

src The data source, i.e. the bit stream

max The maximum bit position

bfu The current bit position and temporary buffer

This routine is a simple dispatcher, extracting the formatting style, then dispatching to the appropriate decoding routine.

BFU QDF_calStd1Decode ( QDF_calCtx * ctx,

QDF_calEvt * evt,

const unsigned int * src,

unsigned int max,

BFU bfu

)

Decodes the CAL.

Returns:
The updated bit position and current deblocked 32-bit buffer

Parameters:

ctx The CAL compressed data decoding context

evt The CAL event data to fill in

src The data source, i.e. the bit stream

max The maximum bit position

bfu The current bit position and temporary buffer

BFU QDF_calStd4Decode ( QDF_calCtx * ctx,

QDF_calEvt * evt,

const unsigned int * src,

unsigned int max,

BFU bfu

)

Decodes the CAL.

Returns:
The updated bit position and current deblocked 32-bit buffer

Parameters:

ctx The CAL compressed data decoding context

evt The CAL event data to fill in

src The data source, i.e. the bit stream

max The maximum bit position

bfu The current bit position and temporary buffer

Generated on Wed Jun 25 01:17:33 2008 by

1.4.4

QDF_cal.h File Reference

Typedefs

Functions

Detailed Description

Function Documentation