doxy: TPC/DA
authordberzano <dario.berzano@cern.ch>
Tue, 3 Feb 2015 17:12:21 +0000 (18:12 +0100)
committerdberzano <dario.berzano@cern.ch>
Tue, 10 Feb 2015 15:21:10 +0000 (16:21 +0100)
TPC/DA/TPCCEda.cxx
TPC/DA/TPCCEnewda.cxx
TPC/DA/TPCPEDESTALda.cxx
TPC/DA/TPCPULSERda.cxx
TPC/DA/TPCQAda.cxx
TPC/DA/TPCRAWda.cxx
doxygen/Doxyfile.in

index f805f62..6083e2e 100644 (file)
@@ -1,33 +1,26 @@
-/*
-TPC DA for online calibration
-
-Contact: Haavard.Helstrup@cern.ch
-Link: 
-Run Type: PHYSICS STANDALONE DAQ
-DA Type: MON
-Number of events needed: 500
-Input Files: 
-Output Files: tpcCE.root, to be exported to the DAQ FXS
-fileId:   CE
-Trigger types used: PHYSICS_EVENT
-
-*/
-
-/*
-
-TPCCEda.cxx - calibration algorithm for TPC Central Electrode events
-
-10/06/2007  sylvain.chapeland@cern.ch :  first version - clean skeleton based on DAQ DA case1
-06/12/2007  haavard.helstrup@cern.ch  :  created CE DA based on pulser code
-19/09/2008  J.Wiechula@gsi.de:           Added support for configuration files.
-
-contact: marian.ivanov@cern.ch
-
-
-This process reads RAW data from the files provided as command line arguments
-and save results in a file (named from RESULT_FILE define - see below).
-
-*/
+/// \file TPCCEda.cxx
+/// \brief calibration algorithm for TPC Central Electrode events
+///
+/// TPC DA for online calibration
+/// 
+/// Contact: Haavard.Helstrup@cern.ch
+/// Link: 
+/// Run Type: PHYSICS STANDALONE DAQ
+/// DA Type: MON
+/// Number of events needed: 500
+/// Input Files: 
+/// Output Files: tpcCE.root, to be exported to the DAQ FXS
+/// fileId:   CE
+/// Trigger types used: PHYSICS_EVENT
+///
+/// 10/06/2007  sylvain.chapeland@cern.ch :  first version - clean skeleton based on DAQ DA case1
+/// 06/12/2007  haavard.helstrup@cern.ch  :  created CE DA based on pulser code
+/// 19/09/2008  J.Wiechula@gsi.de:           Added support for configuration files.
+///
+/// \author marian.ivanov@cern.ch
+///
+/// This process reads RAW data from the files provided as command line arguments
+/// and save results in a file (named from RESULT_FILE define - see below).
 
 #define RESULT_FILE "tpcCE.root"
 #define FILE_ID "CE"
@@ -82,11 +75,11 @@ void SendToAmoreDB(AliTPCCalibCE *calibCE, unsigned long32 runNb);
 //for threaded processing
 
 
-/* Main routine
-      Arguments: list of DATE raw data files
-*/
 int main(int argc, char **argv) {
-  /* log start of process */
+  /// Main routine
+  /// Arguments: list of DATE raw data files
+
+  // log start of process
   printf("TPCCEda: DA started - %s\n",__FILE__);
   
   if (argc<2) {
index 26a4b96..190f540 100644 (file)
@@ -1,33 +1,25 @@
-/*
-TPC DA for online calibration
-
-Contact: Haavard.Helstrup@cern.ch
-Link: 
-Run Type: PHYSICS STANDALONE DAQ
-DA Type: MON
-Number of events needed: 500
-Input Files: 
-Output Files: tpcCE.root, to be exported to the DAQ FXS
-fileId:   CEnew
-Trigger types used: PHYSICS_EVENT
-
-*/
-
-/*
-
-TPCCEda.cxx - calibration algorithm for TPC Central Electrode events
-
-10/06/2007  sylvain.chapeland@cern.ch :  first version - clean skeleton based on DAQ DA case1
-06/12/2007  haavard.helstrup@cern.ch  :  created CE DA based on pulser code
-19/09/2008  J.Wiechula@gsi.de:           Added support for configuration files.
-
-contact: marian.ivanov@cern.ch
-
-
-This process reads RAW data from the files provided as command line arguments
-and save results in a file (named from RESULT_FILE define - see below).
-
-*/
+/// \class TPCCEnewda
+/// \brief TPC DA for online calibration
+///
+/// Link:
+/// Run Type: PHYSICS STANDALONE DAQ
+/// DA Type: MON
+/// Number of events needed: 500
+/// Input Files:
+/// Output Files: tpcCE.root, to be exported to the DAQ FXS
+/// fileId:   CEnew
+/// Trigger types used: PHYSICS_EVENT
+///
+/// TPCCEda.cxx - calibration algorithm for TPC Central Electrode events
+///
+/// 10/06/2007  sylvain.chapeland@cern.ch :  first version - clean skeleton based on DAQ DA case1
+/// 06/12/2007  haavard.helstrup@cern.ch  :  created CE DA based on pulser code
+/// 19/09/2008  J.Wiechula@gsi.de:           Added support for configuration files.
+///
+/// This process reads RAW data from the files provided as command line arguments
+/// and save results in a file (named from RESULT_FILE define - see below).
+///
+/// \author marian.ivanov@cern.ch
 
 #define RESULT_FILE "tpcCEnew.root"
 #define FILE_ID "CEnew"
@@ -83,11 +75,11 @@ void SendToAmoreDB(AliTPCCalibCE &calibCE, unsigned long32 runNb);
 //for threaded processing
 
 
-/* Main routine
-      Arguments: list of DATE raw data files
-*/
 int main(int argc, char **argv) {
-  /* log start of process */
+  /// Main routine
+  /// Arguments: list of DATE raw data files
+
+  // log start of process
   printf("TPCCEda: DA started - %s\n",__FILE__);
   
   if (argc<2) {
index 8293a74..a173791 100644 (file)
@@ -1,41 +1,36 @@
-/*
-TPC DA for online calibration
-
-Contact: Haavard.Helstrup@cern.ch
-Link:
-Run Type: PEDESTAL
-DA Type: LDC
-Number of events needed: 100
-Input Files: 
-Output Files: tpcPedestal.root, to be exported to the DAQ FXS
-fileId:   pedestals    
-Trigger types used: CALIBRATION_EVENT
-
-*/
-
-/*
-
-TPCda_pedestal.cxx - calibration algorithm for TPC pedestal runs
-
-10/06/2007  sylvain.chapeland@cern.ch :  first version - clean skeleton based on DAQ DA case1
-19/10/2007  christian.lippmann@cern.ch :  Possibility to write output to ASCII file
-24/10/2007  christian.lippmann@cern.ch :  Including pedestal calibration for time bins
-23/11/2007  christian.lippmann@cern.ch :  Fix in order to avoid streamer problems in case of
-                                          invalid ROOTSTYS. The famous magic line provided by Rene.
-28/11/2007  christian.lippmann@cern.ch :  TPC mapping file is read from DaqDetDB
-18/09/2008  christian.lippmann@cern.ch :  Noisy channels are output to ASCII file. Use max noise in ALTRO.
-19/09/2008  J.Wiechula@gsi.de:            Added export of the calibration data to the AMORE data base.
-                                          Added support for configuration files.
-31/01/2011  Christian.Lippmann@cern.ch :  Updates for changed setup at P2 with 2 LDCs per sector
-26/09/2014  Christian.Lippmann@cern.ch :  Updates for changed setup at P2 1 CRORC per LDC
-26/09/2014  Jens.Wiechula@cern.ch      :  comment out obsolete AliTPCRawStream
-
-contact: marian.ivanov@cern.ch
-
-This process reads RAW data from the files provided as command line arguments
-and save results in a file (named from RESULT_FILE define - see below).
-
-*/
+/// \file TPCPEDESTALda.cxx
+///
+/// TPC DA for online calibration
+/// 
+/// Contact: Haavard.Helstrup@cern.ch
+/// Link:
+/// Run Type: PEDESTAL
+/// DA Type: LDC
+/// Number of events needed: 100
+/// Input Files: 
+/// Output Files: tpcPedestal.root, to be exported to the DAQ FXS
+/// fileId:   pedestals    
+/// Trigger types used: CALIBRATION_EVENT
+/// 
+/// TPCda_pedestal.cxx - calibration algorithm for TPC pedestal runs
+/// 
+/// 10/06/2007  sylvain.chapeland@cern.ch :  first version - clean skeleton based on DAQ DA case1
+/// 19/10/2007  christian.lippmann@cern.ch :  Possibility to write output to ASCII file
+/// 24/10/2007  christian.lippmann@cern.ch :  Including pedestal calibration for time bins
+/// 23/11/2007  christian.lippmann@cern.ch :  Fix in order to avoid streamer problems in case of
+///                                           invalid ROOTSTYS. The famous magic line provided by Rene.
+/// 28/11/2007  christian.lippmann@cern.ch :  TPC mapping file is read from DaqDetDB
+/// 18/09/2008  christian.lippmann@cern.ch :  Noisy channels are output to ASCII file. Use max noise in ALTRO.
+/// 19/09/2008  J.Wiechula@gsi.de:            Added export of the calibration data to the AMORE data base.
+///                                           Added support for configuration files.
+/// 31/01/2011  Christian.Lippmann@cern.ch :  Updates for changed setup at P2 with 2 LDCs per sector
+/// 26/09/2014  Christian.Lippmann@cern.ch :  Updates for changed setup at P2 1 CRORC per LDC
+/// 26/09/2014  Jens.Wiechula@cern.ch      :  comment out obsolete AliTPCRawStream
+/// 
+/// \author marian.ivanov@cern.ch
+/// 
+/// This process reads RAW data from the files provided as command line arguments
+/// and save results in a file (named from RESULT_FILE define - see below).
 
 #define RESULT_FILE  "tpcPedestal.root"
 #define FILE_ID "pedestals"
@@ -59,9 +54,8 @@ extern "C" {
 #include "stdlib.h"
 #include <fstream>
 
-//
-//Root includes
-//
+// Root includes
+
 #include "TFile.h"
 #include "TArrayF.h"
 #include "TROOT.h"
@@ -95,16 +89,13 @@ extern "C" {
 //
 #include "AliTPCCalibPedestal.h"
 
-/*
-  Main routine, TPC pedestal detector algorithm to be run on TPC LDC
-  Arguments: list of DATE raw data files
-*/
 
 int main(int argc, char **argv) {
-  //
-  // Main for TPC pedestal detector algorithm
-  //
-  /* log start of process */
+  /// Main routine, TPC pedestal detector algorithm to be run on TPC LDC
+  /// Arguments: list of DATE raw data files
+  /// Main for TPC pedestal detector algorithm
+
+  // log start of process
   printf("TPC DA started - %s\n",__FILE__);
   
   if (argc<2) {
index a06c2d4..01b3098 100644 (file)
@@ -1,37 +1,30 @@
-/*
-TPC DA for online calibration
-
-Contact: Haavard.Helstrup@cern.ch
-Link:
-Run Type: CALIBRATION_PULSER
-DA Type: LDC
-Number of events needed: 100
-Input Files: 
-Output Files: tpcPulser.root, to be exported to the DAQ FXS
-fileId:   pulser
-Trigger types used: CALIBRATION_EVENT
-
-*/
-
-/*
-
-TPCda_pulser.cxx - calibration algorithm for TPC pulser events
-
-10/06/2007  sylvain.chapeland@cern.ch  :  first version - clean skeleton based on DAQ DA case1
-30/09/2007  haavard.helstrup@cern.ch   :  created pulser DA based on pedestal code
-19/09/2008  J.Wiechula@gsi.de:            Added export of the calibration data to the AMORE data base.
-                                          Added support for configuration files.
-23/04/2011  Christian.Lippmann@cern.ch :  Added output of acsii files for online
-26/09/2014  Christian.Lippmann@cern.ch :  CHange for new DAQ setup with one CRORC per LDC
-26/09/2014  Jens.Wiechula@cern.ch      :  comment out obsolete AliTPCRawStream
-
- contact: marian.ivanov@cern.ch
-
-
-This process reads RAW data from the files provided as command line arguments
-and save results in a file (named from RESULT_FILE define - see below).
-
-*/
+/// \file TPCPULSERda.cxx
+/// \brief TPC DA for online calibration
+/// 
+/// Contact: Haavard.Helstrup@cern.ch
+/// Link:
+/// Run Type: CALIBRATION_PULSER
+/// DA Type: LDC
+/// Number of events needed: 100
+/// Input Files: 
+/// Output Files: tpcPulser.root, to be exported to the DAQ FXS
+/// fileId:   pulser
+/// Trigger types used: CALIBRATION_EVENT
+/// 
+/// TPCda_pulser.cxx - calibration algorithm for TPC pulser events
+/// 
+/// 10/06/2007  sylvain.chapeland@cern.ch  :  first version - clean skeleton based on DAQ DA case1
+/// 30/09/2007  haavard.helstrup@cern.ch   :  created pulser DA based on pedestal code
+/// 19/09/2008  J.Wiechula@gsi.de:            Added export of the calibration data to the AMORE data base.
+///                                           Added support for configuration files.
+/// 23/04/2011  Christian.Lippmann@cern.ch :  Added output of acsii files for online
+/// 26/09/2014  Christian.Lippmann@cern.ch :  CHange for new DAQ setup with one CRORC per LDC
+/// 26/09/2014  Jens.Wiechula@cern.ch      :  comment out obsolete AliTPCRawStream
+/// 
+/// \author marian.ivanov@cern.ch
+/// 
+/// This process reads RAW data from the files provided as command line arguments
+/// and save results in a file (named from RESULT_FILE define - see below).
 
 #define RESULT_FILE "tpcPulser.root"
 #define FILE_ID "pulser"
@@ -49,9 +42,8 @@ and save results in a file (named from RESULT_FILE define - see below).
 #include <stdlib.h>
 #include <fstream>
 
-//
-//Root includes
-//
+// Root includes
+
 #include <TFile.h>
 #include "TROOT.h"
 #include "TPluginManager.h"
@@ -82,11 +74,11 @@ and save results in a file (named from RESULT_FILE define - see below).
 //
 #include "AliTPCCalibPulser.h"
 
-/* Main routine
-      Arguments: list of DATE raw data files
-*/
 int main(int argc, char **argv) {
-  /* log start of process */
+  /// Main routine
+  /// Arguments: list of DATE raw data files
+
+  // log start of process
   printf("TPC Pulser DA started - %s\n",__FILE__);
 
   if (argc<2) {
index 2410442..d6da176 100644 (file)
@@ -1,35 +1,29 @@
-/*
-TPC DA for online calibration
-
-Contact: Haavard.Helstrup@cern.ch, peter.christiansen@hep.lu.se
-Link: 
-Run Type: PHYSICS STANDALONE DAQ
-DA Type: MON
-Number of events needed: 500
-Input Files: /castor/cern.ch/alice/raw/global/2009/08/22/11/09000080958023.30.root
-Output Files: tpcQA.root, to be exported to the DAQ FXS
-fileId:   QA
-Trigger types used: PHYSICS_EVENT
-
-*/
-
-/*
-
-TPCQAda.cxx - algorithm for TPC RAW QA
-
-10/06/2007  sylvain.chapeland@cern.ch :  first version - clean skeleton based on DAQ DA case1
-06/12/2007  haavard.helstrup@cern.ch  :  created CE DA based on pulser code
-09/06/2008  peter.christiansen@hep.lu.se and haavard.helstrup@cern.ch  :  created QA DA based on AliTPCdataQA code
-
-10/09/2009  Jens.Wiechula@cern.ch:     Export object to AMOREdb after a defined update interval for QA
-26/01/2010  Jens.Wiechula@cern.ch:     Exclude laser triggers when running in a global partition
-
-contact: marian.ivanov@cern.ch, peter.christiansen@hep.lu.se
-
-This process reads RAW data from the files provided as command line arguments
-and save results in a file (named from RESULT_FILE define - see below).
-
-*/
+/// \file TPCQAda.cxx
+/// \brief algorithm for TPC RAW QA
+/// 
+/// TPC DA for online calibration
+/// 
+/// Contact: Haavard.Helstrup@cern.ch, peter.christiansen@hep.lu.se
+/// Link: 
+/// Run Type: PHYSICS STANDALONE DAQ
+/// DA Type: MON
+/// Number of events needed: 500
+/// Input Files: /castor/cern.ch/alice/raw/global/2009/08/22/11/09000080958023.30.root
+/// Output Files: tpcQA.root, to be exported to the DAQ FXS
+/// fileId:   QA
+/// Trigger types used: PHYSICS_EVENT
+/// 
+/// 10/06/2007  sylvain.chapeland@cern.ch :  first version - clean skeleton based on DAQ DA case1
+/// 06/12/2007  haavard.helstrup@cern.ch  :  created CE DA based on pulser code
+/// 09/06/2008  peter.christiansen@hep.lu.se and haavard.helstrup@cern.ch  :  created QA DA based on AliTPCdataQA code
+/// 
+/// 10/09/2009  Jens.Wiechula@cern.ch:     Export object to AMOREdb after a defined update interval for QA
+/// 26/01/2010  Jens.Wiechula@cern.ch:     Exclude laser triggers when running in a global partition
+/// 
+/// \author marian.ivanov@cern.ch, peter.christiansen@hep.lu.se
+/// 
+/// This process reads RAW data from the files provided as command line arguments
+/// and save results in a file (named from RESULT_FILE define - see below).
 
 #define RESULT_FILE "tpcQA.root"
 #define FILE_ID "QA"
@@ -77,11 +71,11 @@ and save results in a file (named from RESULT_FILE define - see below).
 //functios, implementation below
 void SendToAmoreDB(TObject *o, unsigned long32 runNb);
 
-/* Main routine
-      Arguments: list of DATE raw data files
-*/
 int main(int argc, char **argv) {
-  /* log start of process */
+  /// Main routine
+  /// Arguments: list of DATE raw data files
+
+  // log start of process
   printf("TPCQAda: DA started - %s\n",__FILE__);
   
   if (argc<2) {
index 1ccd843..5bcebca 100644 (file)
@@ -1,31 +1,25 @@
-/*
-TPC DA for online calibration
-
-Contact: Jens.Wiechula@cern.ch
-Link:
-Run Type: PHYSICS STANDALONE
-DA Type: MON
-Number of events needed: 200
-Input Files: /castor/cern.ch/alice/raw/global/2009/08/22/11/09000080958023.30.root
-Output Files: tpcCalibRaw.root, to be exported to the DAQ FXS
-fileId:   tpcCalibRaw
-Trigger types used: PHYSICS_EVENT
-
-*/
-
-/*
-
-TPCRAWda.cxx - calibration algorithm for L1 phase monitoring and drift velocity from last time bin determination
-
-30/07/2009  Jens.Wiechula@cern.ch:     First implementation.
-10/09/2009  Jens.Wiechula@cern.ch:     Add configuration file support. Export object to AMOREdb
-                                       after a defined update interval for QA
-26/01/2010  Jens.Wiechula@cern.ch:     Exclude laser triggers when running in a global partition
-
-This process reads RAW data from the files provided as command line arguments
-and save results in a file (named from RESULT_FILE define - see below).
-
-*/
+/// \file TPCRAWda.cxx
+/// \brief calibration algorithm for L1 phase monitoring and drift velocity from last time bin determination
+/// 
+/// TPC DA for online calibration
+/// 
+/// Contact: Jens.Wiechula@cern.ch
+/// Link:
+/// Run Type: PHYSICS STANDALONE
+/// DA Type: MON
+/// Number of events needed: 200
+/// Input Files: /castor/cern.ch/alice/raw/global/2009/08/22/11/09000080958023.30.root
+/// Output Files: tpcCalibRaw.root, to be exported to the DAQ FXS
+/// fileId:   tpcCalibRaw
+/// Trigger types used: PHYSICS_EVENT
+/// 
+/// 30/07/2009  Jens.Wiechula@cern.ch:     First implementation.
+/// 10/09/2009  Jens.Wiechula@cern.ch:     Add configuration file support. Export object to AMOREdb
+///                                        after a defined update interval for QA
+/// 26/01/2010  Jens.Wiechula@cern.ch:     Exclude laser triggers when running in a global partition
+/// 
+/// This process reads RAW data from the files provided as command line arguments
+/// and save results in a file (named from RESULT_FILE define - see below).
 
 #define RESULT_FILE "tpcCalibRaw.root"
 #define FILE_ID "tpcCalibRaw"
@@ -79,11 +73,11 @@ and save results in a file (named from RESULT_FILE define - see below).
 //functions, implementation below
 void SendToAmoreDB(TObject *o, unsigned long32 runNb);
 
-/* Main routine
-      Arguments: list of DATE raw data files
-*/
 int main(int argc, char **argv) {
-  /* log start of process */
+  /// Main routine
+  /// Arguments: list of DATE raw data files
+
+  // log start of process
   printf("TPCRAWda: DA started - %s\n",__FILE__);
 
   if (argc<2) {
index 6353614..c2d619b 100644 (file)
@@ -763,7 +763,8 @@ INPUT                  = @CMAKE_SOURCE_DIR@/doxygen \
                          @CMAKE_SOURCE_DIR@/TPC/Attic \
                          @CMAKE_SOURCE_DIR@/TPC/Base/test \
                          @CMAKE_SOURCE_DIR@/TPC/Cal \
-                         @CMAKE_SOURCE_DIR@/TPC/CalibMacros
+                         @CMAKE_SOURCE_DIR@/TPC/CalibMacros \
+                         @CMAKE_SOURCE_DIR@/TPC/DA
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses