ECAL calibration functions &
programs
(phase 5)
This document covers the usage of ECAL calibration programs
(which write the Look-Up Table file and download it to Front End Driver
boards), and of the ECAL calibration functions:
-
float adc2e(int adc,int ch,cal_t *cal_param)
-
int e2adc(float e,int ch,cal_t *cal_param)
-
int calib_read(cal_t *cal_param,char *filename)
defined in files:
-
calib.h
-
calib_read.c
-
conversions.c
User Interface
NAME
lut_w - write the FED boards
Look-Up Table file
SYNOPSIS
lut_w -h | -v
lut_w -p pt (GeV) [-n runn][-z]
lut_w -e E (GeV) [-n runn][-z]
lut_w -r ch [-z]
lut_w -c ch [-n runn][-z]
OPTIONS
-h
display help message
-v
display the version number
-p pt set pt threshold
to pt
-e E set
energy to E
-r ch set channel
threshold to ch (no pedestal subtraction)
-c ch set channel
threshold to ch (with pedestal subtraction)
-n runn read pedestals from
run runn
-z
produce ready-to-download gzipped LUT-file. This also save time and
space (a factor of 4 in time on a CETIA)
FILES
calib.dat Opened for reading.
Contains the experimental data used to calibrate.
pedestal_r<runn>.dat Opened
for reading only if -n option is specified. Contains experimental pedestals
measured in run number <runn>.
geomet.dat Opened for reading.
Contains geometrical informations.
.ecal_lutrc.<hostname>.<type>.<value>[.<runn>][.gz]
Opened for writing. Contains the data to be downloaded to
FED boards (using ecal_init program). <type> is equal to option letters.
<value> is pt (-p option) E (-e option) ch (-r or -c option). <runn>
is present only if option -n has been chosen.".gz" is appended if the output
file is gzipped (option -z).
NAME
ecal_init - initialize ECAL
Front End Driver board,
download FED-format header data and Look-Up Table
LOCATION OF FILES
Executable file:
hb-vme11:/home/hb-ecal/pro/ecal_init/ecal_init
Source file:
hb-vme11:/home/hb-ecal/pro/ecal_init/ecal_init.c
Sample Resource Configuration File:
hb-vme11:/home/hb-ecal/pro/ecal_init/.ecal_initrc.hb-vme11
LAST REVISION
bash> ident ecal_init | grep ecal_init
ecal_init: $Header: ecal_init.c,v 2.1 1998/07/30 10:06:38
galli Exp galli $
SYNOPSIS
ecal_init [-h] [-f lut_file] [-t testPoint] [-a acDac] [-d dac_level]
[-n|-l]
OPTIONS
Command line options override Resource Configuration file (.ecal_initrc.<hostname>)
options.
-h
display this message
-l
force load LUT file
-n
force do not load LUT file
-f lut_file force lut_file as the name of gzipped LUT
file
(default: .ecal_lutrc.<hostname>.gz)
-t testPoint force DAC level generator excluded [0] or inserted
[1]
-a acDac force DAC pulsed [1] or
continuous [0]
-d dac_level force DAC level
DESCRIPTION
-
verifies the existence of the FED boards at the specified VME addresses
(with bus error trap). In case of error prints a message and continue.
-
set FED-format header data (FED block length, Record ID, Component
ID, FED ID)
-
set DAC level
-
download gzipped Look-Up Table file. ecal_init loads this file by forking
a gunzip process and putting its output in a pipe to ecal_init stdin. Load
time for 6 boards is about 6 seconds (compare with 21 seconds needed toload
the file not gzipped).
-
reset the boards
EXIT VALUE
0 succesful completion
1 error detected by ecal_init program
itself
errno other errors
FILES
.ecal_initrc.<hostname> ecal_init
Resource Configuration file. Opened for reading.
tipical Resource Configuration file contains the following entries:
NCRATE <ordinal
number of this crate>
NBOARD <number
of FED boards installed on this crate>
BOARD_ADDRS <2 most significant hex-digit
of 32-bit vme address> ...
R_ID
<record-ID>
R_ID_ERR <error record-ID>
C_ID
<component-ID>
TEST_POINT (0 if AC/DC DAC should
be excluded, 1 if it should be inserted)
AC_DAC (1
if DAC should be pulsed, 0 if DAC should de continuous)
DAC_LEVEL <level of Digital
to Analog Convert>
DO_LUT_LOAD (1 if LUT should be loaded,
0 otherwise)
LUT_FILE_PREFIX <prefix to be used in LUT file name generation>
Comments are allowed with a # in the first column. Record order is
not ignored.
Example:
NCRATE 0
NBOARD 6
BOARD_ADDRS 0x10 0x11 0x12 0x13 0x14 0x15
R_ID
0x1000
R_ID_ERR 0x9000
C_ID
0x700
TEST_POINT 0
AC_DAC 0
DAC_LEVEL 50
DO_LUT_LOAD 1
LUT_FILE_PREFIX ecal_lutrc
.<LUT_FILE_PREFIX>.<hostname>.gz
gzipped LUT file. Opened for reading. Contains the data to be downloaded
to FED boards. Generated by lut_w program.
ecal_init.<hostname>.log log-file.
Opened for output. Contains detailed debugging informations.
Application Program Interface
NAME
adc2e() - get the energy
from ADC level
SYNOPSIS
#include "calib.h"
float adc2e(int adc,int ch,cal_t *cal_param);
ARGUMENTS
adc ADC level (pedestal-subtracted) in channels (0<=adc<4096)
ch ADC unit # (0<=ch<192)
*cal_param pointer to calibration structure got through
calib_read() function
RETURN VALUE
the float value of Energy
DECRIPTION
adc2e() returns float energy value, given the number ch of the
ADC unit and the ADC level adc. It uses linear interpolation
and extrapolarion.
adc2e() should be used only when cal_param structure has been defined
and filled by calib_read() function.
NAME
e2adc() - get the ADC level
from the energy
SYNOPSIS
#include "calib.h"
int e2adc(float e,int ch,cal_t *cal_param);
ARGUMENTS
e float value of Energy
ch ADC unit # (0<=ch<192)
*cal_param pointer to calibration structure got through
calib_read() function
RETURN VALUE
ADC level (pedestal-subtracted) in channels (0<=e2adc()<4096)
DECRIPTION
e2adc() returns integer ADC level (measured in channels), given
the float value of energy and the number ch of the ADC unit. It uses linear
interpolation and extrapolation. e2adc() should be used only when cal_param
structure has been defined and filled by calib_read() function.
NAME
calib_read() - read calibration
file and fills cal_param structure
SYNOPSIS
#include "calib.h"
int calib_read(cal_t *cal_param,char *filename);
RETURN VALUE
Upon successful completion, calib_read() returns 0. Otherwise,
returns -1 (Can't open calibration file)
DECRIPTION
calib_read() functions fills the cal_param data structure with
the values retrieved in the file filename. Then it tries to correct missing
values in ADC arrays using interpolation or extrapolation.
Usage
To use the functions a2adc() & adc2e(), you should:
-
include in your program the header: calib.h
-
declare a (structure) variable of type: cal_t
-
call - one time - the calib_read() function
-
call as many time as you want adc2e() and e2adc()
functions.
Example
#include <stdio.h>
#include "calib.h"
void main(int argc,char**argv)
{
cal_t cal_param;
int ch_value,adc_value;
float e_value;
calib_read(&cal_param,"calib.dat");
for(ch_value=0;ch_value<NCH;ch_value++)
{
printf("channel: %d\n",ch_value);
for(adc_value=0;adc_value<ADC_MAX;adc_value++)
{
e_value=adc2e(adc_value,ch_value,&cal_param);
printf("%i %i %e\n",ch_value,adc_value,e_value);
}
}
}
Sample ADC transferring function (e2adc)
Sample ADC inverse transferring function (adc2e)
Domenico Galli
Thursday July 30, 1998