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 AliMUONTriggerCircuit;
29 class AliMUONTriggerCircuitNew;
30 class AliMUONData;
31 class AliMUONResponse;
32 class AliMUONSegmentation;
33 class AliMUONHit;
34 class AliMUONRawCluster;
35 class AliMUONGeometry;
36 class AliMUONGeometryTransformer;
37 class AliMUONGeometryBuilder;
38 class AliMUONRawWriter;
39 class AliMUONVGeometryBuilder;
40 class AliESD;
41
42 class AliMUON : public  AliDetector 
43 {
44   public:
45     AliMUON();
46     AliMUON(const char* name, const char *title="FactoryV4",
47             const char* sDigitizerType="sdigitizer:AliMUONSDigitizerV2",
48             const char* digitizerType="digitizer:NewDigitizerWithNoiseOldTrigger");
49     virtual ~AliMUON();
50    
51     // Geometry
52     void AddGeometryBuilder(AliMUONVGeometryBuilder* geomBuilder);
53     void ResetGeometryBuilder();
54     
55     virtual void   BuildGeometry();
56     virtual Int_t  IsVersion()   const {return 0;}
57     
58     AliMUONGeometryBuilder*            GetGeometryBuilder() const {return fGeometryBuilder;}
59     const AliMUONGeometryTransformer*  GetGeometryTransformer() const;
60     AliMUONSegmentation*               GetSegmentation() const    { return fSegmentation; }
61
62     // MUONData   
63     AliMUONData*   GetMUONData() {return fMUONData;}
64
65     // MUONLoader definition
66     virtual AliLoader* MakeLoader(const char* topfoldername); //builds standard getter (AliLoader type)
67     // Interface with AliMUONData
68     virtual void       MakeBranch(Option_t *opt=" ") {GetMUONData()->MakeBranch(opt);}
69     virtual void       SetTreeAddress();
70     virtual void       ResetHits()                   {GetMUONData()->ResetHits();}
71     virtual void       ResetDigits()                 {GetMUONData()->ResetDigits();}
72     virtual void       ResetTrigger()                {GetMUONData()->ResetTrigger();}
73     virtual void       ResetRawClusters()            {GetMUONData()->ResetRawClusters();}
74     virtual void       SetSplitLevel(Int_t SplitLevel)     {fSplitLevel=SplitLevel;}
75
76     // Digitisation 
77     virtual AliDigitizer* CreateDigitizer(AliRunDigitizer* manager) const;
78     virtual void   SDigits2Digits();      
79     virtual void   Hits2SDigits();
80     virtual void   Digits2Raw();
81     
82     // Trigger
83     virtual AliTriggerDetector* CreateTriggerDetector() const
84        { return new AliMUONTrigger(); }
85     
86
87     // Configuration Methods (per station id)
88     //
89     // Set Signal Generation Parameters
90     virtual void   SetSigmaIntegration(Int_t id, Float_t p1);
91     virtual void   SetChargeSlope(Int_t id, Float_t p1);
92     virtual void   SetChargeSpread(Int_t id, Float_t p1, Float_t p2);
93     virtual void   SetMaxAdc(Int_t id, Int_t p1);
94     // Set Response Model
95     virtual void   SetResponseModel(Int_t id, AliMUONResponse *response);
96
97     // Set Stepping Parameters
98     virtual void   SetMaxStepGas(Float_t p1);
99     virtual void   SetMaxStepAlu(Float_t p1);
100     virtual void   SetMaxDestepGas(Float_t p1);
101     virtual void   SetMaxDestepAlu(Float_t p1);
102    
103     // Get Stepping Parameters
104     virtual Float_t  GetMaxStepGas() const;
105     virtual Float_t  GetMaxStepAlu() const;
106     virtual Float_t  GetMaxDestepGas() const;
107     virtual Float_t  GetMaxDestepAlu() const;
108     
109     // Set alignement option
110     virtual void  SetAlign(Bool_t align = true);
111     virtual void  SetAlign(const TString& fileName, Bool_t align = true);
112
113     // Set scaler event for trigger
114     virtual void  SetTriggerScalerEvent(Bool_t scaler = true){fTriggerScalerEvent = scaler;}
115
116     // Return reference to Chamber #id
117     virtual AliMUONChamber& Chamber(Int_t id)
118       {return *((AliMUONChamber *) (*fChambers)[id]);}
119     // Return reference to Circuit #id
120     virtual AliMUONTriggerCircuit& TriggerCircuit(Int_t id)
121       {return *((AliMUONTriggerCircuit *) (*fTriggerCircuits)[id]);}
122     virtual AliMUONTriggerCircuitNew& TriggerCircuitNew(Int_t id)
123         {return *((AliMUONTriggerCircuitNew*) (*fTriggerCircuitsNew)[id]);}
124     // Return pointers to digits
125     AliMUONRawCluster    *RawCluster(Int_t ichamber, Int_t icathod,
126                                      Int_t icluster);
127     // Inherited and overridden from AliModule:
128     //PH    virtual void RemapTrackHitIDs(Int_t * map);
129
130     TString SDigitizerType() const;
131     TString DigitizerType() const;
132     
133   protected:
134     AliMUON(const AliMUON& rMUON);
135     AliMUON& operator = (const AliMUON& rhs);
136
137     const AliMUONGeometry* GetGeometry() const;
138
139     Int_t                 fNCh;                ///< Number of chambers   
140     Int_t                 fNTrackingCh;        ///< Number of tracking chambers*
141     AliMUONData*          fMUONData;           ///< Data container for MUON subsystem  
142     Int_t                 fSplitLevel;         ///< Splitlevel when making branches in outfiles.
143     TObjArray*            fChambers;           ///< List of Tracking Chambers
144     TObjArray*            fTriggerCircuits;    ///< List of Trigger Circuits
145     TObjArray*            fTriggerCircuitsNew; ///< List of Trigger Circuits
146     AliMUONGeometryBuilder*  fGeometryBuilder; ///< Geometry builder 
147     AliMUONSegmentation*  fSegmentation;       ///< New segmentation 
148    
149     //
150     Bool_t   fAccCut;         ///<Transport acceptance cut
151     Float_t  fAccMin;         ///<Minimum acceptance cut used during transport
152     Float_t  fAccMax;         ///<Minimum acceptance cut used during transport
153     //  
154     //  Stepping Parameters
155     Float_t fMaxStepGas;      ///< Maximum step size inside the chamber gas
156     Float_t fMaxStepAlu;      ///< Maximum step size inside the chamber aluminum
157     Float_t fMaxDestepGas;    ///< Maximum relative energy loss in gas
158     Float_t fMaxDestepAlu;    ///< Maximum relative energy loss in aluminum
159     
160     // Pad Iterator
161     Int_t fMaxIterPad;        ///< Maximum pad index
162     Int_t fCurIterPad;        ///< Current pad index
163    
164     // setting scaler for trigger
165     Bool_t fTriggerScalerEvent; ///< Flag to generates scaler event
166     
167     TString fSDigitizerType;    ///< Class to use for SDigitizer
168     TString fDigitizerType;     ///< Class to use for Digitizer
169     
170     AliMUONRawWriter* fRawWriter; //!< Raw data writer
171     
172     ClassDef(AliMUON,13)  // MUON Detector base class
173 };
174 #endif
175