EDR_calUnpack.h File Reference

Defines the interface to the CAL LAT unpacking routine. More...

Functions
int	EDR_calUnpack (EDR_cal *clr, const EBF_dir *dir, const ECR_cal *constants)
	Unpacks the CAL data for the whole LAT.
int	EDR_calMapUnpack (EDR_cal *clr, const EBF_dir *dir)
	Unpacks the CAL data for the whole LAT.
int	EDR_calUnpackInit (EDR_cal *clr)
	One-time initialization an EDR_cal structure.
void	EDR_calUnpackReset (EDR_cal *clr)
	Resets the EDR_cal structure, preparing it for a new event.
int	EDR_calUnpackSizeof (void)
	Returns the size, in bytes, of a CAL LAT record.

---

Detailed Description

Defines the interface to the CAL LAT unpacking routine.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: EDR_calUnpack.h,v 1.4 2005/10/13 22:00:54 russell Exp $

---

Function Documentation

int EDR_calMapUnpack	(	EDR_cal *	clr,
		const EBF_dir *	dir
	)

Unpacks the CAL data for the whole LAT.

Parameters:

	clr	The CAL LAT Record data structure to fill
	dir	The directory structure for this event; used to locate the CAL data.

The Cal LAT Record contains the control structure to describe a fully unpacked and but non-calibrated CAL data for the entire LAT tower.

References _EBF_dir::ctbs, _EBF_dirRedux::ctids, EBF_CID_K_TEM, EBF_DIR_TEMS_CAL, EDR_CAL_MAP_IS_VALID, EDR_CAL_VALID_M_MAP, _EBF_dirCtbDsc::logcnt, _EDR_cal::logCnt, mapTower(), mapTower4(), _EBF_dir::redux, _EBF_dirRedux::rng_ids, _EDR_cal::twrMap, _EDR_cal::twrs, and _EDR_cal::valid.

int * EDR_calUnpack	(	EDR_cal *	clr,
		const EBF_dir *	dir,
		const ECR_cal *	constants
	)

Unpacks the CAL data for the whole LAT.

Parameters:

	clr	The CAL LAT Record data structure to fill
	dir	The directory structure for this event; used to locate the CAL data.
	constants	The CAL calibration constants (gains/pedestals) for this tower

Returns:

The number of logs

The Cal LAT Record contains the control structure to describe a fully unpacked and calibrated CAL data for the entire LAT tower.

References _EBF_dir::ctbs, _EBF_dirRedux::ctids, EBF_CID_K_TEM, EBF_DIR_TEMS_CAL, EDR_CAL_MAP_ENERGY_ARE_VALID, EDR_CAL_VALID_M_ENERGY, EDR_CAL_VALID_M_MAP, _EDR_cal::energy, _EDR_cal::layerEnergies, _EDR_cal::logCnt, _EDR_cal::logEnds, _EBF_dir::redux, _EBF_dirRedux::rng_ids, _EDR_cal::twrMap, _ECR_cal::twrs, _EDR_cal::twrs, unpackTower(), unpackTower4(), and _EDR_cal::valid.

int EDR_calUnpackInit

(

EDR_cal *

cal

)

One-time initialization an EDR_cal structure.

Returns:

0, always

Parameters:

cal

The EDR_cal structure to initialize

References _EDR_cal::valid.

Referenced by initIxbObjTbl().

void EDR_calUnpackReset

(

EDR_cal *

cal

)

Resets the EDR_cal structure, preparing it for a new event.

Parameters:

cal

The EDR_cal structure to reset

References _EDR_cal::valid.

Referenced by initIxbObjTbl().

int EDR_calUnpackSizeof

(

void

)

Returns the size, in bytes, of a CAL LAT record.

Returns:

The size, in bytes, of a CAL LAT record.

This function should be called to determine the size of an EDR_cal structure. This allows the calling program to avoid including the structure definition an EDR_cal.

After allocating an EDR_tkr structure, the structure should be initialized using EDR_calUnpackInit().