More docs
authorcholm <cholm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 24 Mar 2006 16:09:36 +0000 (16:09 +0000)
committercholm <cholm@f7af4fe6-9843-0410-8265-dc069ae4e863>
Fri, 24 Mar 2006 16:09:36 +0000 (16:09 +0000)
31 files changed:
FMD/AliFMD.h
FMD/AliFMDReconstructor.cxx
FMD/Doxyfile
FMD/scripts/ApplyAlignment.C
FMD/scripts/CheckAlign.C
FMD/scripts/CheckRaw.C
FMD/scripts/Compare.C
FMD/scripts/Compile.C
FMD/scripts/Convert2Raw.C
FMD/scripts/DisplayHits.C
FMD/scripts/Document.C
FMD/scripts/DrawDigitsRecs.C
FMD/scripts/DrawHits.C
FMD/scripts/DrawHitsDigits.C
FMD/scripts/DrawHitsRecs.C
FMD/scripts/DrawLego.C
FMD/scripts/DrawXsection.C
FMD/scripts/GetMedia.C
FMD/scripts/GetXsection.C
FMD/scripts/MakeAlignment.C
FMD/scripts/Poisson.C
FMD/scripts/RawTest.C
FMD/scripts/ShowRaw.C [deleted file]
FMD/scripts/SimpleGeometry.C
FMD/scripts/TestAltroMapping.C
FMD/scripts/TestHWMap.C
FMD/scripts/TestMapIO.C
FMD/scripts/TestRawIO.C
FMD/scripts/VA1Response.C
FMD/scripts/VA1Train.C
FMD/scripts/Wafer.C

index d55e13d559511323d7512090f52f9baec9808abb..43e02d85d90241118ebb41252a7711ecd4062286 100644 (file)
@@ -16,6 +16,7 @@
       - @ref sim   (see also @ref FMD_sim)
       - @ref rec   (see also @ref FMD_rec)
       - @ref util  (see also @ref FMD_util)
+    - @ref script  (see also @ref FMD_script)
     - @ref quick
     - @ref authors
     
       dummy) calibration and alignment         data.  These derive from
       TTask.  
 
+    @section script Scripts 
+    
+    Most scripts live in @c FMD/scripts.  The notiable exceptions are 
+    @ref Simulate.C, @ref Reconstruct.C, and @ref Config.C 
+
     @section quick Quick start 
 
     First, install ROOT.  Then Install TGeant3: 
index 828767c0be4af1dc33ad693eb1c82f985a5594a6..d901bad8cd801d83c9eae2bf97ef8345449592a8 100644 (file)
@@ -115,9 +115,13 @@ AliFMDReconstructor::Init(AliRunLoader* runLoader)
   // Initialize the reconstructor 
   AliDebug(1, Form("Init called with runloader 0x%x", runLoader));
   // Initialize the geometry 
-  AliFMDGeometry* fmd = AliFMDGeometry::Instance();
-  fmd->Init();
-  fmd->InitTransformations();
+  AliFMDGeometry* geom = AliFMDGeometry::Instance();
+  geom->Init();
+  geom->InitTransformations();
+
+  // Initialize the parameters
+  AliFMDParameters* param = AliFMDParameters::Instance();
+  param->Init();
   
   // Current vertex position
   fCurrentVertex = 0;
@@ -366,9 +370,9 @@ AliFMDReconstructor::PhysicalCoordinates(AliFMDDigit* digit,
   // Get the eta and phi of a digit 
   // 
   // Get geometry. 
-  AliFMDGeometry* fmd = AliFMDGeometry::Instance();
+  AliFMDGeometry* geom = AliFMDGeometry::Instance();
   Double_t x, y, z, r, theta;
-  fmd->Detector2XYZ(digit->Detector(), digit->Ring(), digit->Sector(), 
+  geom->Detector2XYZ(digit->Detector(), digit->Ring(), digit->Sector(), 
                    digit->Strip(), x, y, z);
   // Correct for vertex offset. 
   z     += fCurrentVertex;
index 24d87cfdf92cf54e6cb8218767019aac637839a4..145aa43d6dee4f3f196430665a73a5e0d6e50ea9 100644 (file)
@@ -82,8 +82,10 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = /home/hehi/cholm/work/alice/aliroot/FMD
-FILE_PATTERNS          = *.h
+INPUT                  = /home/hehi/cholm/work/alice/aliroot/FMD \
+                         /home/hehi/cholm/work/alice/aliroot/FMD/scripts/
+FILE_PATTERNS          = *.h \
+                         *.C
 RECURSIVE              = NO
 EXCLUDE                = 
 EXCLUDE_SYMLINKS       = NO
@@ -98,7 +100,7 @@ FILTER_SOURCE_FILES    = NO
 #---------------------------------------------------------------------------
 # configuration options related to source browsing
 #---------------------------------------------------------------------------
-SOURCE_BROWSER         = NO
+SOURCE_BROWSER         = YES
 INLINE_SOURCES         = NO
 STRIP_CODE_COMMENTS    = YES
 REFERENCED_BY_RELATION = NO
index 9b7212690dd24b9a875fb007b39fcca40f916ca1..c18463b8d5ef2f1bcfe9c12ea6a40de38e05aef3 100644 (file)
@@ -5,6 +5,9 @@
 // Read in the geometry, and get alignment data from CDB, and  apply
 // that to the geometry. 
 //
+/** Apply alignment to a geometry 
+    @ingroup simple_script
+ */
 void
 ApplyAlignment()
 {
index 87218d4f768ae438ea54d72d738e3df2b0d58252..5acced733b261bcffccca75c917890ba73affe7b 100644 (file)
 #include <TParticle.h>
 #include <TCanvas.h>
 
+/** @class CheckAlign
+    @brief Check alignment 
+    @code 
+    Root> .L Compile.C
+    Root> Compile("CheckAlign.C")
+    Root> CheckAlign c
+    Root> c.Run();
+    @endcode
+    @ingroup FMD_script
+ */
 class CheckAlign : public AliFMDInput
 {
 public:
index 745a9f5f42ea6874439fe7eb2faec6d45d9ec048..b7b7109c1470996d86589147ba85514fca8ba6a0 100644 (file)
 #include <TArrayF.h>
 #include <TCanvas.h>
 
+/** @class CheckRaw
+    @brief Check raw I/O
+    @code 
+    Root> .L Compile.C
+    Root> Compile("CheckRaw.C")
+    Root> CheckRaw c
+    Root> c.Run();
+    @endcode
+    @ingroup FMD_script
+ */
 class CheckRaw : public AliFMDInput
 {
 public:
index ca135351bb3348b162d7763f2f1269df1542983f..d71c47fc56e9832c30a72317e5719cc97b93a805 100644 (file)
@@ -2,6 +2,8 @@
 //
 // Script to compare the output of GEANT 3.21 to FLUKA 2. 
 //
+/** @ingroup simple_script
+ */
 void
 Compare() 
 {
index 09b8449621776d59176253b11aacd0ce49e8372e..0ce263b9e7a3a447496d5fa2f275c3536dc7a6a3 100644 (file)
@@ -5,6 +5,18 @@
 // Script to compile (using ACLic) and load a script.  It sets the
 // include path to contain the relevant directories. 
 //
+/** @defgroup FMD_script Scripts
+    @brief Scripts for the FMD 
+*/
+/** @defgroup simple_script Simple scripts
+    @ingroup FMD_script
+    @brief Scripts for the FMD 
+*/
+/** Compile an FMD script using ACLic
+    @param script Script to compile
+    @param option Compile option 
+    @ingroup FMD_script
+*/
 void
 Compile(const char* script, Option_t* option="g")
 {
index 8d5c36d614657a3fc2ca8aed1c279c375c61fd75..5753ec21758f3788bd6f8e254f8b4705ce571a62 100644 (file)
@@ -5,6 +5,9 @@
 // Read in digits, and convert them to raw data files.  This is mainly
 // for testing. 
 //
+/** Convert digits to Raw data
+    @ingroup simple_script
+*/
 void
 Convert2Raw()
 {
index 0d0c3555693aeae777785e0b2da467ef767022f2..35ef0f156094f01d252422a7d918456824770a71 100644 (file)
@@ -4,6 +4,9 @@
 //
 // Draw hits in the specialised FMD event display 
 //
+/** Display hits 
+    @ingroup FMD_script
+ */
 void
 DisplayHits()
 {
index 53e60581ebcd8723378f2eead4d119962f3b92bb..6404cae7121112d6586577bce3b3c415cbc7ed89 100644 (file)
@@ -16,6 +16,8 @@
 /* $Id$ */
 
 // Script to document the FMD code
+/** @ingroup simple_script
+ */
 void
 Document()
 {
index 70ef767646854f161d3caa42d20b9c3f1a69053a..839d7ae4cd4931b9fa1b8f88c747b40a26ee829e 100644 (file)
 #include <TArrayF.h>
 #include <TCanvas.h>
 
+/** @class DrawDigitsRecs
+    @brief Draw digit ADC versus Rec point mult
+    @code 
+    Root> .L Compile.C
+    Root> Compile("DrawDigitsRecs.C")
+    Root> DrawDigitsRecs c
+    Root> c.Run();
+    @endcode
+    @ingroup FMD_script
+ */
 class DrawDigitsRecs : public AliFMDInputDigits
 {
 private:
@@ -54,6 +64,9 @@ public:
     fAdcVsSingle->SetYTitle("Strip Multiplicity");
   }
   //__________________________________________________________________
+  /** Begining of event
+      @param ev Event number
+      @return @c false on error */
   Bool_t Begin(Int_t ev) 
   {
     fMap.Reset();
index ad306d3f280a933f1421f640630d3d69883c3adb..95522502de6971254606fdb2a53ade0565fa79a2 100644 (file)
 #include <TArrayF.h>
 #include <TParticle.h>
 
+/** @class DrawHits
+    @brief Draw hit energy loss
+    @code 
+    Root> .L Compile.C
+    Root> Compile("DrawHits.C")
+    Root> DrawHits c
+    Root> c.Run();
+    @endcode
+    @ingroup FMD_script
+ */
 class DrawHits : public AliFMDInputHits
 {
 private:
index 3bb6aedc0fb8e56d405bdee44dcb88ab826ab4b2..2ee1d09e6f2cfb5fbb1f166bf06334cc0b0bd9d0 100644 (file)
 #include <TStyle.h>
 #include <TArrayF.h>
 
+/** @class DrawHitsDigits
+    @brief Draw hit energy loss versus digit ADC
+    @code 
+    Root> .L Compile.C
+    Root> Compile("DrawHitsDigits.C")
+    Root> DrawHitsDigits c
+    Root> c.Run();
+    @endcode
+    @ingroup FMD_script
+ */
 class DrawHitsDigits : public AliFMDInputHits
 {
 private:
@@ -54,6 +64,9 @@ public:
     fElossVsAdc->SetYTitle("ADC value");
   }
   //__________________________________________________________________
+  /** Begining of event
+      @param ev Event number
+      @return @c false on error */
   Bool_t Begin(Int_t ev) 
   {
     fMap.Reset();
index e4436e260502ad5dc95e6a8388790e23a2ff2acb..2cf6680f71041733b39a11ff52a195df684527f1 100644 (file)
 #include <AliLog.h>
 
 //____________________________________________________________________
+/** @class DrawHitsRecs
+    @brief Draw hit energy loss versus rec point mult
+    @code 
+    Root> .L Compile.C
+    Root> Compile("DrawHitsRecs.C")
+    Root> DrawHitsRecs c
+    Root> c.Run();
+    @endcode
+    @ingroup FMD_script
+ */
 class DrawHitsRecs : public AliFMDInputHits
 {
 private:
@@ -83,6 +93,9 @@ public:
     fHitsVsStrip->SetYTitle("Strip Multiplicity");
   }
   //__________________________________________________________________
+  /** Begining of event
+      @param ev Event number
+      @return @c false on error */
   Bool_t Begin(Int_t ev) 
   {
     fMap.Reset();
index 23e250b9d863937535a76573c09a1417681c5fc8..1590c855a0e0b668a8bcebf91446d9d82dae160c 100644 (file)
 # include <iostream>
 using namespace std;
 #endif
-
+/** @defgroup lego_script LEGO script
+    @ingroup FMD_script 
+*/
 //____________________________________________________________________
+/** @ingroup lego_script
+    @param ang 
+    @return  */
 Float_t 
 deg2eta(Float_t ang) 
 {
@@ -29,6 +34,11 @@ deg2eta(Float_t ang)
 
 
 //____________________________________________________________________
+/** @ingroup lego_script
+    @param which 
+    @param what 
+    @param back 
+    @return  */
 TH1* 
 getHisto(const Char_t* which, const Char_t* what, TH1* back=0) 
 {
@@ -89,6 +99,9 @@ getHisto(const Char_t* which, const Char_t* what, TH1* back=0)
 }
 
 //____________________________________________________________________
+/** @ingroup lego_script
+    @param what 
+*/
 void
 drawLego(const char* what="abso") 
 {
@@ -230,6 +243,8 @@ drawLego(const char* what="abso")
   
   
 //____________________________________________________________________
+/** @ingroup lego_script
+ */
 void 
 DrawLego() 
 {
index c07bbae41c51fd54b7aca17d9d3baf9524e5d946..7a02da7b0906b6b21aaac066f9db32b3daa4282d 100644 (file)
@@ -2,6 +2,14 @@
 //
 // Script to draw a X-section, LOSS, or range made with MakeXsection
 //
+/** @ingroup xsec_script
+    @param scale 
+    @param filename 
+    @param var 
+    @param medName 
+    @param thick 
+    @param pdgName 
+*/
 void
 DrawXsection(Bool_t scale=kFALSE, 
             const char* filename="xsec.root", 
index 3a76dd8b8e01265401e155ae734aba853e082e43..21e7432ee95d5d90a8e3ebc228d116f9436a0228 100644 (file)
 #include <AliRun.h>
 #include <TNtuple.h>
 
+/** @class Media 
+    @brief Media description 
+    @ingroup FMD_script
+ */
 struct Media : public TNamed
 {
   TArrayI*        fMeds;
@@ -45,6 +49,16 @@ struct Media : public TNamed
 
 
 //____________________________________________________________________
+/** @class GetMedia
+    @brief Get media where a particle is produced
+    @code 
+    Root> .L Compile.C
+    Root> Compile("GetMedia.C")
+    Root> GetMedia c
+    Root> c.Run();
+    @endcode
+    @ingroup FMD_script
+ */
 class GetMedia : public AliFMDInputHits
 {
 private:
@@ -101,6 +115,9 @@ public:
     return AliFMDInputHits::Init();
   }  
   //__________________________________________________________________
+  /** Begining of event
+      @param ev Event number
+      @return @c false on error */
   Bool_t Begin(Int_t ev) 
   {
     fEv = ev;
index e850fa4c3ca05a859c33ddca7f5a3ee2df2698e2..32983398f6b1f37fd5f85cca13a8a06d2567b820 100644 (file)
 #include <TGeoManager.h>
 #include <TGeoMedium.h>
 #include <TGeant3.h>
-
+/** @defgroup xsec_script X-section script 
+    @ingroup FMD_script 
+*/
 //____________________________________________________________________
+/** @ingroup xsec_script
+ */
 struct Mech 
 {
   char*    name;
@@ -35,6 +39,13 @@ struct Mech
 
 
 //____________________________________________________________________
+/** @ingroup xsec_script
+    @param medName 
+    @param pdgName 
+    @param n 
+    @param emin 
+    @param emax 
+*/
 void
 GetXsection(const char* medName, const char* pdgName,
            Int_t n=91, Float_t emin=1e-5, Float_t emax=1e4)
index 20aaecdc078cf0986adbead1393a64a313847033..7a51fb82a2e101a92ae6ace47ea4cf1441b6da2a 100644 (file)
@@ -4,6 +4,9 @@
 //
 // Make fake alignment data.
 //
+/** Make fake alignment data 
+    @ingroup simple_script
+ */
 void
 MakeAlignment()
 {
index 042b0be53099d9fb623faf13f237d1214f8e414e..a3f82a387f161d4579d50d8966b7bad0304b5053 100644 (file)
 #include <TArrayF.h>
 #include <iostream>
 
+/** @class Poisson
+    @brief Make a poisson reconstruction
+    @code 
+    Root> .L Compile.C
+    Root> Compile("Poisson.C")
+    Root> Poisson c
+    Root> c.Run();
+    @endcode
+    @ingroup FMD_script
+ */
 class Poisson : public AliFMDInput
 {
 private:
@@ -58,6 +68,9 @@ public:
     if (!fFile) return kFALSE;
     return kTRUE;
   }
+  /** Begining of event
+      @param event Event number
+      @return @c false on error */
   Bool_t Begin(Int_t event) 
   {
     if (!AliFMDInput::Begin(event)) return kFALSE;
@@ -92,6 +105,14 @@ public:
       } // Loop over rings
     } // Loop over detectors
   }
+  /** For each bin, reconstruct the charge particle multiplicity as 
+      @f[
+      m = - N_{total} \log\left(\frac{N_{empty}}{N_{total}}\right)
+      @f]
+      where @f$ N_{total}@f$ is the total number of strips in the bin,
+      and @f$ N_{empty}@f$ is the number of strips in the bin that did
+      not fire. 
+      @return @c true  */
   Bool_t End() 
   {
     for (Int_t etaBin = 1; etaBin <= fEmpty->GetNbinsX(); etaBin++) {
index 94ec56f2362abedb082f37178f6bd39e3c1f2cfe..13b76fcc2b3448683afa0661ba0f0b76e8a00f3d 100644 (file)
@@ -3,6 +3,9 @@
 //
 // Small script to test consistency of writing and reading raw data.
 //
+/** Check raw data I/O
+    @ingroup simple_script
+ */
 void
 RawTest() 
 {
diff --git a/FMD/scripts/ShowRaw.C b/FMD/scripts/ShowRaw.C
deleted file mode 100644 (file)
index 2a55719..0000000
+++ /dev/null
@@ -1,75 +0,0 @@
-//
-// $Id$
-//
-// Script to read a raw data file, and dump it to std::cout 
-//
-#include <iomanip>
-
-void 
-ShowRaw(Int_t det=2,  bool verbose=false, Int_t event=0) 
-{
-  TString file(Form("raw%d/FMD_%d.ddl", event, 
-                   AliFMDParameters::kBaseDDL + det - 1));
-
-  std::cout << "Reading raw data file " << file << std::endl;
-  
-  TH1* h = new TH1F("rawData", "Raw Data", 128, 0, 1024);
-  
-  
-  // This method creates a text file containing the same information
-  // stored in an Altro file. The information in the text file is
-  // organized pad by pad and and for each pad it consists in a
-  // sequence of bunches (Bunch length +2, Time bin of the last
-  // amplitude sample in the bunch, amplitude values) It is used
-  // mainly //for debugging
-
-  AliAltroBuffer buff(file.Data(),0);
-  Int_t numWords,padNum,rowNum,secNum=0;
-  Int_t value = 0;
-  Int_t zero  = 0;
-  if (!buff.ReadDataHeader()) {
-    std::cout<< file << " isn't a valid data file!" << std::endl;
-  }
-  
-  while(buff.ReadTrailerBackward(numWords,padNum,rowNum,secNum)){
-    if (verbose) 
-      std::cout << "Ring: " << (secNum == 0 ? 'I' : 'O') 
-               << " Sector: " << std::setw(2) << rowNum 
-               << " Strip:  " << std::setw(3) << padNum 
-               << " Words:  " << std::setw(4) << numWords << std::endl;
-    if (numWords == 0) zero++;
-    if (numWords % 4){
-      if (verbose) 
-       std::cout << "Skipping trailer of " 
-                 << (4 - numWords % 4) << " words" << std::endl;
-      for(Int_t j = 0; j < (4 - numWords % 4); j++)
-       value=buff.GetNextBackWord(); 
-    }//end if
-    for(Int_t i = 0; i <numWords; i++) {
-      value=buff.GetNextBackWord();
-      if (verbose) {
-       std::cout << std::setw(5) <<  value << std::flush;
-       if (i % 16 == 15) std::cout << std::endl;
-      }
-      h->Fill(value);
-    }//end for
-    if (verbose)
-      std::cout << std::endl;
-    if (zero > 1) {
-      std::cout << "Error: Read zero channels - should not happen" 
-               << std::endl;
-      break;
-    }
-  }//end while
-
-  TCanvas* c = new TCanvas("raw", "Raw Data");
-  c->SetFillColor(0);
-  c->SetLogy();
-  c->SetBorderMode(0);
-  h->Draw();
-  return;
-}
-//____________________________________________________________________
-//
-// EOF
-//
index db9bafd65a815f21f2b4e35831f12823a16a2a55..4df0ae710dda49c5ad2a920a4c5e7848473803c5 100644 (file)
@@ -6,6 +6,18 @@
 // Script I used for rapid prototyping of the FMD3 geometry - in
 // particular the support cone 
 //
+/** @defgroup simple_geom Simple geometry
+    @ingroup FMD_script
+*/
+/** Calculate wafer parameters 
+    @param dl      Lower diameter
+    @param dh      Higer diameter
+    @param theta   Opening angle
+    @param r       Wafer radius
+    @param verbose Maybe be verbose
+    @return  Corners of shape
+    @ingroup simple_geom
+*/
 //____________________________________________________________________
 TObjArray*
 waferParameters(double dl, double dh, double theta, double r, 
@@ -46,6 +58,15 @@ waferParameters(double dl, double dh, double theta, double r,
   return verticies;
 }
 
+/** Create the sensor shape 
+    @param name 
+    @param rl 
+    @param rh 
+    @param th 
+    @param r 
+    @param dz 
+    @ingroup simple_geom
+    @return  */
 //____________________________________________________________________
 TShape* 
 createModuleShape(const Char_t* name, double rl, double rh, double th, 
@@ -72,6 +93,18 @@ createModuleShape(const Char_t* name, double rl, double rh, double th,
   return (TShape*)moduleShape;
 }
 
+/** 
+    @param name 
+    @param rl 
+    @param rh 
+    @param th 
+    @param siThick 
+    @param waferR 
+    @param staggering 
+    @param z 
+    @ingroup simple_geom
+    @return  
+*/
 //____________________________________________________________________
 TNode* 
 createRing(const char* name, double rl, double rh, double th, 
@@ -105,6 +138,21 @@ createRing(const char* name, double rl, double rh, double th,
 }
 
 //____________________________________________________________________
+/** 
+    @param noseRl 
+    @param noseRh 
+    @param noseDz 
+    @param noseZ 
+    @param backRl 
+    @param backRh 
+    @param backDz 
+    @param coneL 
+    @param beamW 
+    @param beamDz 
+    @param flangeR 
+    @return  
+    @ingroup simple_geom
+*/
 TNode*
 createSupport(double noseRl, double noseRh, double noseDz, double noseZ, 
              double backRl, double backRh, double backDz, double coneL, 
@@ -175,6 +223,9 @@ createSupport(double noseRl, double noseRh, double noseDz, double noseZ,
 
 
 //____________________________________________________________________
+/** 
+    @ingroup simple_geom
+ */
 void
 SimpleGeometry() 
 {
index 87ef65786ff81c91d6c534b9d0256349ac9e942e..fa28cd166f5670ec3865a3a733e3972fbbafbf7f 100644 (file)
@@ -4,8 +4,14 @@
 //
 // Check integrety of Hardware2Detector and Detector2Hardware
 //
-
+/** @defgroup ALTRO_test ALTRO test
+    @ingroup FMD_script 
+*/
 //____________________________________________________________________
+/** @ingroup ALTRO_test
+    @param ddl 
+    @param hwaddr 
+    @return  */
 Char_t* 
 Addr2Str(UInt_t ddl, UInt_t hwaddr)
 {
@@ -18,6 +24,12 @@ Addr2Str(UInt_t ddl, UInt_t hwaddr)
 }
 
 //____________________________________________________________________
+/** @ingroup ALTRO_test
+    @param det 
+    @param ring 
+    @param sec 
+    @param str 
+    @return  */
 Char_t* 
 Det2Str(UShort_t det, Char_t ring, UShort_t sec, UShort_t str)
 {
@@ -27,6 +39,18 @@ Det2Str(UShort_t det, Char_t ring, UShort_t sec, UShort_t str)
 }
 
 //____________________________________________________________________
+/** @ingroup ALTRO_test
+    @param det 
+    @param ring 
+    @param sec 
+    @param str 
+    @param ddl 
+    @param hwaddr 
+    @param odet 
+    @param oring 
+    @param osec 
+    @param ostr 
+*/
 void 
 PrintTrans(UShort_t det, Char_t ring, UShort_t sec, UShort_t str, 
           UInt_t ddl, UInt_t hwaddr,
@@ -40,6 +64,16 @@ PrintTrans(UShort_t det, Char_t ring, UShort_t sec, UShort_t str,
 }
 
 //____________________________________________________________________
+/** @ingroup ALTRO_test
+    @param det 
+    @param ring 
+    @param sec 
+    @param str 
+    @param odet 
+    @param oring 
+    @param osec 
+    @param ostr 
+*/
 void
 CheckTrans(UShort_t det, Char_t ring, UShort_t sec, UShort_t str, 
           UShort_t odet, Char_t oring, UShort_t osec, UShort_t ostr)
@@ -55,6 +89,8 @@ CheckTrans(UShort_t det, Char_t ring, UShort_t sec, UShort_t str,
 }
 
 //____________________________________________________________________
+/** @ingroup ALTRO_test
+ */
 void
 TestAltroMapping()
 {
index 2fe855ebae95a1e4150722b416366b56f8fb260a..08747a0193e4d1bba31163037e4590cf3b260993 100644 (file)
@@ -4,8 +4,14 @@
 //
 // Check integrety of Hardware2Detector and Detector2Hardware
 //
-
+/** @defgroup HW_Test Hardware map test
+    @ingroup FMD_script 
+*/
 //____________________________________________________________________
+/** @ingroup HW_test
+    @param ddl 
+    @param hwaddr 
+    @return  */
 Char_t* 
 Addr2Str(UInt_t ddl, UInt_t hwaddr)
 {
@@ -18,6 +24,12 @@ Addr2Str(UInt_t ddl, UInt_t hwaddr)
 }
 
 //____________________________________________________________________
+/** @ingroup HW_test
+    @param det 
+    @param ring 
+    @param sec 
+    @param str 
+    @return  */
 Char_t* 
 Det2Str(UShort_t det, Char_t ring, UShort_t sec, UShort_t str)
 {
@@ -27,6 +39,18 @@ Det2Str(UShort_t det, Char_t ring, UShort_t sec, UShort_t str)
 }
 
 //____________________________________________________________________
+/** @ingroup HW_test
+    @param det 
+    @param ring 
+    @param sec 
+    @param str 
+    @param ddl 
+    @param hwaddr 
+    @param odet 
+    @param oring 
+    @param osec 
+    @param ostr 
+*/
 void 
 PrintTrans(UShort_t det, Char_t ring, UShort_t sec, UShort_t str, 
           UInt_t ddl, UInt_t hwaddr,
@@ -40,6 +64,16 @@ PrintTrans(UShort_t det, Char_t ring, UShort_t sec, UShort_t str,
 }
 
 //____________________________________________________________________
+/** @ingroup HW_test
+    @param det 
+    @param ring 
+    @param sec 
+    @param str 
+    @param odet 
+    @param oring 
+    @param osec 
+    @param ostr 
+*/
 void
 CheckTrans(UShort_t det, Char_t ring, UShort_t sec, UShort_t str, 
           UShort_t odet, Char_t oring, UShort_t osec, UShort_t ostr)
@@ -55,6 +89,8 @@ CheckTrans(UShort_t det, Char_t ring, UShort_t sec, UShort_t str,
 }
 
 //____________________________________________________________________
+/** @ingroup HW_test
+ */
 void
 TestHWMap()
 {
index 260574a16e9f511ca7ccbe68ab5e69d1eaa53d4c..22ab4ac7070ecc880ec5ba04a54300be25c4ae44 100644 (file)
@@ -4,7 +4,12 @@
 //
 // Test I/O of ALiFMDMap
 //
+/** @defgroup MAPIO_TEST Map I/O test
+    @ingroup FMD_script 
+*/
 //____________________________________________________________________
+/** @ingroup MAPIO_test
+ */
 void 
 WriteTree()
 {
@@ -19,6 +24,8 @@ WriteTree()
 }
 
 //____________________________________________________________________
+/** @ingroup MAPIO_test
+ */
 void 
 ReadTree()
 {
@@ -36,6 +43,8 @@ ReadTree()
 
   
 //____________________________________________________________________
+/** @ingroup MAPIO_test
+ */
 void
 WriteMap() 
 {
@@ -47,6 +56,9 @@ WriteMap()
 }
 
 //____________________________________________________________________
+/** @ingroup MAPIO_test
+    @return  */
+void
 ReadMap() 
 {
   TFile* file = TFile::Open("map.root", "READ");
@@ -61,6 +73,8 @@ ReadMap()
 
 
 //____________________________________________________________________
+/** @ingroup MAPIO_test
+ */
 void
 TestMapIO()
 {
index cb517cf6f0fc77c1613d29456177ab89d1dc6e65..b947862dfb29ec1c077814974b9036bd6a424ab5 100644 (file)
@@ -4,6 +4,8 @@
 //
 // Test of AliFMDAltro{Reader,Writer}
 //
+/** @ingroup simple_script
+ */
 void
 TestRawIO()
 {
index b1018827f8f6ed7c71e3011f373fc31d39544a1c..5e1e17d2e7168b29b81a669af113d37a0b844508 100644 (file)
@@ -5,6 +5,13 @@
 // Script to try to fit the reponse function of the VA1 signals, based
 // on a finite number of ALTRO samples. 
 //
+/** Make Va1 response
+    @param n 
+    @param B 
+    @param dc 
+    @param errors 
+    @ingroup simple_script
+*/
 void 
 VA1Response(Int_t n=2, Float_t B=5, Float_t dc=.01, Bool_t errors=kFALSE) 
 {
index c575e150fdf2b53be5c8bd2aaabb3c489086259a..9489c8886dbadf49f46ef30f247d18044949a359 100644 (file)
@@ -4,6 +4,9 @@
 //
 // Small script that shows a signal train from a VA1 pre-amp. 
 // 
+/** Make VA1 sample train
+    @ingroup simple_script
+ */
 void 
 VA1Train() 
 {
index 3162eb0852b94606bfe134341679bc0fbda4986c..019da1829ff493326aade9c5c5490889ff84a128 100644 (file)
@@ -7,6 +7,11 @@
 //
 // Christian 
 // 
+/** Calculate wafer parameters
+    @param c 
+    @return  
+    @ingroup simple_script
+*/
 TObjArray*
 WaferParameters(const char c)
 {      
@@ -64,6 +69,9 @@ WaferParameters(const char c)
   return verticies;
 }
 
+/** Draw wafers
+    @ingroup simple_script
+ */
 void
 Wafer()
 {