GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> EFC / V4-5-0 > ifilter / rad750

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » PHY » source » EFC » V4-5-0 » EFC

GFC_V3_status.h File Reference

Defines the gamma filter status bits, version 2. More...

#include <PBI/Endianness.h>

Classes

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

Typedefs

typedef enum _GFC_V3_STAGE_S GFC_V3_STAGE_S
 Typedef for enum _GFC_V3_STAGE_S.
typedef enum _GFC_V3_STAGE_V GFC_V3_STAGE_V
 Typedef for enum _GFC_V3_STAGE_V.
typedef enum _GFC_V3_STAGE_M GFC_V3_STAGE_M
 Typedef for enum _GFC_V3_STAGE_M.
typedef enum _GFC_V3_STATUS_V GFC_V3_STATUS_V
 Typedef for enum _GFC_V3_STATUS_V.
typedef enum _GFC_V3_STATUS_M GFC_V3_STATUS_M
 Typedef for enum _GFC_V3_STATUS_M.
typedef struct
_GFC_V3_stageEnergy_bf 		GFC_V3_stageEnergy_bf
typedef union _GFC_V3_stageEnergy GFC_V3_stageEnergy
 Typedef for struct _GFC_V3_stageEnergy_bf.

Enumerations

enum  _GFC_V3_STAGE_S {
  GFC_V3_STAGE_S_ENERGY = 24,
  GFC_V3_STAGE_S_STAGE = 8
}
 Gamma filter analysis stage, bit definitions, size. More...
enum  _GFC_V3_STAGE_V {
  GFC_V3_STAGE_V_ENERGY = 0,
  GFC_V3_STAGE_V_STAGE = 24,
  GFC_V3_STAGE_V_CAL = 24,
  GFC_V3_STAGE_V_ACD = 25,
  GFC_V3_STAGE_V_DIR = 26,
  GFC_V3_STAGE_V_ATF = 27,
  GFC_V3_STAGE_V_TKR = 28,
  GFC_V3_STAGE_V_RSVD_5 = 29,
  GFC_V3_STAGE_V_RSVD_6 = 30,
  GFC_V3_STAGE_V_MPKT = 31
}
 Gamma filter analysis stage, bit definitions. More...
enum  _GFC_V3_STAGE_M {
  GFC_V3_STAGE_M_ENERGY = 0x00ffffff,
  GFC_V3_STAGE_M_CAL = (1 << GFC_V3_STAGE_V_CAL),
  GFC_V3_STAGE_M_ACD = (1 << GFC_V3_STAGE_V_ACD),
  GFC_V3_STAGE_M_DIR = (1 << GFC_V3_STAGE_V_DIR),
  GFC_V3_STAGE_M_ATF = (1 << GFC_V3_STAGE_V_ATF),
  GFC_V3_STAGE_M_TKR = (1 << GFC_V3_STAGE_V_TKR),
  GFC_V3_STAGE_M_RSVD_5 = (1 << GFC_V3_STAGE_V_RSVD_5),
  GFC_V3_STAGE_M_RSVD_6 = (1 << GFC_V3_STAGE_V_RSVD_6),
  GFC_V3_STAGE_M_MPKT = (1 << GFC_V3_STAGE_V_MPKT),
  GFC_V3_STAGE_M_STAGE
}
 Filter stage, mask. More...
enum  _GFC_V3_STATUS_V {
  GFC_V3_STATUS_V_GEM_THROTTLE = 0,
  GFC_V3_STATUS_V_GEM_TKR = 1,
  GFC_V3_STATUS_V_GEM_CALLO = 2,
  GFC_V3_STATUS_V_GEM_CALHI = 3,
  GFC_V3_STATUS_V_GEM_CNO = 4,
  GFC_V3_STATUS_V_ACD_TOP = 5,
  GFC_V3_STATUS_V_ACD_SIDE = 6,
  GFC_V3_STATUS_V_ACD_SIDE_FILTER = 7,
  GFC_V3_STATUS_V_TKR_EQ_1 = 8,
  GFC_V3_STATUS_V_TKR_GE_2 = 9,
  GFC_V3_STATUS_V_RSVD_10 = 10,
  GFC_V3_STATUS_V_TKR_LT_2_ELO = 11,
  GFC_V3_STATUS_V_TKR_SKIRT = 12,
  GFC_V3_STATUS_V_TKR_EQ_0 = 13,
  GFC_V3_STATUS_V_TKR_ROW2 = 14,
  GFC_V3_STATUS_V_TKR_ROW01 = 15,
  GFC_V3_STATUS_V_TKR_TOP = 16,
  GFC_V3_STATUS_V_SIDE = 17,
  GFC_V3_STATUS_V_TOP = 18,
  GFC_V3_STATUS_V_ZBOTTOM = 19,
  GFC_V3_STATUS_V_ERR_CTB = 20,
  GFC_V3_STATUS_V_SPLASH_1 = 21,
  GFC_V3_STATUS_V_E350_FILTER_TILE = 22,
  GFC_V3_STATUS_V_E0_TILE = 23,
  GFC_V3_STATUS_V_EL0_ETOT_HI = 24,
  GFC_V3_STATUS_V_EL0_ETOT_LO = 25,
  GFC_V3_STATUS_V_LO_ENERGY = 26,
  GFC_V3_STATUS_V_HI_ENERGY = 27,
  GFC_V3_STATUS_V_SPLASH_0 = 28,
  GFC_V3_STATUS_V_NOCALLO_FILTER_TILE = 29,
  GFC_V3_STATUS_V_NON_PHYSICS = 30,
  GFC_V3_STATUS_V_VETOED = 31
}
 Gamma filter status, bit definitions. More...
enum  _GFC_V3_STATUS_M {
  GFC_V3_STATUS_M_GEM_THROTTLE = (1 << GFC_V3_STATUS_V_GEM_THROTTLE),
  GFC_V3_STATUS_M_GEM_TKR = (1 << GFC_V3_STATUS_V_GEM_TKR),
  GFC_V3_STATUS_M_GEM_CALLO = (1 << GFC_V3_STATUS_V_GEM_CALLO),
  GFC_V3_STATUS_M_GEM_CALHI = (1 << GFC_V3_STATUS_V_GEM_CALHI),
  GFC_V3_STATUS_M_GEM_CNO = (1 << GFC_V3_STATUS_V_GEM_CNO),
  GFC_V3_STATUS_M_GEM,
  GFC_V3_STATUS_M_ACD_TOP = (1 << GFC_V3_STATUS_V_ACD_TOP),
  GFC_V3_STATUS_M_ACD_SIDE = (1 << GFC_V3_STATUS_V_ACD_SIDE),
  GFC_V3_STATUS_M_ACD_SIDE_FILTER = (1 <<GFC_V3_STATUS_V_ACD_SIDE_FILTER),
  GFC_V3_STATUS_M_TKR_EQ_1 = (1 << GFC_V3_STATUS_V_TKR_EQ_1),
  GFC_V3_STATUS_M_TKR_GE_2 = (1 << GFC_V3_STATUS_V_TKR_GE_2),
  GFC_V3_STATUS_M_RSVD_10 = (1 << GFC_V3_STATUS_V_RSVD_10),
  GFC_V3_STATUS_M_TKR_LT_2_ELO = (1 << GFC_V3_STATUS_V_TKR_LT_2_ELO),
  GFC_V3_STATUS_M_TKR_SKIRT = (1 << GFC_V3_STATUS_V_TKR_SKIRT),
  GFC_V3_STATUS_M_TKR_EQ_0 = (1 << GFC_V3_STATUS_V_TKR_EQ_0),
  GFC_V3_STATUS_M_TKR_ROW2 = (1 << GFC_V3_STATUS_V_TKR_ROW2),
  GFC_V3_STATUS_M_TKR_ROW01 = (1 << GFC_V3_STATUS_V_TKR_ROW01),
  GFC_V3_STATUS_M_TKR_TOP = (1 << GFC_V3_STATUS_V_TKR_TOP),
  GFC_V3_STATUS_M_SIDE = (1 << GFC_V3_STATUS_V_SIDE),
  GFC_V3_STATUS_M_TOP = (1 << GFC_V3_STATUS_V_TOP),
  GFC_V3_STATUS_M_ZBOTTOM = (1 << GFC_V3_STATUS_V_ZBOTTOM),
  GFC_V3_STATUS_M_ERR_CTB = (1 << GFC_V3_STATUS_V_ERR_CTB),
  GFC_V3_STATUS_M_SPLASH_1 = (1 << GFC_V3_STATUS_V_SPLASH_1),
  GFC_V3_STATUS_M_E350_FILTER_TILE,
  GFC_V3_STATUS_M_E0_TILE = (1 << GFC_V3_STATUS_V_E0_TILE),
  GFC_V3_STATUS_M_EL0_ETOT_HI = (1 << GFC_V3_STATUS_V_EL0_ETOT_HI),
  GFC_V3_STATUS_M_EL0_ETOT_LO = (1 << GFC_V3_STATUS_V_EL0_ETOT_LO),
  GFC_V3_STATUS_M_LO_ENERGY = (1 << GFC_V3_STATUS_V_LO_ENERGY),
  GFC_V3_STATUS_M_HI_ENERGY = (1 << GFC_V3_STATUS_V_HI_ENERGY),
  GFC_V3_STATUS_M_SPLASH_0 = (1 << GFC_V3_STATUS_V_SPLASH_0),
  GFC_V3_STATUS_M_NOCALLO_FILTER_TILE,
  GFC_V3_STATUS_M_NON_PHYSICS = (1 << GFC_V3_STATUS_V_NON_PHYSICS),
  GFC_V3_STATUS_M_VETOED = (1 << GFC_V3_STATUS_V_VETOED),
  GFC_V3_STATUS_M_INFO,
  GFC_V3_STATUS_M_PASSES = GFC_V3_STATUS_M_HI_ENERGY,
  GFC_V3_STATUS_M_VETOES
}
 Filter status, mask. More...

Functions

static __inline int GFC_V3__resultEnergyInLeuGet (unsigned int stageEnergy)
 Extract the signed energy value from the result word containing the analyze stage and energy.
static __inline int GFC_V3__resultStageGetL (unsigned int stageEnergy)
 Extract the left justified stage value from the result word containing the analysis stage and energy.
static __inline int GFC_V3__resultStageGetR (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 status bits, version 2.

Author:
JJRussell - russell@slac.stanford.edu

    CVS $Id: GFC_V3_status.h,v 1.2 2011/03/27 04:55:29 russell Exp $

Typedef Documentation

GFC_V3_STAGE_S

Typedef for enum _GFC_V3_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

GFC_V3_STAGE_V

Typedef for enum _GFC_V3_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.

GFC_V3_stageEnergy

Typedef for struct _GFC_V3_stageEnergy_bf.

Typedef for union _GFC_V3_stageEnergy.

Enumeration Type Documentation

enum _GFC_V3_STAGE_M

Filter stage, mask.

Enumerator:
GFC_V3_STAGE_M_ENERGY  The energy portion of the stage and energy result word
GFC_V3_STAGE_M_CAL  CAL energy was computed
GFC_V3_STAGE_M_ACD  ACD was analyzed
GFC_V3_STAGE_M_DIR  DIR was decoded
GFC_V3_STAGE_M_ATF  ACD/TKR veto was analyzed
GFC_V3_STAGE_M_TKR  TKR finding was done
GFC_V3_STAGE_M_RSVD_5  Reserved for future use
GFC_V3_STAGE_M_RSVD_6  Reserved for future use
GFC_V3_STAGE_M_MPKT  Event was a multi-packet event

enum _GFC_V3_STAGE_S

Gamma filter analysis stage, bit definitions, size.

Enumerator:
GFC_V3_STAGE_S_ENERGY  The size of the energy field
GFC_V3_STAGE_S_STAGE  The size of the stage bit field

enum _GFC_V3_STAGE_V

Gamma filter analysis stage, bit definitions.

Enumerator:
GFC_V3_STAGE_V_ENERGY  ENERGY bit field
GFC_V3_STAGE_V_STAGE  STAGE bit field
GFC_V3_STAGE_V_CAL  CAL was analyzed
GFC_V3_STAGE_V_ACD  ACD was analyzed
GFC_V3_STAGE_V_DIR  DIR was decoded
GFC_V3_STAGE_V_ATF  ACD/TKR veto was analyzed
GFC_V3_STAGE_V_TKR  TKR finding was done
GFC_V3_STAGE_V_RSVD_5  Reserved for future use
GFC_V3_STAGE_V_RSVD_6  Reserved for future use
GFC_V3_STAGE_V_MPKT  Event was a multipacket event

enum _GFC_V3_STATUS_M

Filter status, mask.

Enumerator:
GFC_V3_STATUS_M_GEM_THROTTLE  Throttle bit set
GFC_V3_STATUS_M_GEM_TKR  Have a 3-in-a-row trigger
GFC_V3_STATUS_M_GEM_CALLO  Cal Lo Trigger
GFC_V3_STATUS_M_GEM_CALHI  Cal Hi Trigger
GFC_V3_STATUS_M_GEM_CNO  Cal Hi Trigger
GFC_V3_STATUS_M_ACD_TOP  ACD top tile struck
GFC_V3_STATUS_M_ACD_SIDE  ACD side tile struck
GFC_V3_STATUS_M_ACD_SIDE_FILTER  ACD filter tile struck
GFC_V3_STATUS_M_TKR_EQ_1  Exactly 1 track
GFC_V3_STATUS_M_TKR_GE_2  Greater or equal 2 tracks
GFC_V3_STATUS_M_RSVD_10  Reserved for future use
GFC_V3_STATUS_M_TKR_LT_2_ELO  Low energy, no 2 track evidence
GFC_V3_STATUS_M_TKR_SKIRT  Have track(s) into the skirt region
GFC_V3_STATUS_M_TKR_EQ_0  No tracks
GFC_V3_STATUS_M_TKR_ROW2  Track Row 2 match
GFC_V3_STATUS_M_TKR_ROW01  Track Row 0 or 1 match
GFC_V3_STATUS_M_TKR_TOP  Track Top match
GFC_V3_STATUS_M_SIDE  Event has a side face veto
GFC_V3_STATUS_M_TOP  Event has a top face veto
GFC_V3_STATUS_M_ZBOTTOM  No tracks into CAL with energy
GFC_V3_STATUS_M_ERR_CTB  Contributor in error
GFC_V3_STATUS_M_SPLASH_1  Event has a splash veto
GFC_V3_STATUS_M_E350_FILTER_TILE  Event <350Mev + filter tiles
GFC_V3_STATUS_M_E0_TILE  Event 0 energy + tile hit
GFC_V3_STATUS_M_EL0_ETOT_HI  E layer 0/ETOT > .90 (90% typical)
GFC_V3_STATUS_M_EL0_ETOT_LO  E layer 0/ETOT < .01 ( 1% typical)
GFC_V3_STATUS_M_LO_ENERGY  E layer 0/ETOT < .01 ( 1% typical)
GFC_V3_STATUS_M_HI_ENERGY  High Energy pass condition (>20 GeV typical)
GFC_V3_STATUS_M_SPLASH_0  Event has a splash veto
GFC_V3_STATUS_M_NOCALLO_FILTER_TILE  No CAL LO trigger + filter tile
GFC_V3_STATUS_M_NON_PHYSICS  A non-physics event
GFC_V3_STATUS_M_VETOED  Any veto
GFC_V3_STATUS_M_INFO  The set of all informational bits
GFC_V3_STATUS_M_PASSES  The set of all pass bits
GFC_V3_STATUS_M_VETOES  The set of all veto bits

enum _GFC_V3_STATUS_V

Gamma filter status, bit definitions.

Enumerator:
GFC_V3_STATUS_V_GEM_THROTTLE  Throttle bit set
GFC_V3_STATUS_V_GEM_TKR  Have a 3-in-a-row trigger
GFC_V3_STATUS_V_GEM_CALLO  Cal Lo Trigger
GFC_V3_STATUS_V_GEM_CALHI  Cal Hi Trigger
GFC_V3_STATUS_V_GEM_CNO  Cal Hi Trigger
GFC_V3_STATUS_V_ACD_TOP  ACD top tile struck
GFC_V3_STATUS_V_ACD_SIDE  ACD side tile struck
GFC_V3_STATUS_V_ACD_SIDE_FILTER  ACD filter tile struck
GFC_V3_STATUS_V_TKR_EQ_1  Exactly 1 track
GFC_V3_STATUS_V_TKR_GE_2  Greater or equal 2 tracks
GFC_V3_STATUS_V_RSVD_10  Reserved for future use
GFC_V3_STATUS_V_TKR_LT_2_ELO  Low energy, no 2 track evidence
GFC_V3_STATUS_V_TKR_SKIRT  Event into the skirt region
GFC_V3_STATUS_V_TKR_EQ_0  No tracks
GFC_V3_STATUS_V_TKR_ROW2  Track Row 2 match
GFC_V3_STATUS_V_TKR_ROW01  Track Row 0 or 1 match
GFC_V3_STATUS_V_TKR_TOP  Track Top match
GFC_V3_STATUS_V_SIDE  Event has a side face veto
GFC_V3_STATUS_V_TOP  Event has a top face veto
GFC_V3_STATUS_V_ZBOTTOM  No tracks into CAL with energy
GFC_V3_STATUS_V_ERR_CTB  Contributor in error
GFC_V3_STATUS_V_SPLASH_1  Event has a splash veto
GFC_V3_STATUS_V_E350_FILTER_TILE  Event <350Mev + filter tiles
GFC_V3_STATUS_V_E0_TILE  Event 0 energy + tile hit
GFC_V3_STATUS_V_EL0_ETOT_HI  E layer 0/ETOT > .90 (90% typical)
GFC_V3_STATUS_V_EL0_ETOT_LO  E layer 0/ETOT < .01 ( 1% typical)
GFC_V3_STATUS_V_LO_ENERGY  Energy <= veto cut, typically <= 2-5 Mev
GFC_V3_STATUS_V_HI_ENERGY  Energy > pass cut, typically > 20 Gev
GFC_V3_STATUS_V_SPLASH_0  Event has a splash veto
GFC_V3_STATUS_V_NOCALLO_FILTER_TILE  No CAL LO trigger + filter tile
GFC_V3_STATUS_V_NON_PHYSICS  A non-physics event
GFC_V3_STATUS_V_VETOED  Any veto

Function Documentation

static __inline int GFC_V3__resultEnergyInLeuGet ( 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 _GFC_V3_stageEnergy::bf, and _GFC_V3_stageEnergy::ui.

static __inline int GFC_V3__resultStageGetL ( 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 GFC_V3__resultStageGetR ( 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 GFC_V3_STAGE_V_ACD.

Generated on Wed Jan 4 14:30:50 2012 by  doxygen 1.5.8