The CFM database

In TWIST, the official CFM database resides on the Twist cluster in the directory $CFM_DB --> /home/e614/e614soft/cfm/db_noswap
It contains 3 database files defining which calibration files to use for every data run and one log file
  1. ctf.dat    defines what TYPES of calibration are used
  2. crf.dat    defines what calibration "dataset" is used for each run
  3. cif.dat    defines what version of the calibration files to use for a given "dataset"
  4. cfm.record     keeps a log of every changes entered in the database including the date and the name of the person who submitted the change
Modifications of these database files is done via the interactive program "cfm"  which should be invoked ONLY from account e614 on any of the Triumf TWIST cluster machines.Usually only experts modify the database files.
All remote institutions are asked to synchronise their versions of the database file via the rsync  mechanism.

You can also examine what were the latest changes to the database by looking the bottom of the file $CFM_DB/cfm.record
 

Examining the CFM database

Anyone can examine the contents of the CFM database using the program "cfm."  opening the files in the "READ" mode. This is a line oriented interactive program.
If you do not know the commands, just type "help" at the command prompt or see "Using CFM" below.

The calibration files

The calibration files themselves reside in the directory $CAL_DB --> /home/e614/e614soft/caldb_ascii
The file names are made of two fields and one index number: ex: fbc1_map.00024
The two fields "fbc1_map" represent the calibration TYPE and the index number identifies the version number used for a particular "dataset" of runs. Usually the files should start with some comments defining what is peculiar to this file and what set of runs it applies to.

Using CFM

(Extracted from the TWIST Mofia Manual.)

TWIST also adopted the Calibration File Manager (CFM) developed for BNL experiment E787. CFM allows the user to associate run numbers with calibration files. Calibration types (plane position corrections, wire position corrections, etc) may be defined through CFM. For example, DC_PPC defines the calibration type for the Drift Chamber Plane Position Corrections. CFM allows up to 5 characters to identify a component (Drift Chamber, DC, in this case) and up to 3 characters to identify its attributes (Plane Position Corrections, PPC). The file name for a calibration type has the form XXXXX_YYY.NNNNN where NNNNN is a 5-digit (version) number called an indicator. For example dc_ppc.00001 is a PPC file name with indicator number equal to 1. CFM is then asked to associate a run number, or a group of runs with indicator 1 for the calibration type DC_PPC. When MOFIA is run it checks the run number and obtains the indicator number and the file name for each calibration type from CFM. CFM expects all calibration files to reside in the directory defined by the environment variable CAL_DB. All calibration files are in ascii format which allows the user to easily display and edit their contents. To run CFM type CFM (outside MOFIA). Commands may be issued at the CFM command line to view the contents of CFM or modify and change the existing information. The help command provides the user with online help.

Three CFM commands are handy for viewing the contents of CFM and are worth mentioning here. The command show types displays the calibration types defined in CFM as shown in the example below:

CFM>show types
  1:DC_PPC     2:DC_WPC     3:DC_RES     4:DC_PRC     5:DT_GEO     6:FBC1_MAP 
  7:FBC2_MAP   8:FBC3_MAP   9:DC_PZC    10:DC_WZC    11:DC_WRC    12:DC_STR   
 13:PC_T0     14:DC_T0     15:SC_T0     16:PC_ADC    17:SC_ADC    18:PC_STR   
 19:BFLD_MAP

These calibration files are described in Table 1. Another useful command is show set n (where n equals the desired set number). This command will show the run numbers associated with set n as well as the calibration file names associated with set n as shown in the example below:

CFM>show set 15
-------------------------------------------------------------------------------
CDF Set  Run Total  Run Range
-------  ---------  ---------
   15          0    

CDF Names:

   DC_PPC.00003    DC_RES.00004    DC_WRC.00003  FBC2_MAP.00018     PC_T0.00004 
 BFLD_MAP          DC_STR.00010    DC_WZC.00003  FBC3_MAP          SC_ADC.00001 
   DC_PRC.00003     DC_T0.00006    DT_GEO.00024    PC_ADC.00001     SC_T0.00013 
   DC_PZC.00003    DC_WPC.00003  FBC1_MAP.00018    PC_STR                       

NB: Blank file extensions ==> no CDF associated with CDT
-------------------------------------------------------------------------------

Type Number

Type

Description

1

DC_PPC

Drift chamber UV plane position corrections

2

DC_WPC

Drift chamber UV wire position corrections

3

DC_RES

Drift chamber resolution parameters

4

DC_PRC

Drift chamber plane rotation corrections

5

DT_GEO

Detector Geometry

6

FBC1_MAP

Mapping file for first FASTBUS crate

7

FBC2_MAP

Mapping file for second FASTBUS crate

8

FBC3_MAP

Mapping file for third FASTBUS crate

9

DC_PZC

Drift chamber plane Z position corrections

10

DC_WZC

Drift chamber wire Z position corrections

11

DC_WRC

Drift chamber wire rotation corrections

12

DC_STR

Drift chamber space-time relations

13

PC_T0

Proportional chambers time zero

14

DC_T0

Drift chambers time zero

15

PC_T0

Proportional chambers

16

PC_ADC

Proportional chambers ADC calibrations

17

SC_ADC

Scintillators ADC calibrations

Table 1 Calibration types currently installed in the Calibration File Manager (CFM).

When a set is displayed with no indicator number (as in FBC3_MAP in the example above) it means that although the type has been defined, no file has been associated with it for the set displayed. The command show set (with no set number provided) displays all sets currently defined in CFM. Finally the command show runs shows which runs are associated with the different sets as in the example below:

CFM>show runs
      Runs       Total  CDF Set
-------------------------------
     1 :     4       4        1
     5 :     6       2        2
     7 :   499     493        3
   500 :   800     301        4
   801 :   922     122        5
   923 :   924       2        6
   925 :   932       8        7
   933 :   955      23        8
      956            1        9
   957 :  1311     355        8
  1312 :  1693     382       12
  1694 :  2499     806       13
  2500 :  2599     100       19
  2600 :  3296     697       25
  3297 :  3359      63       26
  3360 :  4222     863       20
  4223 :  4225       3       21
  4226 :  4229       4       19
  4230 :  4231       2       22
  4232 :  4238       7       23
  4239 :  4406     168       24
  4407 :  4449      43       19
  4450 :  4549     100       30
  4550 :  4951     402       27
  4952 :  5042      91       28
  5043 :  5054      12       32
  5055 :  5186     132       29
  5187 :  5310     124       33
  5311 :  5337      27       34
  5338 :  5528     191       31
  5529 :  5701     173       35
  5702 :  5806     105       36
  5807 :  6836    1030       37
  6837 : 25000    ****       38