Updated comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / AliMUON.h
1 #ifndef ALIMUON_H
2 #define ALIMUON_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4  * See cxx source for full Copyright notice                               */
5
6 /* $Id$ */
7 // Revision of includes 07/05/2004
8
9 /// \ingroup base
10 /// \class AliMUON
11 /// \brief AliDetector class for MUON subsystem providing
12 /// simulation data management 
13  
14
15 #include <TObjArray.h>
16
17 #include "AliDetector.h"
18 #include "AliMUONData.h"
19 #include "AliMUONChamber.h"
20 #include "AliMUONTrigger.h"
21
22 #include <TVectorfwd.h>
23
24 class TFile;
25 class TTree;
26
27 class AliLoader;
28 class AliMUONData;
29 class AliMUONResponse;
30 class AliMUONSegmentation;
31 class AliMUONHit;
32 class AliMUONRawCluster;
33 class AliMUONGeometry;
34 class AliMUONGeometryTransformer;
35 class AliMUONGeometryBuilder;
36 class AliMUONRawWriter;
37 class AliMUONVGeometryBuilder;
38 class AliESD;
39 class AliMUONDigitMaker;
40
41 class AliMUON : public  AliDetector 
42 {
43   public:
44     AliMUON();
45     AliMUON(const char* name, const char* title);
46     virtual ~AliMUON();
47    
48     // Geometry
49     void AddGeometryBuilder(AliMUONVGeometryBuilder* geomBuilder);
50     void ResetGeometryBuilder();
51     
52     virtual void   BuildGeometry();
53     
54                    /// Return geometry builder
55     AliMUONGeometryBuilder*            GetGeometryBuilder() const {return fGeometryBuilder;}
56     const AliMUONGeometryTransformer*  GetGeometryTransformer() const;
57                    /// Return segmentation
58     AliMUONSegmentation*               GetSegmentation() const    { return fSegmentation; }
59
60                    /// Return MUONData   
61     AliMUONData*   GetMUONData() {return fMUONData;}
62
63     // MUONLoader definition
64     virtual AliLoader* MakeLoader(const char* topfoldername); //builds standard getter (AliLoader type)
65
66     // Interface with AliMUONData
67                    /// Make branch
68     virtual void   MakeBranch(Option_t *opt=" ") {GetMUONData()->MakeBranch(opt);}
69     virtual void   SetTreeAddress();
70                    /// Reset hits
71     virtual void   ResetHits()                   {GetMUONData()->ResetHits();}
72                    /// Reset digits
73     virtual void   ResetDigits()                 {GetMUONData()->ResetDigits();}
74                    /// Reset trigger
75     virtual void   ResetTrigger()                {GetMUONData()->ResetTrigger();}
76                    /// Reset raw clusters
77     virtual void   ResetRawClusters()            {GetMUONData()->ResetRawClusters();}
78                    /// Set split level
79     virtual void   SetSplitLevel(Int_t SplitLevel)     {fSplitLevel=SplitLevel;}
80
81     // Digitisation 
82     virtual AliDigitizer* CreateDigitizer(AliRunDigitizer* manager) const;
83     virtual void   SDigits2Digits();      
84     virtual void   Hits2SDigits();
85     virtual void   Digits2Raw();
86     virtual Bool_t Raw2SDigits(AliRawReader* rawReader);
87
88     // Trigger
89                    /// Create trigger
90     virtual AliTriggerDetector* CreateTriggerDetector() const
91        { return new AliMUONTrigger(); }
92     
93
94     // Configuration Methods (per station id)
95     //
96     // Set Signal Generation Parameters
97     virtual void   SetSigmaIntegration(Int_t id, Float_t p1);
98     virtual void   SetChargeSlope(Int_t id, Float_t p1);
99     virtual void   SetChargeSpread(Int_t id, Float_t p1, Float_t p2);
100     virtual void   SetMaxAdc(Int_t id, Int_t p1);
101     // Set Response Model
102     virtual void   SetResponseModel(Int_t id, AliMUONResponse *response);
103
104     // Set Stepping Parameters
105     virtual void   SetMaxStepGas(Float_t p1);
106     virtual void   SetMaxStepAlu(Float_t p1);
107     virtual void   SetMaxDestepGas(Float_t p1);
108     virtual void   SetMaxDestepAlu(Float_t p1);
109    
110     // Get Stepping Parameters
111     virtual Float_t  GetMaxStepGas() const;
112     virtual Float_t  GetMaxStepAlu() const;
113     virtual Float_t  GetMaxDestepGas() const;
114     virtual Float_t  GetMaxDestepAlu() const;
115     
116     // Set alignement option
117     virtual void  SetAlign(Bool_t align = true);
118     virtual void  SetAlign(const TString& fileName, Bool_t align = true);
119
120                    /// Set scaler event for trigger
121     virtual void  SetTriggerScalerEvent(Bool_t scaler = true){fTriggerScalerEvent = scaler;}
122
123                   /// Set trigger response version
124     virtual void  SetTriggerResponseV1(Bool_t trigResV1 = false)
125         { fTriggerResponseV1 = trigResV1; }
126     virtual Bool_t GetTriggerResponseV1() const;
127                   /// Set trigger coinc44
128     virtual void  SetTriggerCoinc44(Int_t trigCoinc44 = 0)
129         { fTriggerCoinc44 = trigCoinc44; }
130     virtual Int_t GetTriggerCoinc44() const;
131                  /// Set trigger chamber efficiency by cells
132     virtual void SetTriggerEffCells(Bool_t trigEffCells = false)
133         { fTriggerEffCells = trigEffCells; }
134     virtual Bool_t GetTriggerEffCells() const;
135                  /// Set off generation of noisy digits
136     virtual void SetDigitizerWithNoise(Bool_t digitizerWithNoise)
137         { fDigitizerWithNoise = digitizerWithNoise; }
138     virtual Bool_t GetDigitizerWithNoise() const; 
139     
140     // Getters
141                   /// Return reference to Chamber \a id
142     virtual AliMUONChamber& Chamber(Int_t id)
143       {return *((AliMUONChamber *) (*fChambers)[id]);}
144                   /// Return reference to New Circuit \a id 
145
146     // Return pointers to digit
147     AliMUONRawCluster    *RawCluster(Int_t ichamber, Int_t icathod,
148                                      Int_t icluster);
149     // Inherited and overridden from AliModule:
150     //PH    virtual void RemapTrackHitIDs(Int_t * map);
151     
152   protected:
153     /// Not implemented
154     AliMUON(const AliMUON& rMUON);
155     /// Not implemented
156     AliMUON& operator = (const AliMUON& rhs);
157
158     const AliMUONGeometry* GetGeometry() const;
159
160     Int_t                 fNCh;                ///< Number of chambers   
161     Int_t                 fNTrackingCh;        ///< Number of tracking chambers*
162     AliMUONData*          fMUONData;           ///< Data container for MUON subsystem  
163     Int_t                 fSplitLevel;         ///< Splitlevel when making branches in outfiles.
164     TObjArray*            fChambers;           ///< List of Tracking Chambers
165     AliMUONGeometryBuilder*  fGeometryBuilder; ///< Geometry builder 
166     AliMUONSegmentation*  fSegmentation;       ///< New segmentation 
167    
168     //
169     Bool_t   fAccCut;         ///<Transport acceptance cut
170     Float_t  fAccMin;         ///<Minimum acceptance cut used during transport
171     Float_t  fAccMax;         ///<Minimum acceptance cut used during transport
172     //  
173     //  Stepping Parameters
174     Float_t fMaxStepGas;      ///< Maximum step size inside the chamber gas
175     Float_t fMaxStepAlu;      ///< Maximum step size inside the chamber aluminum
176     Float_t fMaxDestepGas;    ///< Maximum relative energy loss in gas
177     Float_t fMaxDestepAlu;    ///< Maximum relative energy loss in aluminum
178     
179     // Pad Iterator
180     Int_t fMaxIterPad;        ///< Maximum pad index
181     Int_t fCurIterPad;        ///< Current pad index
182    
183     // Options
184     Bool_t fTriggerScalerEvent; ///< Flag to generates scaler event
185     Bool_t fTriggerResponseV1;  ///< Flag to select TriggerResponseV1
186     Int_t  fTriggerCoinc44;     ///< Flag to select TriggerCoinc44 
187     Bool_t fTriggerEffCells;    ///< Flag to select TriggerEffCells
188     Bool_t fDigitizerWithNoise; ///< Flag to switch on/off generation of noisy digits
189     
190     AliMUONRawWriter* fRawWriter; //!< Raw data writer
191     
192     AliMUONDigitMaker* fDigitMaker; //!< pointer to the digit maker class
193
194     ClassDef(AliMUON,13)  // MUON Detector base class
195 };
196 #endif
197