New method SetContainerData for allocation of memory when output on tree

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

diff --git a/FMD/AliFMDDigitizer.h b/FMD/AliFMDDigitizer.h
index 60f0c9205e83809cb53d7182d5d19bbe5a2934bb..22ceced04bb6ca690ec45b7ee0df010f54213ae7 100644 (file)
--- a/FMD/AliFMDDigitizer.h
+++ b/FMD/AliFMDDigitizer.h
@@ -5,21 +5,32 @@
  *
  * See cxx source for full Copyright notice                               
  */
-#ifndef ALIDIGITIZER_H
-# include <AliDigitizer.h>
-#endif
-#ifndef ALIRUNDIGITIZER_H
-# include <AliRunDigitizer.h>
-#endif
-#ifndef ALIFMDEdepMAP_H
-# include "AliFMDEdepMap.h"
-#endif
-#ifndef __UTILITY__
-# include <utility>
+// Classses to make Hits into digits and summable digits. 
+//    
+//    Digits consists of
+//    - Detector #
+//    - Ring ID                                             
+//    - Sector #     
+//    - Strip #
+//    - ADC count in this channel                                  
+//
+//    Summable digits consists of      
+//    - Detector #
+//    - Ring ID                                             
+//    - Sector #     
+//    - Strip #
+//    - Total energy deposited in the strip
+//    - ADC count in this channel                                  
+//
+/** @file    AliFMDDigitizer.h
+    @author  Christian Holm Christensen <cholm@nbi.dk>
+    @date    Mon Mar 27 12:38:26 2006
+    @brief   FMD Digitizers declaration
+    @ingroup FMD_sim
+*/
+#ifndef ALIFMDBASEDIGITIZER_H
+# include <AliFMDBaseDigitizer.h>
 #endif
-// #ifndef ROOT_TArrayF
-// # include <TArrayF.h>
-// #endif
 
 //====================================================================
 class TClonesArray;
@@ -29,65 +40,37 @@ class AliRunLoader;
 class AliFMDDigit;
 
 
-//====================================================================
-class AliFMDBaseDigitizer : public AliDigitizer 
-{
-public:
-  AliFMDBaseDigitizer();
-  AliFMDBaseDigitizer(AliRunDigitizer * manager);
-  AliFMDBaseDigitizer(const Char_t* name, const Char_t* title);
-  virtual ~AliFMDBaseDigitizer();
-   
-  // Do the main work
-  virtual Bool_t Init();
-
-  // Extra member functions 
-  void     SetShapingTime(Float_t t=10) { fShapingTime = t;  }  
-  Float_t  GetShapingTime()      const { return fShapingTime; }
-protected:
-  virtual void     SumContributions(AliFMD* fmd);
-  virtual void     DigitizeHits(AliFMD* fmd) const;
-  virtual void     ConvertToCount(Float_t   edep, 
-                                 Float_t   last,
-                                 UShort_t  detector, 
-                                 Char_t    ring, 
-                                 UShort_t  sector, 
-                                 UShort_t  strip,
-                                 TArrayI&  counts) const;
-  virtual UShort_t MakePedestal(UShort_t  detector, 
-                               Char_t    ring, 
-                               UShort_t  sector, 
-                               UShort_t  strip) const;
-  virtual void     AddNoise(TArrayI&) const {}
-  virtual void     AddDigit(AliFMD*  /* fmd      */,
-                           UShort_t /* detector */, 
-                           Char_t   /* ring     */,
-                           UShort_t /* sector   */, 
-                           UShort_t /* strip    */, 
-                           Float_t  /* edep     */, 
-                           UShort_t /* count1   */, 
-                           Short_t  /* count2   */, 
-                           Short_t  /* count3   */) const {}
-
-  AliRunLoader* fRunLoader;       // Run loader
-  AliFMDEdepMap fEdep;             // Cache of Energy from hits 
-  Float_t       fShapingTime;      // Shaping profile parameter
-  
-  AliFMDBaseDigitizer(const AliFMDBaseDigitizer& o) 
-    : AliDigitizer(o) {}
-  AliFMDBaseDigitizer& operator=(const AliFMDBaseDigitizer&) { return *this; }
-  ClassDef(AliFMDBaseDigitizer,1) // Base class for FMD digitizers
-};
 
 //====================================================================
+/** @class AliFMDDigitizer
+    @brief Concrete digitizer to make digits from hits.  See also
+    AliFMDBaseDigitizer documentation.  
+    @ingroup FMD_sim
+ */
 class AliFMDDigitizer : public AliFMDBaseDigitizer 
 {
 public:
+  /** CTOR */
   AliFMDDigitizer();
+  /** CTOR 
+      @param manager Manager of digitization */
   AliFMDDigitizer(AliRunDigitizer * manager);
+  /** DTOR */
   virtual ~AliFMDDigitizer() {}
+  /** Do everything
+      @param option Not used */
   virtual void  Exec(Option_t* option=0);
 protected:
+  /** Add a digit to output.
+      @param fmd      Pointer to detector object
+      @param detector Detector #
+      @param ring     Ring ID
+      @param sector   Sector number
+      @param strip    Strip number
+      @param edep     Energy deposited (not used)
+      @param count1   ADC count 1
+      @param count2   ADC count 2 (-1 if not used)
+      @param count3   ADC count 3 (-1 if not used) */
   virtual void     AddDigit(AliFMD*  fmd,
                            UShort_t detector, 
                            Char_t   ring,
@@ -97,38 +80,26 @@ protected:
                            UShort_t count1, 
                            Short_t  count2, 
                            Short_t  count3) const;
+  /** MAke a pedestal
+      @param detector Detector #
+      @param ring     Ring ID
+      @param sector   Sector number
+      @param strip    Strip number
+      @return Random noise */
   virtual UShort_t MakePedestal(UShort_t  detector, 
                                Char_t    ring, 
                                UShort_t  sector, 
                                UShort_t  strip) const;
+  /** Check that digit data is consistent
+      @param digit   Digit
+      @param nhits   Number of hits
+      @param counts  ADC counts */
   virtual void     CheckDigit(AliFMDDigit*    digit,
                              UShort_t        nhits,
                              const TArrayI&  counts);
   ClassDef(AliFMDDigitizer,1) // Make Digits from Hits
 };
 
-//====================================================================
-class AliFMDSDigitizer : public AliFMDBaseDigitizer 
-{
-public:
-  AliFMDSDigitizer();
-  AliFMDSDigitizer(const Char_t* headerFile, const Char_t* sdigFile="");
-  virtual ~AliFMDSDigitizer();
-  virtual void  Exec(Option_t* option=0);
-protected:
-  virtual void     AddDigit(AliFMD*  fmd,
-                           UShort_t detector, 
-                           Char_t   ring,
-                           UShort_t sector, 
-                           UShort_t strip, 
-                           Float_t  edep, 
-                           UShort_t count1, 
-                           Short_t  count2, 
-                           Short_t  count3) const;
-  ClassDef(AliFMDSDigitizer,0) // Make Summable Digits from Hits
-};
-
-
 
 #endif
 //____________________________________________________________________