GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LSE / V1-3-5

Constituent: lsew     Tag: sun-gcc


Interface   Data Structures   File List   Data Fields   Globals  

CDF_gem.h File Reference

Public interface to produce Compressed Data Format for the GEM contributor. More...

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


Functions

int CDF_gemCfg_sizeof (int level)
 Returns the size, in bytes of the GEM compression configuration needed to support the specified level.
int CDF_gemCfg_construct (CDF_gemCfg *cfg, int level, void **mem)
 Constructs the CDF_gemCfg compression configuration.
void CDF_gemCfg_set_min_deadtime (CDF_gemCfg *cfg, int min_deadtime)
 Sets the minimum deadtime.
int CDF_gem_sizeof (int level, const CDF_gemCfg *cfg)
 Returns the size, in bytes of the GEM compression structure needed to support the specified level.
int CDF_gem_construct (CDF_gem *cdf, int level, const CDF_gemCfg *cfg, const LSEW_dgmFw *dgmFw, void **mem)
 Constructs the CDF_gem compression context.
void CDF_gem_begin (CDF_gem *cdf, CDF_gemBdy *bdy)
 Fills int the GEM portion of the datagram contribution used in when decoding an GEM event.
void CDF_gem_update (CDF_gem *cdf, const EBF_gem *gem, unsigned int seq)
 Updates any running context.
unsigned int CDF_gem_std_compress (CDF_gem *cdf, unsigned int *buf, unsigned int pos, const EBF_gem *gem, unsigned int seq)
 Compresses the GEM for standard zero suppressed data.
unsigned int CDF_gem_ped_compress (CDF_gem *cdf, unsigned int *buf, unsigned int pos, const EBF_gem *gem, unsigned int seq)
 Compresses the GEM data when zero suppression has been disabled.

Detailed Description

Public interface to produce Compressed Data Format for the GEM contributor.

Author:
JJRussell - russell@slac.stanford.edu
    CVS $Id: CDF_gem.h,v 1.3 2007/02/14 04:10:50 russell Exp $


Function Documentation

void CDF_gem_begin CDF_gem cdf,
CDF_gemBdy bdy
 

Fills int the GEM portion of the datagram contribution used in when decoding an GEM event.

Parameters:
cdf The CDF_gem compress context structure
bdy The CDF_gemBdy structure to fill

int CDF_gem_construct CDF_gem cdf,
int  level,
const CDF_gemCfg cfg,
const LSEW_dgmFw dgmFw,
void **  mem
 

Constructs the CDF_gem compression context.

Return values:
Status 
Parameters:
cdf The CDF_gem compression context structure to fill
level The maximum compression level that needs to be supported
cfg Target specific configuration parameter
dgmFw The datagram framework handle
mem Pointer to free memory pointer, return as the the updated pointer. If cdf is equal to the current contents of mem, then mem will be advanced by the size of CDF_gem, else this routine will believe that the only the variable allocation of cdf needs to be allocated.

unsigned int CDF_gem_ped_compress CDF_gem cdf,
unsigned int *  buf,
unsigned int  pos,
const EBF_gem *  gem,
unsigned int  seq
 

Compresses the GEM data when zero suppression has been disabled.

Returns:
The updated bit write position
Parameters:
cdf The GEM compressed data format context
buf The output buffer
pos The current bit offset into the output buffer buf
gem The GEM contribution
seq The event sequence number

int CDF_gem_sizeof int  level,
const CDF_gemCfg cfg
 

Returns the size, in bytes of the GEM compression structure needed to support the specified level.

Parameters:
level The maximum compression level to support
cfg Target specific configuration

unsigned int CDF_gem_std_compress CDF_gem cdf,
unsigned int *  buf,
unsigned int  pos,
const EBF_gem *  gem,
unsigned int  seq
 

Compresses the GEM for standard zero suppressed data.

Returns:
The next bit position to write to
Parameters:
cdf The GEM's Compressed Data Format context
buf The output buffer
pos The current bit offset into the output buffer buf
gem The GEM contribution
seq The event sequence number

void CDF_gem_update CDF_gem cdf,
const EBF_gem *  gem,
unsigned int  seq
 

Updates any running context.

Parameters:
cdf The GEM's Compressed Data Format context
gem The GEM contribution
seq The event sequence number

int CDF_gemCfg_construct CDF_gemCfg cfg,
int  level,
void **  mem
 

Constructs the CDF_gemCfg compression configuration.

Return values:
Status 
Parameters:
cfg Target specific configuration
level The maximum compression level that needs to be supported
mem Pointer to free memory pointer, return as the the updated pointer. If cfg is equal to the current contents of mem, then mem will be advanced by the size of CDF_gemCfg, else this routine will believe that the only the variable allocation of cdf needs to be allocated.

void CDF_gemCfg_set_min_deadtime CDF_gemCfg cfg,
int  min_deadtime
 

Sets the minimum deadtime.

Parameters:
cfg The GEM configuration parameter block
min_deadtime The minimum deadtime. For data taken off the instrument, this will be 529. Typical value for GLEAM Monte Carlo is 400

int CDF_gemCfg_sizeof int  level  ) 
 

Returns the size, in bytes of the GEM compression configuration needed to support the specified level.

Parameters:
level The maximum compression level to support


Generated on Fri Feb 1 02:08:16 2008 by  doxygen 1.4.4