]> git.uio.no Git - u/mrichter/AliRoot.git/blob - FMD/AliFMDRecPoint.h
Added a lot of Doxygen documentation
[u/mrichter/AliRoot.git] / FMD / AliFMDRecPoint.h
1 #ifndef ALIFMDRECPOINT_H
2 #define ALIFMDRECPOINT_H
3
4 // Reconstracted Particles Class: has number of reconstructed
5 // particles in sectors from NumOfMinSector to NumberOfMaxSector()
6 // rings from NumOfMinRing to NumOfMaxRing for each FMDvolume 
7 //
8 #ifndef ROOT_TObject
9 # include <TObject.h>
10 #endif
11
12 /** Reconstructed FMD points.  It contains the pseudo-inclusive
13     multiplicity 
14     @ingroup FMD_rec
15  */
16 class AliFMDRecPoint: public TObject
17 {
18 public:
19   /** CTOR */
20   AliFMDRecPoint();
21   /** Constrctor 
22       @param detector Detector 
23       @param ring     Ring
24       @param sector   Sector
25       @param strip    Strip 
26       @param eta      Psuedo-rapidity @f$ \eta@f$ 
27       @param phi      Azimuthal angle @f$ \varphi@f$ 
28       @param edep     Energy deposited 
29       @param particles Psuedo-inclusive multiplicity */
30   AliFMDRecPoint(UShort_t detector,  Char_t   ring, 
31                  UShort_t sector,    UShort_t strip, 
32                  Float_t  eta,       Float_t  phi,
33                  Float_t  edep,      Float_t  particles);
34   /** DTOR */
35   virtual ~AliFMDRecPoint() {};
36
37   /** @return Detector # */
38   UShort_t     Detector()          const { return fDetector; }
39   /** @return Ring ID */
40   Char_t       Ring()              const { return fRing;     }
41   /** @return sector # */
42   UShort_t     Sector()            const { return fSector;   }
43   /** @return strip # */
44   UShort_t     Strip()             const { return fStrip;    }
45   /** @return Psuedo-rapidity @f$ \eta@f$ */
46   Float_t      Eta() const             { return fEta; }
47   /** @return phi      Azimuthal angle @f$ \varphi@f$ */
48   Float_t      Phi() const             { return fPhi; }
49   /** @return edep     Energy deposited */
50   Float_t      Edep() const            { return fEdep; }
51   /** @return particles Psuedo-inclusive multiplicity */
52   Float_t      Particles() const       { return fParticles; }
53   /** Print information 
54       @param opt Not used */
55   virtual void Print(Option_t* opt="D") const;
56   /** @return Name */
57   const char*  GetName()                const;
58   /** @return Title */
59   const char*  GetTitle()               const;
60 protected:
61   UShort_t fDetector;        // Detector #
62   Char_t   fRing;            // Ring ID
63   UShort_t fSector;          // Sector #
64   UShort_t fStrip;           // Strip # 
65   Float_t  fEta;             // Eta value 
66   Float_t  fPhi;             // Phi value
67   Float_t  fEdep;            // Energy deposited 
68   Float_t  fParticles;       // Quasi-number of particles 
69
70   ClassDef(AliFMDRecPoint,1)     // Base class for multiplicity data
71 };
72 #endif
73 //____________________________________________________________________
74 //
75 // Local Variables:
76 //   mode: C++
77 // End:
78 //
79 // EOF
80 //