QASC_sample.h File Reference

Layout of an ACD Software Counter sample. More...

#include <QSSP/QSSP_span.h>

Classes
union	_QASC_summaryTableV0
	Summary statistics as a table of named entries. More...
union	_QASC_summaryV0
	Summary statistics. More...
struct	_QASC_cnoHistogramV0
	Accumulates the counts for one CNO pair (A/B) ends. More...
struct	_QASC_cnoV0
	Accumulates the counts for the CNO vector. More...
struct	_QASC_tileHistogramV0
	Accumulates the histogram for an ACD tile/ribbon. More...
struct	_QASC_monitorV0
	QASC monitoring statistics. More...
struct	_QASC_statisticsV0
	The ACD Software Counter statistics data. More...
struct	_QASC_sampleV0
	Structure of the ASC data that is used when presenting a public interface. More...
union	_QASC_sample
	Union of all the versions of an ACD software counter sample. More...
Typedefs
typedef enum _QASC_SUMMARYV0	QASC_SUMMARYV0
	Typedef for enum _QASC_SUMMARYV0.
typedef struct _QASC_summaryTableV0	QASC_summaryTableV0
	Typedef for union QASC_summaryTableV0.
typedef union _QASC_summaryV0	QASC_summaryV0
	Typedef for union QASC_summaryV0.
typedef enum _QASC_CNOBINV0_M	QASC_CNOBINV0_M
	Typedef for enum _QASC_CNOBINV0_M.
typedef struct _QASC_cnoHistogramV0	QASC_cnoHistogramV0
	Typedef for the struct _QASC_cnoHistogramV0.
typedef struct _QASC_cnoV0	QASC_cnoV0
	Typedef for the struct _QASC_cnoV0.
typedef enum _QASC_TILEBINV0_M	QASC_TILEBINV0_M
	Typedef for enum _QASC_TILEBINV0_M.
typedef struct _QASC_tileHistogramV0	QASC_tileHistogramV0
	Typedef for the struct _QASC_tileHistogramV0.
typedef struct _QASC_monitorV0	QASC_monitorV0
	Typedef for struct _QASC_monitorV0.
typedef struct _QASC_statisticsV0	QASC_statisticsV0
	Typedef for struct _QASC_statistics.
typedef enum _QASC_typeV0	QASC_typeV0
	Typedef for enum _QSTD_type.
typedef struct _QASC_sampleV0	QASC_sampleV0
	Typedef for struct _QASC_sampleV0.
typedef union _QASC_sample	QASC_sample
	Typedef for union _QASC_sample.
Enumerations
enum	_QASC_SUMMARYV0 {   QASC_SUMMARYV0_AEM_OKAY_GEM_OKAY = 0,   QASC_SUMMARYV0_AEM_OKAY_GEM_ERR = 1,   QASC_SUMMARYV0_AEM_OKAY_GEM_MISS = 2,   QASC_SUMMARYV0_AEM_ERR__GEM_OKAY = 3,   QASC_SUMMARYV0_AEM_ERR__GEM_ERR = 4,   QASC_SUMMARYV0_AEM_ERR__GEM_MISS = 5,   QASC_SUMMARYV0_AEM_MISS_GEM_OKAY = 6,   QASC_SUMMARYV0_AEM_MISS_GEM_ERR = 7,   QASC_SUMMARYV0_AEM_MISS_GEM_MISS = 8,   QASC_SUMMARYV0_RSVD_9 = 9,   QASC_SUMMARYV0_RSVD_10 = 10,   QASC_SUMMARYV0_RSVD_11 = 11,   QASC_SUMMARYV0_RSVD_12 = 12,   QASC_SUMMARYV0_RSVD_13 = 13,   QASC_SUMMARYV0_RSVD_14 = 14,   QASC_SUMMARYV0_RSVD_15 = 15 }
	Enumerates the entries in the summary statistics block. More...
enum	_QASC_CNOBINV0_M {   QASC_CNOBINV0_M_A = 1 << 0,   QASC_CNOBINV0_M_B = 1 << 1 }
	Enumerates the bits of the word that forms the CNO histogram index. More...
enum	_QASC_TILEBINV0_M {   QASC_TILEBINV0_M_PA = 1 << 0,   QASC_TILEBINV0_M_PB = 1 << 1,   QASC_TILEBINV0_M_HA = 1 << 2,   QASC_TILEBINV0_M_HB = 1 << 3,   QASC_TILEBINV0_M_V = 1 << 4 }
	Enumerates the bits of the word that forms the tile histogram index. More...
enum	_QASC_typeV0 {   QASC_TYPEV0_K_GLOBAL_BEG = 0,   QASC_TYPEV0_K_NORMAL = 1,   QASC_TYPEV0_K_GLOBAL_END = 2 }
	The statistics sample typeV0. More...

---

Detailed Description

Layout of an ACD Software Counter sample.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: QASC_sample.h,v 1.2 2011/03/29 00:14:57 russell Exp $

---

Typedef Documentation

QASC_sampleV0

Typedef for struct _QASC_sampleV0.

This data structure is kept in the private area of the QEMP package. Access to it is controlled by a public interface which keeps the details of this structure hidden. There is no need to check that this structure matches that in EMP, since the code fills these in by hand.

QASC_summaryTableV0

Typedef for union QASC_summaryTableV0.

This presents the summary table as a structure of named entries. One can also address this structure as a flat array using the QASC_SUMMARY enumeration as the index. When address specific members, this notation is likely more compact.

QASC_summaryV0

Typedef for union QASC_summaryV0.

This is a union of two different methods of addressing the summary statistics, either by a flat array of 16 entries, or by a structure with the entry names as the structure fields.

Array Index Addressing

See the documentation of the enum _QASC_SUMMARY for an explanation of the summary statistics entries when addressing by array index

QASC_SUMMARYV0

Typedef for enum _QASC_SUMMARYV0.

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.

QASC_tileHistogramV0

Typedef for the struct _QASC_tileHistogramV0.

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.

---

Enumeration Type Documentation

enum _QASC_CNOBINV0_M

Enumerates the bits of the word that forms the CNO histogram index.

Enumerator:

QASC_CNOBINV0_M_A	The CNO on the A-side board bit
QASC_CNOBINV0_M_B	The CNO on the B-side board bit

enum _QASC_SUMMARYV0

Enumerates the entries in the summary statistics block.

Enumerator:

QASC_SUMMARYV0_AEM_OKAY_GEM_OKAY	Both present and okay
QASC_SUMMARYV0_AEM_OKAY_GEM_ERR	Both present, GEM in error
QASC_SUMMARYV0_AEM_OKAY_GEM_MISS	Only AEM present
QASC_SUMMARYV0_AEM_ERR__GEM_OKAY	Both present, AEM in error
QASC_SUMMARYV0_AEM_ERR__GEM_ERR	Both present and in error
QASC_SUMMARYV0_AEM_ERR__GEM_MISS	Only AEM present, but in error
QASC_SUMMARYV0_AEM_MISS_GEM_OKAY	Only GEM present
QASC_SUMMARYV0_AEM_MISS_GEM_ERR	Only GEM present, but in error
QASC_SUMMARYV0_AEM_MISS_GEM_MISS	Both missing
QASC_SUMMARYV0_RSVD_9	Reserved for future use
QASC_SUMMARYV0_RSVD_10	Reserved for future use
QASC_SUMMARYV0_RSVD_11	Reserved for future use
QASC_SUMMARYV0_RSVD_12	Reserved for future use
QASC_SUMMARYV0_RSVD_13	Reserved for future use
QASC_SUMMARYV0_RSVD_14	Reserved for future use
QASC_SUMMARYV0_RSVD_15	Reserved for future use

enum _QASC_TILEBINV0_M

Enumerates the bits of the word that forms the tile histogram index.

Enumerator:

QASC_TILEBINV0_M_PA	The PHA A-side accept bit
QASC_TILEBINV0_M_PB	The PHA B-side accept bit
QASC_TILEBINV0_M_HA	The HIT A-side accept bit
QASC_TILEBINV0_M_HB	The HIT B-side accept bit
QASC_TILEBINV0_M_V	The GEM veto bit

enum _QASC_typeV0

The statistics sample typeV0.

Enumerator:

QASC_TYPEV0_K_GLOBAL_BEG	Beginning global record
QASC_TYPEV0_K_NORMAL	Normal update record
QASC_TYPEV0_K_GLOBAL_END	Ending global record