Added a lot of Doxygen documentation

[u/mrichter/AliRoot.git] / FMD / AliFMDParameters.h

diff --git a/FMD/AliFMDParameters.h b/FMD/AliFMDParameters.h
index 94ee0dd2bf7800b1ddfdea70d492376739e76b15..423bd26ebfc35c73b1e5f81b7ed9f144aef25446 100644 (file)
--- a/FMD/AliFMDParameters.h
+++ b/FMD/AliFMDParameters.h
@@ -33,34 +33,73 @@ class AliFMDCalibGain;
 class AliFMDCalibSampleRate;
 class AliFMDAltroMapping;
 
+/** This class is a singleton that handles various parameters of the
+    FMD detectors.  This class reads from the Conditions DB to get the
+    various parameters, which code can then request from here. In that
+    way, all code uses the same data, and the interface is consistent.
+     
+    Some of the parameter managed are 
+    - @c fPedestal, @c fPedestalWidth
+      Mean and width of the pedestal.  The pedestal is simulated
+      by a Guassian, but derived classes my override MakePedestal
+      to simulate it differently (or pick it up from a database).
+    - @c fVA1MipRange
+      The dymamic MIP range of the VA1_ALICE pre-amplifier chip 
+    - @c fAltroChannelSize
+      The largest number plus one that can be stored in one
+      channel in one time step in the ALTRO ADC chip. 
+    - @c fSampleRate
+      How many times the ALTRO ADC chip samples the VA1_ALICE
+      pre-amplifier signal.   The VA1_ALICE chip is read-out at
+      10MHz, while it's possible to drive the ALTRO chip at
+      25MHz.  That means, that the ALTRO chip can have time to
+      sample each VA1_ALICE signal up to 2 times.  Although it's
+      not certain this feature will be used in the production,
+      we'd like have the option, and so it should be reflected in
+      the code.
+
+    @ingroup FMD_base
+*/
 class AliFMDParameters : public TNamed
 {
 public:
+  /** Singleton access
+      @return  single to */
   static AliFMDParameters* Instance();
 
+  /** Initialize the manager.  This tries to read the parameters from
+      CDB.  If that fails, the class uses the hard-coded parameters. 
+   */
   void Init();
   
-  // Set various `Fixed' parameters 
+  /** @{ */
+  /** @name Set various `Fixed' parameters */
   void SetVA1MipRange(UShort_t r=20)          { fVA1MipRange = r; }
   void SetAltroChannelSize(UShort_t s=1024)   { fAltroChannelSize = s;}
   void SetChannelsPerAltro(UShort_t size=128) { fChannelsPerAltro = size; }
   void SetPedestalFactor(Float_t f=3)         { fPedestalFactor = f; }
+  /** @} */
 
-  // Set various variable parameter defaults
+  /** @{ */
+  /** @name Set various variable parameter defaults */
   void SetZeroSuppression(UShort_t s=0)       { fFixedZeroSuppression = s; }
   void SetSampleRate(UShort_t r=1)            { fFixedSampleRate = (r>2?2:r);}
   void SetPedestal(Float_t p=10)              { fFixedPedestal = p; }
   void SetPedestalWidth(Float_t w=1)          { fFixedPedestalWidth = w; }
   void SetThreshold(Float_t t=0)              { fFixedThreshold = t; }
+  /** @} */
 
-  // Get `Fixed' various parameters
+  /** @{ */
+  /** @name Get `Fixed' various parameters */
   UShort_t GetVA1MipRange()          const { return fVA1MipRange; }
   UShort_t GetAltroChannelSize()     const { return fAltroChannelSize; }
   UShort_t GetChannelsPerAltro()     const { return fChannelsPerAltro; }
   Float_t  GetEdepMip()              const;
   Float_t  GetPedestalFactor()      const { return fPedestalFactor; }
+  /** @} */
 
-  // Get variable parameters 
+  /** @{ */
+  /** @name Get variable parameters */
   Bool_t   IsDead(UShort_t detector, 
                  Char_t ring, 
                  UShort_t sector, 
@@ -89,6 +128,8 @@ public:
   Bool_t   Detector2Hardware(UShort_t det, Char_t ring, UShort_t sec, 
                             UShort_t str, UInt_t& ddl, UInt_t& addr) const;
   AliFMDAltroMapping* GetAltroMap() const;
+  /** @} */
+
   enum { 
     kBaseDDL = 0x1000 // DDL offset for the FMD
   };
@@ -99,14 +140,23 @@ public:
   static const char* fgkAltroMap;       // Path to AltroMap calib object
   static const char* fgkZeroSuppression; // Path to ZeroSuppression cal object
 protected:
+  /** CTOR  */
   AliFMDParameters();
+  /** DTOR */
   virtual ~AliFMDParameters() {}
+  /** Singleton instance  */
   static AliFMDParameters* fgInstance;   // Static singleton instance
+  /** Initialize gains.  Try to get them from CDB */
   void InitPulseGain();
+  /** Initialize pedestals.  Try to get them from CDB */
   void InitPedestal();
+  /** Initialize dead map.  Try to get it from CDB */
   void InitDeadMap();
+  /** Initialize sample rates.  Try to get them from CDB */
   void InitSampleRate();
+  /** Initialize zero suppression thresholds.  Try to get them from CDB */
   void InitZeroSuppression();
+  /** Initialize hardware map.  Try to get it from CDB */
   void InitAltroMap();
 
   Bool_t          fIsInit;               // Whether we've been initialised