LSEP_evtBdy0.h File Reference

The LAT Science Body layer for Format 0 Events. More...

#include <EDS/EBF_evt.h>
#include <EDS/EBF_pkt.h>

Classes
struct	_LSEP_evtBdy0_0
	Event Body Format 0, subforma1 0. More...
struct	_LSEP_evtBdy0_1
	Event format 0, subformat 1. More...
struct	_LSEP_evtBdy0_2
	Event format 0, subformat 2. More...
struct	_LSEP_evtBdy0_3
	Event format 0, subformat 3. More...
union	_LSEP_evtToc0_4_ctl_bf
	Event Format 0.4 Table of Contents control word as bit fields. More...
union	_LSEP_evtToc0_4_ctl
	Event Format 0.4 Table of Contents control word as a 32-bit word and its bit field representation. More...
struct	_LSEP_evtToc0_4_tem_bf
	The 16 bit TEM word of the Table of Contents, bit field representation. More...
union	_LSEP_evtToc0_4_tem
	The 16 bit TEM word of the Table of Contents, union of the bit field representation with an unsigned short (16-bit) integer. More...
union	_LSEP_evtToc0_4
	Event Format 0.4 Table of Contents. More...
struct	_LSEP_evtBdy0_4
	Event format 0, subformat 4. More...
struct	_LSEP_evtToc0_5
	Event Format 0.4 Table of Contents. More...
struct	_LSEP_evtBdy0_5
	Event format 0, subformat 5. More...
union	_LSEP_evtBdy0
	Event Body Format 0. More...
struct	_LSEP_gem0
	Output GEM data. More...
Typedefs
typedef enum _LSEP_ROOTHDR_BRIDGE_M	LSEP_ROOTHDR_BRIDGE_M
	Typedef for enum _LSEP_ROOTHDR_BRIDGE_M.
typedef enum _LSEP_RECHDR_BRIDGE_M	LSEP_RECHDR_BRIDGE_M
	Typedef for enum _LSEP_RECHDR_BRIDGE_M.
typedef enum _LSEP_RECHDR_BRIDGE_V	LSEP_RECHDR_BRIDGE_V
typedef struct _LSEP_evtBdy0_0	LSEP_evtBdy0_0
	Typedef for struct _LSEP_evtBdy0_0.
typedef struct _LSEP_evtBdy0_1	LSEP_evtBdy0_1
	Typedef for struct _LSEP_evtBdy0_1.
typedef struct _LSEP_evtBdy0_2	LSEP_evtBdy0_2
	Typedef for struct _LSEP_evtBdy0_2.
typedef struct _LSEP_evtBdy0_3	LSEP_evtBdy0_3
	Typedef for struct _LSEP_evtBdy0_3.
typedef struct _LSEP_evtToc0_4_ctl_bf	LSEP_evtToc0_4_ctl_bf
	Typedef for struct _LSEP_evtBdy0_4_toc_ctl_bf.
typedef union _LSEP_evtToc0_4_ctl	LSEP_evtToc0_4_ctl
	Typedef for union _LSEP_evtToc0_4_ctl.
typedef enum _LSEP_EVTTOC0_4_TEM_S	LSEP_EVTTOC0_4_TEM_S
	Typedef of enum _LSEP_EVTTOC0_4_TEM_S.
typedef enum _LSEP_EVTTOC0_4_TEM_V	LSEP_EVTTOC0_4_TEM_V
	Typedef of enum _LSEP_EVTTOC0_4_TEM_V.
typedef enum _LSEP_EVTTOC0_4_TEM_M	LSEP_EVTTOC0_4_TEM_M
	Typedef of enum _LSEP_EVTTOC0_4_TEM_M.
typedef struct _LSEP_evtToc0_4_tem_bf	LSEP_evtToc0_4_tem_bf
	Typedef for struct _LSEP_evtToc0_4_tem_bf.
typedef union _LSEP_evtToc0_4_tem	LSEP_evtToc0_4_tem
	Typedef for struct _LSEP_evtToc0_4_tem.
typedef struct _LSEP_evtToc0_4	LSEP_evtToc0_4
	Typedef for struct _LSEP_evtToc0_4.
typedef struct _LSEP_evtBdy0_4	LSEP_evtBdy0_4
	Typedef for struct _LSEP_evtBdy0_4.
typedef struct _LSEP_evtToc0_5	LSEP_evtToc0_5
	Typedef for struct _LSEP_evtToc0_5.
typedef struct _LSEP_evtBdy0_5	LSEP_evtBdy0_5
	Typedef for struct _LSEP_evtBdy0_5.
typedef union _LSEP_evtBdy0	LSEP_evtBdy0
	Typedef for union _LSEP_evtBdy0.
typedef struct _LSEP_gem0	LSEP_gem0
	Typedef for struct _LSEP_gem0.
Enumerations
enum	_LSEP_ROOTHDR_BRIDGE_M { LSEP_ROOTHDR_BRIDGE_M_RSD = 0x01 }
	The definition of the bridge word bits for the LSEP root contribution. More...
enum	_LSEP_RECHDR_BRIDGE_M {   LSEP_RECHDR_BRIDGE_M_ERR = 0x80,   LSEP_RECHDR_BRIDGE_M_RSD = 0x40,   LSEP_RECHDR_BRIDGE_M_CHECKSUM = 0x20,   LSEP_RECHDR_BRIDGE_M_4_5_NOTACK = 0x04,   LSEP_RECHDR_BRIDGE_M_4_5_EXCBLK = 0x02,   LSEP_RECHDR_BRIDGE_M_5_CALTKR = 0x01 }
	The definition of the bridge word bits. More...
enum	_LSEP_RECHDR_BRIDGE_V {   LSEP_RECHDR_BRIDGE_V_ERR = 7,   LSEP_RECHDR_BRIDGE_V_RSD = 6,   LSEP_RECHDR_BRIDGE_V_4_5_NOTACK = 2,   LSEP_RECHDR_BRIDGE_V_4_5_EXCBLK = 1,   LSEP_RECHDR_BRIDGE_V_5_CALTKR = 0 }
enum	_LSEP_EVTTOC0_4_TEM_S {   LSEP_EVTTOC0_4_TEM_S_LEN = 10,   LSEP_EVTTOC0_4_TEM_S_RSVD = 1,   LSEP_EVTTOC0_4_TEM_S_ERRBLK = 1,   LSEP_EVTTOC0_4_TEM_S_DGNBLK = 1,   LSEP_EVTTOC0_4_TEM_S_NO_TKR = 1,   LSEP_EVTTOC0_4_TEM_S_NO_CAL = 1,   LSEP_EVTTOC0_4_TEM_S_ABSENT = 1 }
	Enumeration of the sizes of the fields in the TEM Table Of Contents word. More...
enum	_LSEP_EVTTOC0_4_TEM_V {   LSEP_EVTTOC0_4_TEM_V_LEN = 0,   LSEP_EVTTOC0_4_TEM_V_RSVD = 10,   LSEP_EVTTOC0_4_TEM_V_ERRBLK = 11,   LSEP_EVTTOC0_4_TEM_V_DGNBLK = 12,   LSEP_EVTTOC0_4_TEM_V_NO_TKR = 13,   LSEP_EVTTOC0_4_TEM_V_NO_CAL = 14,   LSEP_EVTTOC0_4_TEM_V_ABSENT = 15 }
	Enumeration of the right justified bit offsets of the fields in the TEM Table Of Contents word. More...
enum	_LSEP_EVTTOC0_4_TEM_M {   LSEP_EVTTOC0_4_TEM_M_LEN,   LSEP_EVTTOC0_4_TEM_M_RSVD,   LSEP_EVTTOC0_4_TEM_M_ERRBLK,   LSEP_EVTTOC0_4_TEM_M_DGNBLK,   LSEP_EVTTOC0_4_TEM_M_NO_TKR,   LSEP_EVTTOC0_4_TEM_M_NO_CAL,   LSEP_EVTTOC0_4_TEM_M_ABSENT }
	Enumeration of the in place masks of the fields in the TEM Table Of Contents word. More...

---

Detailed Description

The LAT Science Body layer for Format 0 Events.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: LSEP_evtBdy0.h,v 1.8 2011/03/26 23:32:30 russell Exp $

---

Typedef Documentation

LSEP_evtToc0_4_ctl_bf

Typedef for struct _LSEP_evtBdy0_4_toc_ctl_bf.

This structure is used to encode information from the Event Summary Words for both format 4 and format 5 events. The fields in this word are chosen because either

1. They must be the same for all contributors
2. They are likely the same for all contributors

Fields in the first category are sourced from the trigger word and, so must be the same. The diagnostic field is the only member of the second category. While it can be set on a TEM-by-TEM basis, the most likely scenerio is that it is that they are all the same.

Format 4 interpretation

If this bit is set in format 4 events it indicates that at least 1 TEM is in disagreement with the expected value. Each TEM word in the table of contents reflects the actual present or absence of this block.

Format 5 interpretation

This bit is set if and only if all TEMs have the diagnostic bit set. By definition, the state of the diagnostic bit must agree for all TEMs. If any TEM disagrees with the expected value, the event cannot be encoded as a format 5 event.

LSEP_RECHDR_BRIDGE_M

Typedef for enum _LSEP_RECHDR_BRIDGE_M.

The bridge byte is divided in 2 nibbles, the upper nibble is the public nibble where common definitions are put. The lower nibble is for private bits.

LSEP_ROOTHDR_BRIDGE_M

Typedef for enum _LSEP_ROOTHDR_BRIDGE_M.

The bridge byte is divided in 2 nibbles, the upper nibble is the public nibble where common definitions are put. The lower nibble is for private bits.

---

Enumeration Type Documentation

enum _LSEP_EVTTOC0_4_TEM_M

Enumeration of the in place masks of the fields in the TEM Table Of Contents word.

Enumerator:

LSEP_EVTTOC0_4_TEM_M_LEN	Size of the length field
LSEP_EVTTOC0_4_TEM_M_RSVD	Size of the reserved field
LSEP_EVTTOC0_4_TEM_M_ERRBLK	Size of the error block present/absent field
LSEP_EVTTOC0_4_TEM_M_DGNBLK	Size of the diagnosic block present/absent field
LSEP_EVTTOC0_4_TEM_M_NO_TKR	Size of the tracker data empty/non-empty field
LSEP_EVTTOC0_4_TEM_M_NO_CAL	Size of the calorimeter data empty field
LSEP_EVTTOC0_4_TEM_M_ABSENT	Size of the TEM absent/present field, if absent (1), then all other fields must be zero

enum _LSEP_EVTTOC0_4_TEM_S

Enumeration of the sizes of the fields in the TEM Table Of Contents word.

Enumerator:

LSEP_EVTTOC0_4_TEM_S_LEN	Size of the length field
LSEP_EVTTOC0_4_TEM_S_RSVD	Size of the reserved field
LSEP_EVTTOC0_4_TEM_S_ERRBLK	Size of the error block present/absent field
LSEP_EVTTOC0_4_TEM_S_DGNBLK	Size of the diagnosic block present/absent field
LSEP_EVTTOC0_4_TEM_S_NO_TKR	Size of the tracker data empty/non-empty field
LSEP_EVTTOC0_4_TEM_S_NO_CAL	Size of the calorimeter data empty field
LSEP_EVTTOC0_4_TEM_S_ABSENT	Size of the TEM absent/present field, if absent (1), then all other fields must be zero

enum _LSEP_EVTTOC0_4_TEM_V

Enumeration of the right justified bit offsets of the fields in the TEM Table Of Contents word.

Enumerator:

LSEP_EVTTOC0_4_TEM_V_LEN	Size of the length field
LSEP_EVTTOC0_4_TEM_V_RSVD	Size of the reserved field
LSEP_EVTTOC0_4_TEM_V_ERRBLK	Size of the error block present/absent field
LSEP_EVTTOC0_4_TEM_V_DGNBLK	Size of the diagnosic block present/absent field
LSEP_EVTTOC0_4_TEM_V_NO_TKR	Size of the tracker data empty/non-empty field
LSEP_EVTTOC0_4_TEM_V_NO_CAL	Size of the calorimeter data empty field
LSEP_EVTTOC0_4_TEM_V_ABSENT	Size of the TEM absent/present field, if absent (1), then all other fields must be zero

enum _LSEP_RECHDR_BRIDGE_M

The definition of the bridge word bits.

Enumerator:

LSEP_RECHDR_BRIDGE_M_ERR	Event record contains an event with errors
LSEP_RECHDR_BRIDGE_M_RSD	Event record contains result summary data
LSEP_RECHDR_BRIDGE_M_CHECKSUM	Event record contains a checksum
LSEP_RECHDR_BRIDGE_M_4_5_NOTACK	Format 4 and 5, gives the negative of the TACK bit
LSEP_RECHDR_BRIDGE_M_4_5_EXCBLK	Format 4 and 5 has exception block
LSEP_RECHDR_BRIDGE_M_5_CALTKR	Format 5 has word indicating missing CAL/TKR contributions

enum _LSEP_RECHDR_BRIDGE_V

Enumerator:

LSEP_RECHDR_BRIDGE_V_ERR	Event record contains an event with errors
LSEP_RECHDR_BRIDGE_V_RSD	Event record contains result summary data
LSEP_RECHDR_BRIDGE_V_4_5_NOTACK	Format 4 and 5, gives the negative of the TACK bit
LSEP_RECHDR_BRIDGE_V_4_5_EXCBLK	Format 4 and 5 has exception block
LSEP_RECHDR_BRIDGE_V_5_CALTKR	Format 5 has word indicating missing CAL/TKR contributions

enum _LSEP_ROOTHDR_BRIDGE_M

The definition of the bridge word bits for the LSEP root contribution.

Enumerator:

LSEP_ROOTHDR_BRIDGE_M_RSD

Root contribution includes summary data descriptor