MUONtrgda.cxx:

Update documentation lines; added README file
(Christian)

diff --git a/MUON/Doxymain.h b/MUON/Doxymain.h
index 463d2615fc99b80b6c133f4f19f5565ec58b7851..cd7fb200038ad349d4e8ac5a1ffc7a59923ec856 100644 (file)
--- a/MUON/Doxymain.h
+++ b/MUON/Doxymain.h
@@ -26,6 +26,7 @@ Currently there are the documentation pages on
 - \ref README_raw 
 - \ref README_mapping 
 - \ref README_mchda 
+- \ref README_mtrda 
 - \ref README_calib 
 - \ref README_geometry 
 - \ref README_trigger 

diff --git a/MUON/MUONTRGda.cxx b/MUON/MUONTRGda.cxx
index 16920db29cbb97fbdd4e08d192415d4885ef0d87..b99f5a9f55a7559cb58b26070d23853d5c3fc558 100644 (file)
--- a/MUON/MUONTRGda.cxx
+++ b/MUON/MUONTRGda.cxx
@@ -1,3 +1,22 @@
+/*
+Contact: Franck Manso <manso@clermont.in2p3.fr>
+Link: http://aliceinfo.cern.ch/static/Offline/dimuon/muon_html/README_mtrda.html
+Run Type:  ELECTRONICS_CALIBRATION_RUN (calib), DETECTOR_CALIBRATION_RUN (ped)
+DA Type: LDC
+Number of events needed: 100 events for ped and calib
+Input Files: Rawdata file (DATE format)
+Input Files from DB:
+MtgGlobalCrate-<version>.dat
+MtgRegionalCrate-<version>.dat
+MtgLocalMask-<version>.dat
+MtgLocalLut-<version>.dat
+MtgCurrent.dat
+
+Output Files: local dir (not persistent) 
+ExportedFiles.dat
+*/
+
+
 /*
 
 Version 2 for MUONTRGda MUON trigger
@@ -18,12 +37,12 @@ Working version for:
 November 2007
 Ch. Finck
 
-To be done:
+To be checked:
  Writing into the online database (need update of daqDAlib)
+To be done:
  Looking at scalers outputs
-
-
 */
+
 extern "C" {
 #include <daqDA.h>
 }

diff --git a/MUON/READMEmtrda.txt b/MUON/READMEmtrda.txt
new file mode 100644 (file)
index 0000000..e0693e0
--- /dev/null
+++ b/MUON/READMEmtrda.txt
@@ -0,0 +1,99 @@
+// $Id$
+
+/*! 
+
+\page README_mtrda Trigger DA
+ 
+The detector algorithm is implemented for the Muon Trigger in the AliRoot framework.
+The main code is located in MUONTRGda.cxx and it runs in the MUON Trigger LDC.
+
+\section da_s1 The Muon Trigger Calibration
+
+The main goal of the DA is the transfert of the modified configuration files to the FES.
+The configuration files stored in the online DB are the following:
+
+MtgGlobalCrate-<version>.dat:   contains the global crate information
+MtgRegionalCrate-<version>.dat: contains the regional crate information
+MtgLocalMask-<version>.dat:     contains the local mask
+MtgLocalLut-<version>.dat:      contains the local LUT 
+MtgCurrent.dat:                 contains the name list of the above files with their version 
+                                and the flag for master/slave status on the DA
+
+The copy onto the FES for the modified local masks is only done when the flag is set to master for the DA.
+The DA creates a file (ExportedFiles.dat) containing the name of the files to be transfert by the shuttle.
+To be able to check the change of version of one the files, another file is created containing the last current
+list of configuration files: MtgLastCurrent.dat.
+The Muon trigger electronics could run with two types of calibration:
+
+\subsection da_ss1  ELECTRONICS_CALIBRATION_RUN (calib)
+
+This procedure allows to check dead channels. The FET pulses are injected to the 21 kchannels.
+
+The typical ECS sequence for calib is :
+
+- Switch ON the electronics LV
+- Load Configuration via the MTS package
+- Enable FET pulse 
+- Data taking (typically 100 events)
+- The DA computes the occupancy, if a channel is not responding in 80% of the case, it will be marked as dead 
+- The DA update the local mask file accordingly and put it on the File Exchange Server
+
+Then the SHUTTLE process the ASCII files and store the configuration on the OCDB
+
+This option is disable for the moment.
+
+\subsection da_ss2  DETECTOR_CALIBRATION_RUN (ped)
+
+This procedure checks the noisy channels. A normal physics run is performed.
+
+The typical ECS sequence for calibration is :
+
+- Switch ON the electronics LV
+- Load Configuration via the MTS package
+- Data taking (typically 100 events)
+- The DA computes the occupancy, if a channel is responding in 80% of the case, it will be marked as noisy
+- The DA update the local mask file accordingly and put it on the File Exchange Server
+
+Then the SHUTTLE process the ASCII files and store the configuration on the OCDB
+
+\section da_s2 Using the DA Online
+
+You have a line command help. To have it just type :
+
+\verbatim
+> MUONTRGda.exe -h
+
+******************* MUONTRGda.exe usage **********************
+MUONTRGda.exe -options, the available options are :
+-h help                   (this screen)
+
+ Input
+-f <raw data file>        (default = )
+
+ output
+-r <root file>            (default = none)
+
+ Options
+-t <threshold values>     (default = 0.2)
+-d <print level>          (default = 0)
+-s <skip events>          (default = 0)
+-n <max events>           (default = 1000000)
+-e <execute ped/calib>    (default = nil)
+
+\endverbatim
+
+ 
+\section da_s3 In case of trouble
+
+Please contact:
+
+Franck Manso: manson@clermont.in2p3.fr
+
+or 
+
+Christian Finck: finck@subatech.in2p3.fr (until 01 Septembre 08)
+
+
+This chapter is defined in the READMEmtrda.txt file.
+*/
+