CALIB_DB_schema.h File Reference

Lays out the common portion of all calibration databases. More...

#include <CAL_DB/CALIB_DB_schema.h>

Classes
struct	_CALIB_DB_schema_hdr
	Encapsulates information common to all calibration schemas. More...
Typedefs
typedef enum _CALIB_DB_SCHEMA_BASE_K	CALIB_DB_SCHEMA_BASE_K
	Typedef for enum _CALIB_DB_SCHEMA_BASE_K.
typedef enum _CALIB_DB_SUBSYSTEM_K	CALIB_DB_SUBSYSTEM_K
	Typedef for enum _CALIB_DB_SUBSYSTEM_K.
typedef enum _CALIB_DB_TYPE_K	CALIB_DB_TYPE_K
	Typedef for enum _CALIB_DB_TYPE_K.
typedef enum _CALIB_DB_ORIGIN_K	CALIB_DB_ORIGIN_K
	Typedef for enum _CAL_DB_ORIGIN_K.
typedef enum _CALIB_DB_STYLE_K	CALIB_DB_STYLE_K
	Typedef for enum _CALIB_DB_STYLE_K.
typedef struct _CALIB_DB_schema_hdr	CALIB_DB_schema_hdr
	Typedef of struct _CALIB_DB_schema_hdr.
Enumerations
enum	_CALIB_DB_SCHEMA_BASE_K {   CALIB_DB_SCHEMA_BASE_K_ACD = 0xc0,   CALIB_DB_SCHEMA_BASE_K_CAL = 0xd0,   CALIB_DB_SCHEMA_BASE_K_TKR = 0xe0 }
	Enumeration of the base schema numbers of the three subsystems. More...
enum	_CALIB_DB_SUBSYSTEM_K {   CALIB_DB_SUBSYSTEM_K_UNDEFINED = 0,   CALIB_DB_SUBSYSTEM_K_ACD = 1,   CALIB_DB_SUBSYSTEM_K_CAL = 2,   CALIB_DB_SUBSYSTEM_K_TKR = 3 }
	Enumerates the subsystem of database (i.e. ACD, CAL, TKR). More...
enum	_CALIB_DB_TYPE_K {   CALIB_DB_TYPE_K_PEDESTALS = 1,   CALIB_DB_TYPE_K_GAINS = 2,   CALIB_DB_TYPE_K_COMBINED = 3 }
	Enumerates the type of database, i.e. pedestals only, gains only or combined. More...
enum	_CALIB_DB_ORIGIN_K {   CALIB_DB_ORIGIN_K_ON_ORBIT = 0,   CALIB_DB_ORIGIN_K_GLEAM = 1,   CALIB_DB_ORIGIN_K_PRELAUNCH = 2 }
	Enumerates the originating source of calibration data. More...
enum	_CALIB_DB_STYLE_K {   CALIB_DB_STYLE_K_FULL = 0,   CALIB_DB_STYLE_K_IDEALIZED = 1 }
	Enumerates the type of calibration data. More...

---

Detailed Description

Lays out the common portion of all calibration databases.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: CALIB_DB_schema.h,v 1.5 2011/03/25 02:40:52 apw Exp $

Warning:

This is one of the few packages in CAL_DB where the CAL_DB prefix may refer to the package and not to the CALorimeter specific database. The word may is important. Currently there are the only references are to CALorimeter objects. However there are some generalizable concepts in here that could be applied to ACD and TKR databases. However until the need for these arises, I am going to avoid making a commitment on the off chance that the ACD and TKR bring some new specialized functionality that does not fit this mold. It is also possible that it is a bad idea to mix the subsystems in one package.

If I decide to break out separate packages for the subsystems any commonality will be moved to a new package, CALIB_DB. Concepts in this file that are truly subsystem-wide concepts are prefixed with CALIB_DB, not CAL_DB in anticipation of these eventuality.

---

Typedef Documentation

CALIB_DB_ORIGIN_K

Typedef for enum _CAL_DB_ORIGIN_K.

The origin of the calibration refers to the point of origination of of the calibration constants. For example, two common originating points would be constants that have been made-up for use by the GLEAM Monte Carlo program and constants that have been calculated using data from on-orbit calibrations.

In general, different calibration from different originating sources should be kept in different packages. The reasoning is that time evolution is unique within a origination type. For example, constants used in the GLEAM Monte Carlo get updated or changed on a different schedule than thus from the actual LAT. Since it likely that different people will manage the updating of constants associated with a origin, they should be kept separate

CALIB_DB_SCHEMA_BASE_K

Typedef for enum _CALIB_DB_SCHEMA_BASE_K.

Note:

This is a subsystem-wide concept, so is given the prefix CALIB.

CALIB_DB_STYLE_K

Typedef for enum _CALIB_DB_STYLE_K.

The type of the calibration refers to how the calibration constants are presented The program that converts the input constants into the form usable by FSW will use the style in determining the form of the input values.

This number may be stored in the output data structure, but likely serves only an informational purpose.

CALIB_DB_SUBSYSTEM_K

Typedef for enum _CALIB_DB_SUBSYSTEM_K.

Note:

This is a subsystem-wide concept, so is given the prefix CALIB.

---

Enumeration Type Documentation

enum _CALIB_DB_ORIGIN_K

Enumerates the originating source of calibration data.

Enumerator:

CALIB_DB_ORIGIN_K_ON_ORBIT	Origin is ON ORBIT calibrations
CALIB_DB_ORIGIN_K_GLEAM	Origin is GLEAM Monte Carlo
CALIB_DB_ORIGIN_K_PRELAUNCH	Origin is PRELAUNCH calibrations

enum _CALIB_DB_SCHEMA_BASE_K

Enumeration of the base schema numbers of the three subsystems.

Enumerator:

CALIB_DB_SCHEMA_BASE_K_ACD	Base schema number for the ACD
CALIB_DB_SCHEMA_BASE_K_CAL	Base schema number for the CAL
CALIB_DB_SCHEMA_BASE_K_TKR	Base schema number for the TKR

enum _CALIB_DB_STYLE_K

Enumerates the type of calibration data.

Enumerator:

CALIB_DB_STYLE_K_FULL	Full pedestals and gains
CALIB_DB_STYLE_K_IDEALIZED	Idealized pedestals and gains

enum _CALIB_DB_SUBSYSTEM_K

Enumerates the subsystem of database (i.e. ACD, CAL, TKR).

Enumerator:

CALIB_DB_SUBSYSTEM_K_UNDEFINED	Subsystem is undefined
CALIB_DB_SUBSYSTEM_K_ACD	Subsystem is the ACD
CALIB_DB_SUBSYSTEM_K_CAL	Subsystem is the CAL
CALIB_DB_SUBSYSTEM_K_TKR	Subsystem is the TKR

enum _CALIB_DB_TYPE_K

Enumerates the type of database, i.e. pedestals only, gains only or combined.

Enumerator:

CALIB_DB_TYPE_K_PEDESTALS	Pedestal only database
CALIB_DB_TYPE_K_GAINS	Gain only database
CALIB_DB_TYPE_K_COMBINED	Combined pedestal and gain database