GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > ASC / V0-0-6

Constituent: ascOes     Tag: mcp750

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » TSS » source » ASC » V0-0-6 » ASC

ASC.h File Reference

ACD Software Rate Counters, interface file. More...

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


Data Structures

struct  _ASC_cno
 Accumulates the counts for the CNO vector. More...
struct  _ASC_patterns
 Accumulates the pattern counts for one ACD FREE board channel. More...
struct  _ASC_list
 The ACD vector counts for each of the 32 ACD readout channels is in a list. More...
struct  _ASC_cnts
 Statistics for each of the 4 lists. More...
struct  _ASC_counters
 All ACD counts. More...

Typedefs

typedef _ASC_cno ASC_cno
 Typedef for the struct _ASC_cno.
typedef _ASC_patterns ASC_patterns
 Typedef for the struct _ASC_patterns.
typedef _ASC_list ASC_list
 Typedef for struct ASC_list.
typedef _ASC_cnts ASC_cnts
 Typedef for struct _ASC_cnts.
typedef enum _ASC_SUMMARY ASC_SUMMARY
 Typedef for enum _ASC_SUMMARY.
typedef _ASC_counters ASC_counters
 Typedef for struct ASC_counters.

Enumerations

enum  _ASC_SUMMARY {
  ASC_SUMMARY_AEM_OKAY_GEM_OKAY = 0,
  ASC_SUMMARY_AEM_OKAY_GEM_ERR = 1,
  ASC_SUMMARY_AEM_OKAY_GEM_MISS = 2,
  ASC_SUMMARY_AEM_ERR__GEM_OKAY = 3,
  ASC_SUMMARY_AEM_ERR__GEM_ERR = 4,
  ASC_SUMMARY_AEM_ERR__GEM_MISS = 5,
  ASC_SUMMARY_AEM_MISS_GEM_OKAY = 6,
  ASC_SUMMARY_AEM_MISS_GEM_ERR = 7,
  ASC_SUMMARY_AEM_MISS_GEM_MISS = 8,
  ASC_SUMMARY_RSVD_9 = 9,
  ASC_SUMMARY_RSVD_10 = 10,
  ASC_SUMMARY_RSVD_11 = 11,
  ASC_SUMMARY_RSVD_12 = 12,
  ASC_SUMMARY_RSVD_13 = 13,
  ASC_SUMMARY_RSVD_14 = 14,
  ASC_SUMMARY_RSVD_15 = 15
}
 Enumerates the entries in the summary statistics block. More...

Functions

void ASC_clear (ASC_counters *counters)
 Clears the specified statistics counters.
int ASC_accumulate (ASC_counters *counters, const unsigned int *edata, int esize)
 Accumulate the counters for the specified event.

Detailed Description

ACD Software Rate Counters, interface file.

Author:
JJRussell - russell@slac.stanford.edu
    CVS $Id: ASC.h,v 1.1.1.1 2005/12/01 21:55:31 ebacho Exp $

SYNOPSIS
Defines the the interface for controlling the ACD software rate counters

Typedef Documentation

ASC_counters
 

Typedef for struct ASC_counters.

Note:
See the documentation of the enum _ASC_SUMMARY for an explanation of the summary statistics block.

ASC_list
 

Typedef for struct ASC_list.

The trick here is in defining what is meant by each possible readout channel. This problem stems from the fact that there are a variety of representations of the ACD data.

  1. At the detector level there are 97 tiles and ribbons, with 2 ends each.
  2. At the FREE board electronics level there are 12 FREE boards each with 18 channels.
  3. At the GEM level, there are 4 x 32 bits words with each bit representing 2 channels. The decision here is to go wih the most inclusive definition and then provide mapping functions to recast the data into the other to forms.

The most inclusive is the GEM level, representing a total of 256 channels vs 216 FREE board channels vs 194 detector channels.

ASC_patterns
 

Typedef for the struct _ASC_patterns.

Associated with either ACD tile or ribbon are 5 discriminator bits.

  1. PHA Accept Discriminator side A
  2. PHA Accept Discriminator side B
  3. Hit or LO Discriminator, side A
  4. Hit or LO Discriminator, side B
  5. Veto Discriminator, from the GEM

These bits can be arranged to form a 5 bit number.

     +----+----+----+----+----+
     |  V | Hb | Ha | Pb | Pa |
     +----+----+----+----+----+

For each ACD tile, this is a number from 0-31, inclusive. This structure contains the 32 bit accumulations for this vector.

ASC_SUMMARY
 

Typedef for enum _ASC_SUMMARY.

Summary Statistics Block
The summary statistics block consists of 16 32-bit entries to accumulate statistics. Only the first 9 are currently defined. These 9 entries map out a 3 x 3 grid. The 2 axis stand for the condition of the AEM and GEM contribution. A contribution can exist in one of 3 states
  • Present and okay
  • Present and in error, i.e. contribution found, but data in correct
  • Missing, i.e. contribution not found.

Each event will increment only one of these entries. The total number of events seen is thus the sum of all 9 entries. The counters will be accumulated only for events with a block present and not in error. Note that events with only a GEM contributor or only an AEM contributor will be accumulated into the statistics counters iff the contributor's is not in error. Naturally one expects most entries to be in the both present and okay category.
Note:
Currently there is no way a GEM contribution can be present but in error. Consequently these entries should be 0. The locations will be maintained if one discovers that such a category is possible.

Enumeration Type Documentation

enum _ASC_SUMMARY
 

Enumerates the entries in the summary statistics block.

Enumerator:
ASC_SUMMARY_AEM_OKAY_GEM_OKAY  Both present and okay
ASC_SUMMARY_AEM_OKAY_GEM_ERR  Both present, GEM in error
ASC_SUMMARY_AEM_OKAY_GEM_MISS  Only AEM present
ASC_SUMMARY_AEM_ERR__GEM_OKAY  Both present, AEM in error
ASC_SUMMARY_AEM_ERR__GEM_ERR  Both present and in error
ASC_SUMMARY_AEM_ERR__GEM_MISS  Only AEM present, but in error
ASC_SUMMARY_AEM_MISS_GEM_OKAY  Only GEM present
ASC_SUMMARY_AEM_MISS_GEM_ERR  Only GEM present, but in error
ASC_SUMMARY_AEM_MISS_GEM_MISS  Both missing
ASC_SUMMARY_RSVD_9  Reserved for future use
ASC_SUMMARY_RSVD_10  Reserved for future use
ASC_SUMMARY_RSVD_11  Reserved for future use
ASC_SUMMARY_RSVD_12  Reserved for future use
ASC_SUMMARY_RSVD_13  Reserved for future use
ASC_SUMMARY_RSVD_14  Reserved for future use
ASC_SUMMARY_RSVD_15  Reserved for future use

Function Documentation

int ASC_accumulate (  ASC_counters *  counters,
const unsigned int *  edata,
int  esize
) 
 

Accumulate the counters for the specified event.

Returns:
Status indicating the event was successfully processed (0) or a non-zero number indicating the event was not successfully processed.
Parameters:
counters Pointer to the counters to increment
edata Pointer to the event data
esize The event size, in units of bytes. This is used as a consistency check in the unpacking.

void ASC_clear (  ASC_counters *  counters  ) 
 

Clears the specified statistics counters.

Parameters:
counters The statistics counters to be cleared
Warning:
Currently this is a NON-interlocked operation.

Generated on Fri Dec 9 22:34:10 2005 by  doxygen 1.4.4