GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > CAL_DB / V0-0-1

Constituent: cal_db_pedestals_create     Tag: sun-gcc

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » CDM » source » CAL_DB » V0-0-1 » CAL_DB

CAL_DB_schema.h File Reference

Lays ouf the CAL calibration database. More...

This graph shows which files directly or indirectly include this file:


Data Structures

struct  _CAL_DB_schema_hdr
 Encapsulates information common to all CAL_DB schemas. More...

Defines

#define CAL_DB_SCHEMA(_type)   (CALIB_DB_SCHEMA_BASE_K_CAL | (_type))
 Macro to compose the full CAL_DB schema identifier for the various databases (by subsystem and type).

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 _CAL_DB_TYPE_K CAL_DB_TYPE_K
 Typedef for enum _CAL_DB_TYPE_K.
typedef enum _CAL_DB_ORIGIN_K CAL_DB_ORIGIN_K
 Typedef for enum _CAL_DB_ORIGIN_K.
typedef enum _CAL_DB_STYLE_K CAL_DB_STYLE_K
 Typedef for enum _CAL_DB_STYLE_K.
typedef enum _CAL_DB_SCHEMA_K CAL_DB_SCHEMA_K
 Typedef for enum _CAL_DB_SCHEMA_K.
typedef _CAL_DB_schema_hdr CAL_DB_schema_hdr
 Typedef of struct _CAL_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  _CAL_DB_TYPE_K {
  CAL_DB_TYPE_K_PEDESTALS = 1,
  CAL_DB_TYPE_K_GAINS = 2,
  CAL_DB_TYPE_K_COMBINED = 3
}
 Enumerates the type of database, i.e. pedestals only, gains only or combined. More...
enum  _CAL_DB_ORIGIN_K {
  CAL_DB_ORIGIN_K_ON_ORBIT = 0,
  CAL_DB_ORIGIN_K_GLEAM = 1,
  CAL_DB_ORIGIN_K_PRELAUNCH = 2
}
 Enumerates the originating source of calibration data. More...
enum  _CAL_DB_STYLE_K {
  CAL_DB_STYLE_K_FULL = 0,
  CAL_DB_STYLE_K_IDEALIZED = 1
}
 Enumerates the type of calibration data. More...
enum  _CAL_DB_SCHEMA_K {
  CAL_DB_SCHEMA_K_PEDESTALS = CAL_DB_SCHEMA(CAL_DB_TYPE_K_PEDESTALS),
  CAL_DB_SCHEMA_K_GAINS = CAL_DB_SCHEMA(CAL_DB_TYPE_K_GAINS),
  CAL_DB_SCHEMA_K_COMBINED = CAL_DB_SCHEMA(CAL_DB_TYPE_K_COMBINED)
}
 Forms the database primary key. More...

Detailed Description

Lays ouf the CAL calibration database.

Author:
JJRussell - russell@slac.stanford.edu
   CVS $Id: CAL_DB_schema.h,v 1.1.1.1 2005/08/01 20:52:48 russell 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.

Define Documentation

#define CAL_DB_SCHEMA (  _type   )     (CALIB_DB_SCHEMA_BASE_K_CAL | (_type))
 

Macro to compose the full CAL_DB schema identifier for the various databases (by subsystem and type).

Returns:
The full CAL_DB schema identifier
Parameters:
_type The CAL_DB schema type, i.e identifies a pedestal only, gains only or combined data base. This should be one of the CAL_DB_TYPE_K_'s
Warning:
This is an 'internal' only macro and should not be used by external users. Rather use the enumerated values defined in CAL_DB_SCHEMA_K.

Typedef Documentation

CAL_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

CAL_DB_STYLE_K
 

Typedef for enum _CAL_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_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_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 _CAL_DB_ORIGIN_K
 

Enumerates the originating source of calibration data.

Enumerator:
CAL_DB_ORIGIN_K_ON_ORBIT  Origin is ON ORBIT calibrations
CAL_DB_ORIGIN_K_GLEAM  Origin is GLEAM Monte Carlo
CAL_DB_ORIGIN_K_PRELAUNCH  Origin is PRELAUNCH calibrations

enum _CAL_DB_SCHEMA_K
 

Forms the database primary key.

Enumerator:
CAL_DB_SCHEMA_K_PEDESTALS  Calorimeter pedestal database
CAL_DB_SCHEMA_K_GAINS  Calorimeter gains database
CAL_DB_SCHEMA_K_COMBINED  Calorimeter combined pedestals and gains database

enum _CAL_DB_STYLE_K
 

Enumerates the type of calibration data.

Enumerator:
CAL_DB_STYLE_K_FULL  Full pedestals and gains
CAL_DB_STYLE_K_IDEALIZED  Idealized pedestals and gains

enum _CAL_DB_TYPE_K
 

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

Enumerator:
CAL_DB_TYPE_K_PEDESTALS  Pedestal only database
CAL_DB_TYPE_K_GAINS  Gain only database
CAL_DB_TYPE_K_COMBINED  Combined pedestal and gain database

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_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

Generated on Fri Dec 9 20:27:39 2005 by  doxygen 1.4.4