GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> QSP / dev > qrsd_check / linux-gcc

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » QSD » source » QSP » dev » QSP

QGFC_rsd_v2.h File Reference

Defines the gamma filter result summary data, version 2. More...

#include <PBI/Endianness.h>

Classes

struct  _QGFC_RSD_V2_stageEnergy_bf
 Maps out the stage energy as bit fields. More...
union  _QGFC_RSD_V2_stageEnergy
 The stage/energy result word as a union of a 32-bit word with its bit field representation. More...

Typedefs

typedef enum _QGFC_RSD_V2_STAGE_S QGFC_RSD_V2_STAGE_S
 Typedef for enum _QGFC_RSD_V2_STAGE_S.
typedef enum _QGFC_RSD_V2_STAGE_V QGFC_RSD_V2_STAGE_V
 Typedef for enum _QGFC_RSD_V2_STAGE_V.
typedef enum _QGFC_RSD_V2_STAGE_M QGFC_RSD_V2_STAGE_M
 Typedef for enum _QGFC_RSD_V2_STAGE_M.
typedef enum _QGFC_RSD_V2_STATUS_V QGFC_RSD_V2_STATUS_V
 Typedef for enum _QGFC_RSD_V2_STATUS_V.
typedef enum _QGFC_RSD_V2_STATUS_M QGFC_RSD_V2_STATUS_M
 Typedef for enum _QGFC_RSD_V2_STATUS_M.
typedef struct
_QGFC_RSD_V2_stageEnergy_bf 		QGFC_RSD_V2_stageEnergy_bf
typedef union
_QGFC_RSD_V2_stageEnergy 		QGFC_RSD_V2_stageEnergy
 Typedef for struct _QGFC_RSD_V2_stageEnergy_bf.

Enumerations

enum  _QGFC_RSD_V2_STAGE_S {
  QGFC_RSD_V2_STAGE_S_ENERGY = 24,
  QGFC_RSD_V2_STAGE_S_STAGE = 8
}
 Gamma filter analysis stage, bit definitions, size. More...
enum  _QGFC_RSD_V2_STAGE_V {
  QGFC_RSD_V2_STAGE_V_ENERGY = 0,
  QGFC_RSD_V2_STAGE_V_STAGE = 24,
  QGFC_RSD_V2_STAGE_V_ACD = 24,
  QGFC_RSD_V2_STAGE_V_DIR = 25,
  QGFC_RSD_V2_STAGE_V_ATF = 26,
  QGFC_RSD_V2_STAGE_V_CAL1 = 27,
  QGFC_RSD_V2_STAGE_V_TKR = 28,
  QGFC_RSD_V2_STAGE_V_RSVD_5 = 29,
  QGFC_RSD_V2_STAGE_V_RSVD_6 = 30,
  QGFC_RSD_V2_STAGE_V_MPKT = 31
}
 Gamma filter analysis stage, bit definitions. More...
enum  _QGFC_RSD_V2_STAGE_M {
  QGFC_RSD_V2_STAGE_M_ENERGY = 0x00ffffff,
  QGFC_RSD_V2_STAGE_M_ACD = (1 << QGFC_RSD_V2_STAGE_V_ACD),
  QGFC_RSD_V2_STAGE_M_DIR = (1 << QGFC_RSD_V2_STAGE_V_DIR),
  QGFC_RSD_V2_STAGE_M_ATF = (1 << QGFC_RSD_V2_STAGE_V_ATF),
  QGFC_RSD_V2_STAGE_M_CAL1 = (1 << QGFC_RSD_V2_STAGE_V_CAL1),
  QGFC_RSD_V2_STAGE_M_TKR = (1 << QGFC_RSD_V2_STAGE_V_TKR),
  QGFC_RSD_V2_STAGE_M_RSVD_5 = (1 << QGFC_RSD_V2_STAGE_V_RSVD_5),
  QGFC_RSD_V2_STAGE_M_RSVD_6 = (1 << QGFC_RSD_V2_STAGE_V_RSVD_6),
  QGFC_RSD_V2_STAGE_M_MPKT = (1 << QGFC_RSD_V2_STAGE_V_MPKT),
  QGFC_RSD_V2_STAGE_M_STAGE
}
 Filter stage, mask. More...
enum  _QGFC_RSD_V2_STATUS_V {
  QGFC_RSD_V2_STATUS_V_GEM_THROTTLE = 0,
  QGFC_RSD_V2_STATUS_V_GEM_TKR = 1,
  QGFC_RSD_V2_STATUS_V_GEM_CALLO = 2,
  QGFC_RSD_V2_STATUS_V_GEM_CALHI = 3,
  QGFC_RSD_V2_STATUS_V_GEM_CNO = 4,
  QGFC_RSD_V2_STATUS_V_ACD_TOP = 5,
  QGFC_RSD_V2_STATUS_V_ACD_SIDE = 6,
  QGFC_RSD_V2_STATUS_V_ACD_SIDE_FILTER = 7,
  QGFC_RSD_V2_STATUS_V_TKR_EQ_1 = 8,
  QGFC_RSD_V2_STATUS_V_TKR_GE_2 = 9,
  QGFC_RSD_V2_STATUS_V_RSVD_10 = 10,
  QGFC_RSD_V2_STATUS_V_RSVD_11 = 11,
  QGFC_RSD_V2_STATUS_V_ERR_CTB = 12,
  QGFC_RSD_V2_STATUS_V_TKR_LT_2_ELO = 13,
  QGFC_RSD_V2_STATUS_V_TKR_SKIRT = 14,
  QGFC_RSD_V2_STATUS_V_TKR_EQ_0 = 15,
  QGFC_RSD_V2_STATUS_V_TKR_ROW2 = 16,
  QGFC_RSD_V2_STATUS_V_TKR_ROW01 = 17,
  QGFC_RSD_V2_STATUS_V_TKR_TOP = 18,
  QGFC_RSD_V2_STATUS_V_ZBOTTOM = 19,
  QGFC_RSD_V2_STATUS_V_EL0_ETOT_HI = 20,
  QGFC_RSD_V2_STATUS_V_EL0_ETOT_LO = 21,
  QGFC_RSD_V2_STATUS_V_HI_ENERGY = 22,
  QGFC_RSD_V2_STATUS_V_LO_ENERGY = 23,
  QGFC_RSD_V2_STATUS_V_SIDE = 24,
  QGFC_RSD_V2_STATUS_V_TOP = 25,
  QGFC_RSD_V2_STATUS_V_SPLASH_1 = 26,
  QGFC_RSD_V2_STATUS_V_E350_FILTER_TILE = 27,
  QGFC_RSD_V2_STATUS_V_E0_TILE = 28,
  QGFC_RSD_V2_STATUS_V_SPLASH_0 = 29,
  QGFC_RSD_V2_STATUS_V_NOCALLO_FILTER_TILE = 30,
  QGFC_RSD_V2_STATUS_V_VETOED = 31
}
 Gamma filter status, bit definitions. More...
enum  _QGFC_RSD_V2_STATUS_M {
  QGFC_RSD_V2_STATUS_M_GEM_THROTTLE,
  QGFC_RSD_V2_STATUS_M_GEM_TKR = (1 << QGFC_RSD_V2_STATUS_V_GEM_TKR),
  QGFC_RSD_V2_STATUS_M_GEM_CALLO = (1 << QGFC_RSD_V2_STATUS_V_GEM_CALLO),
  QGFC_RSD_V2_STATUS_M_GEM_CALHI = (1 << QGFC_RSD_V2_STATUS_V_GEM_CALHI),
  QGFC_RSD_V2_STATUS_M_GEM_CNO = (1 << QGFC_RSD_V2_STATUS_V_GEM_CNO),
  QGFC_RSD_V2_STATUS_M_GEM,
  QGFC_RSD_V2_STATUS_M_ACD_TOP = (1 << QGFC_RSD_V2_STATUS_V_ACD_TOP),
  QGFC_RSD_V2_STATUS_M_ACD_SIDE = (1 << QGFC_RSD_V2_STATUS_V_ACD_SIDE),
  QGFC_RSD_V2_STATUS_M_ACD_SIDE_FILTER,
  QGFC_RSD_V2_STATUS_M_TKR_EQ_1 = (1 << QGFC_RSD_V2_STATUS_V_TKR_EQ_1),
  QGFC_RSD_V2_STATUS_M_TKR_GE_2 = (1 << QGFC_RSD_V2_STATUS_V_TKR_GE_2),
  QGFC_RSD_V2_STATUS_M_RSVD_10 = (1 << QGFC_RSD_V2_STATUS_V_RSVD_10),
  QGFC_RSD_V2_STATUS_M_RSVD_11 = (1 << QGFC_RSD_V2_STATUS_V_RSVD_11),
  QGFC_RSD_V2_STATUS_M_ERR_CTB = (1 << QGFC_RSD_V2_STATUS_V_ERR_CTB),
  QGFC_RSD_V2_STATUS_M_TKR_LT_2_ELO,
  QGFC_RSD_V2_STATUS_M_TKR_SKIRT = (1 << QGFC_RSD_V2_STATUS_V_TKR_SKIRT),
  QGFC_RSD_V2_STATUS_M_TKR_EQ_0 = (1 << QGFC_RSD_V2_STATUS_V_TKR_EQ_0),
  QGFC_RSD_V2_STATUS_M_TKR_ROW2 = (1 << QGFC_RSD_V2_STATUS_V_TKR_ROW2),
  QGFC_RSD_V2_STATUS_M_TKR_ROW01 = (1 << QGFC_RSD_V2_STATUS_V_TKR_ROW01),
  QGFC_RSD_V2_STATUS_M_TKR_TOP = (1 << QGFC_RSD_V2_STATUS_V_TKR_TOP),
  QGFC_RSD_V2_STATUS_M_ZBOTTOM = (1 << QGFC_RSD_V2_STATUS_V_ZBOTTOM),
  QGFC_RSD_V2_STATUS_M_EL0_ETOT_HI,
  QGFC_RSD_V2_STATUS_M_EL0_ETOT_LO,
  QGFC_RSD_V2_STATUS_M_HI_ENERGY = (1 << QGFC_RSD_V2_STATUS_V_HI_ENERGY),
  QGFC_RSD_V2_STATUS_M_LO_ENERGY = (1 << QGFC_RSD_V2_STATUS_V_LO_ENERGY),
  QGFC_RSD_V2_STATUS_M_SIDE = (1 << QGFC_RSD_V2_STATUS_V_SIDE),
  QGFC_RSD_V2_STATUS_M_TOP = (1 << QGFC_RSD_V2_STATUS_V_TOP),
  QGFC_RSD_V2_STATUS_M_SPLASH_1 = (1 << QGFC_RSD_V2_STATUS_V_SPLASH_1),
  QGFC_RSD_V2_STATUS_M_E350_FILTER_TILE,
  QGFC_RSD_V2_STATUS_M_E0_TILE = (1 << QGFC_RSD_V2_STATUS_V_E0_TILE),
  QGFC_RSD_V2_STATUS_M_SPLASH_0 = (1 << QGFC_RSD_V2_STATUS_V_SPLASH_0),
  QGFC_RSD_V2_STATUS_M_NOCALLO_FILTER_TILE,
  QGFC_RSD_V2_STATUS_M_VETOED = (1 << QGFC_RSD_V2_STATUS_V_VETOED),
  QGFC_RSD_V2_STATUS_M_INFO,
  QGFC_RSD_V2_STATUS_M_PASSES = QGFC_RSD_V2_STATUS_M_HI_ENERGY,
  QGFC_RSD_V2_STATUS_M_VETOES
}
 Filter status, mask. More...

Functions

static __inline int QGFC_rsd_v2__energyInLeuGet (unsigned int stageEnergy)
 Extract the signed energy value from the result word containing the analyze stage and energy.
static __inline int QGFC_rsd_v2__stageGetL (unsigned int stageEnergy)
 Extract the left justified stage value from the result word containing the analysis stage and energy.
static __inline int QGFC_rsd_v2__stageGetR (unsigned int stageEnergy)
 Extract the right justified stage value from the result word containing the analysis stage and energy.

Detailed Description

Defines the gamma filter result summary data, version 2.

Author:
JJRussell - russell@slac.stanford.edu

    CVS $Id: QGFC_rsd_v2.h,v 1.2 2011/03/28 22:58:45 russell Exp $

Typedef Documentation

QGFC_RSD_V2_STAGE_S

Typedef for enum _QGFC_RSD_V2_STAGE_S.

This maps out the size of the 2 major fields, the STAGE bit field and the ENERGY bit field. Apologies for the poor naming conventions used here

QGFC_RSD_V2_STAGE_V

Typedef for enum _QGFC_RSD_V2_STAGE_V.

This maps out the analysis phases completed by the Gamma Filter. These bits occupy the upper 8 bits of the stage and energy word of the result vector. The energy occupies the lower 24 bits.

QGFC_RSD_V2_stageEnergy

Typedef for struct _QGFC_RSD_V2_stageEnergy_bf.

Typedef for union _QGFC_RSD_V2_stageEnergy.

Enumeration Type Documentation

enum _QGFC_RSD_V2_STAGE_M

Filter stage, mask.

Enumerator:
QGFC_RSD_V2_STAGE_M_ENERGY  The energy portion of the stage and energy result word
QGFC_RSD_V2_STAGE_M_ACD  ACD was analyzed
QGFC_RSD_V2_STAGE_M_DIR  DIR was decoded
QGFC_RSD_V2_STAGE_M_ATF  ACD/TKR veto was analyzed
QGFC_RSD_V2_STAGE_M_CAL1  CAL was analyzed, phase 1
QGFC_RSD_V2_STAGE_M_TKR  TKR finding was done
QGFC_RSD_V2_STAGE_M_RSVD_5  Reserved for future use
QGFC_RSD_V2_STAGE_M_RSVD_6  Reserved for future use
QGFC_RSD_V2_STAGE_M_MPKT  Event was a multi-packet event

enum _QGFC_RSD_V2_STAGE_S

Gamma filter analysis stage, bit definitions, size.

Enumerator:
QGFC_RSD_V2_STAGE_S_ENERGY  The size of the energy field
QGFC_RSD_V2_STAGE_S_STAGE  The size of the stage bit field

enum _QGFC_RSD_V2_STAGE_V

Gamma filter analysis stage, bit definitions.

Enumerator:
QGFC_RSD_V2_STAGE_V_ENERGY  ENERGY bit field
QGFC_RSD_V2_STAGE_V_STAGE  STAGE bit field
QGFC_RSD_V2_STAGE_V_ACD  ACD was analyzed
QGFC_RSD_V2_STAGE_V_DIR  DIR was decoded
QGFC_RSD_V2_STAGE_V_ATF  ACD/TKR veto was analyzed
QGFC_RSD_V2_STAGE_V_CAL1  CAL was analyzed, phase 1
QGFC_RSD_V2_STAGE_V_TKR  TKR finding was done
QGFC_RSD_V2_STAGE_V_RSVD_5  Reserved for future use
QGFC_RSD_V2_STAGE_V_RSVD_6  Reserved for future use
QGFC_RSD_V2_STAGE_V_MPKT  Event was a multipacket event

enum _QGFC_RSD_V2_STATUS_M

Filter status, mask.

Enumerator:
QGFC_RSD_V2_STATUS_M_GEM_THROTTLE  Throttle bit set
QGFC_RSD_V2_STATUS_M_GEM_TKR  Have a 3-in-a-row trigger
QGFC_RSD_V2_STATUS_M_GEM_CALLO  Cal Lo Trigger
QGFC_RSD_V2_STATUS_M_GEM_CALHI  Cal Hi Trigger
QGFC_RSD_V2_STATUS_M_GEM_CNO  Cal Hi Trigger
QGFC_RSD_V2_STATUS_M_ACD_TOP  ACD top tile struck
QGFC_RSD_V2_STATUS_M_ACD_SIDE  ACD side tile struck
QGFC_RSD_V2_STATUS_M_ACD_SIDE_FILTER  ACD filter tile struck
QGFC_RSD_V2_STATUS_M_TKR_EQ_1  Exactly 1 track
QGFC_RSD_V2_STATUS_M_TKR_GE_2  Greater or equal 2 tracks
QGFC_RSD_V2_STATUS_M_RSVD_10  Reserved for future use
QGFC_RSD_V2_STATUS_M_RSVD_11  Reserved for future use
QGFC_RSD_V2_STATUS_M_ERR_CTB  Contributor in error
QGFC_RSD_V2_STATUS_M_TKR_LT_2_ELO  Low energy, no 2 track evidence
QGFC_RSD_V2_STATUS_M_TKR_SKIRT  Have track(s) into the skirt region
QGFC_RSD_V2_STATUS_M_TKR_EQ_0  No tracks
QGFC_RSD_V2_STATUS_M_TKR_ROW2  Track Row 2 match
QGFC_RSD_V2_STATUS_M_TKR_ROW01  Track Row 0 or 1 match
QGFC_RSD_V2_STATUS_M_TKR_TOP  Track Top match
QGFC_RSD_V2_STATUS_M_ZBOTTOM  No tracks into CAL with energy
QGFC_RSD_V2_STATUS_M_EL0_ETOT_HI  E layer 0/ETOT > .90 (90% typical)
QGFC_RSD_V2_STATUS_M_EL0_ETOT_LO  E layer 0/ETOT < .01 ( 1% typical)
QGFC_RSD_V2_STATUS_M_HI_ENERGY  E layer 0/ETOT > .90 (90% typical)
QGFC_RSD_V2_STATUS_M_LO_ENERGY  E layer 0/ETOT < .01 ( 1% typical)
QGFC_RSD_V2_STATUS_M_SIDE  Event has a side face veto
QGFC_RSD_V2_STATUS_M_TOP  Event has a top face veto
QGFC_RSD_V2_STATUS_M_SPLASH_1  Event has a splash veto
QGFC_RSD_V2_STATUS_M_E350_FILTER_TILE  Event <350Mev + filter tiles
QGFC_RSD_V2_STATUS_M_E0_TILE  Event 0 energy + tile hit
QGFC_RSD_V2_STATUS_M_SPLASH_0  Event has a splash veto
QGFC_RSD_V2_STATUS_M_NOCALLO_FILTER_TILE  No CAL LO trigger + filter tile
QGFC_RSD_V2_STATUS_M_VETOED  Any veto
QGFC_RSD_V2_STATUS_M_INFO  The set of all informational bits
QGFC_RSD_V2_STATUS_M_PASSES  The set of all pass bits
QGFC_RSD_V2_STATUS_M_VETOES  The set of all veto bits

enum _QGFC_RSD_V2_STATUS_V

Gamma filter status, bit definitions.

Enumerator:
QGFC_RSD_V2_STATUS_V_GEM_THROTTLE  Throttle bit set
QGFC_RSD_V2_STATUS_V_GEM_TKR  Have a 3-in-a-row trigger
QGFC_RSD_V2_STATUS_V_GEM_CALLO  Cal Lo Trigger
QGFC_RSD_V2_STATUS_V_GEM_CALHI  Cal Hi Trigger
QGFC_RSD_V2_STATUS_V_GEM_CNO  Cal Hi Trigger
QGFC_RSD_V2_STATUS_V_ACD_TOP  ACD top tile struck
QGFC_RSD_V2_STATUS_V_ACD_SIDE  ACD side tile struck
QGFC_RSD_V2_STATUS_V_ACD_SIDE_FILTER  ACD filter tile struck
QGFC_RSD_V2_STATUS_V_TKR_EQ_1  Exactly 1 track
QGFC_RSD_V2_STATUS_V_TKR_GE_2  Greater or equal 2 tracks
QGFC_RSD_V2_STATUS_V_RSVD_10  Reserved for future use
QGFC_RSD_V2_STATUS_V_RSVD_11  Reserved for future use
QGFC_RSD_V2_STATUS_V_ERR_CTB  Contributor in error
QGFC_RSD_V2_STATUS_V_TKR_LT_2_ELO  Low energy, no 2 track evidence
QGFC_RSD_V2_STATUS_V_TKR_SKIRT  Event into the skirt region
QGFC_RSD_V2_STATUS_V_TKR_EQ_0  No tracks
QGFC_RSD_V2_STATUS_V_TKR_ROW2  Track Row 2 match
QGFC_RSD_V2_STATUS_V_TKR_ROW01  Track Row 0 or 1 match
QGFC_RSD_V2_STATUS_V_TKR_TOP  Track Top match
QGFC_RSD_V2_STATUS_V_ZBOTTOM  No tracks into CAL with energy
QGFC_RSD_V2_STATUS_V_EL0_ETOT_HI  E layer 0/ETOT > .90 (90% typical)
QGFC_RSD_V2_STATUS_V_EL0_ETOT_LO  E layer 0/ETOT < .01 ( 1% typical)
QGFC_RSD_V2_STATUS_V_HI_ENERGY  Energy > pass cut, typically > 20 Gev
QGFC_RSD_V2_STATUS_V_LO_ENERGY  Energy <= veto cut, typically <= 2-5 Mev
QGFC_RSD_V2_STATUS_V_SIDE  Event has a side face veto
QGFC_RSD_V2_STATUS_V_TOP  Event has a top face veto
QGFC_RSD_V2_STATUS_V_SPLASH_1  Event has a splash veto
QGFC_RSD_V2_STATUS_V_E350_FILTER_TILE  Event <350Mev + filter tiles
QGFC_RSD_V2_STATUS_V_E0_TILE  Event 0 energy + tile hit
QGFC_RSD_V2_STATUS_V_SPLASH_0  Event has a splash veto
QGFC_RSD_V2_STATUS_V_NOCALLO_FILTER_TILE  No CAL LO trigger + filter tile
QGFC_RSD_V2_STATUS_V_VETOED  Any veto

Function Documentation

static __inline int QGFC_rsd_v2__energyInLeuGet ( unsigned int  stageEnergy  )  [static]

Extract the signed energy value from the result word containing the analyze stage and energy.

Returns:
The signed energy in units of LEUs (1/4 Mev).
Parameters:
stageEnergy The packed stage analysis word
Note:
The range is about +/- 2100 Gev.

References _QGFC_RSD_V2_stageEnergy::bf, and _QGFC_RSD_V2_stageEnergy::ui.

static __inline int QGFC_rsd_v2__stageGetL ( unsigned int  stageEnergy  )  [static]

Extract the left justified stage value from the result word containing the analysis stage and energy.

Returns:
The left justified stage value
Parameters:
stageEnergy The packed stage analysis word

static __inline int QGFC_rsd_v2__stageGetR ( unsigned int  stageEnergy  )  [static]

Extract the right justified stage value from the result word containing the analysis stage and energy.

Returns:
The right justified stage value
Parameters:
stageEnergy The packed stage analysis word

References QGFC_RSD_V2_STAGE_V_ACD.

Generated on Mon Mar 28 16:00:56 2011 by  doxygen 1.5.8