- Modified comment lines to be compatible with 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
12
13 ////////////////////////////////////////////////
14 //  AliDetector Class for MUON subsystem      //
15 ////////////////////////////////////////////////
16
17 #include <TObjArray.h>
18
19 #include "AliDetector.h"
20 #include "AliMUONData.h"
21 #include "AliMUONChamber.h"
22
23 class TVector;
24 class TFile;
25 class TTree;
26
27 class AliLoader;
28 class AliMUONGeometrySegmentation;
29 class AliMUONTriggerCircuit;
30 class AliMUONData;
31 class AliMUONResponse;
32 class AliMUONHit;
33 class AliMUONRawCluster;
34 class AliMUONGeometryBuilder;
35 class AliMUONVGeometryBuilder;
36 class AliMUONGeometryDEIndexing;
37 class AliESD;
38
39 class AliMUON : public  AliDetector 
40 {
41   public:
42     AliMUON();
43     AliMUON(const char *name, const char *title);
44     virtual       ~AliMUON();
45    
46     void           AddGeometryBuilder(AliMUONVGeometryBuilder* geomBuilder);
47     virtual void   BuildGeometry();
48     AliMUONData*   GetMUONData() {return fMUONData;}
49     AliMUONGeometryBuilder*  GetGeometryBuilder() {return fGeometryBuilder;}
50     virtual Int_t  IsVersion()   const {return 0;}
51
52     // MUONLoader definition
53     virtual AliLoader* MakeLoader(const char* topfoldername); //builds standard getter (AliLoader type)
54     // Interface with AliMUONData
55     virtual void       MakeBranch(Option_t *opt=" ") {GetMUONData()->MakeBranch(opt);}
56     virtual void       SetTreeAddress();
57     virtual void       ResetHits()                   {GetMUONData()->ResetHits();}
58     virtual void       ResetDigits()                 {GetMUONData()->ResetDigits();}
59     virtual void       ResetTrigger()                {GetMUONData()->ResetTrigger();}
60     virtual void       ResetRawClusters()            {GetMUONData()->ResetRawClusters();}
61     virtual void       SetSplitLevel(Int_t SplitLevel)     {fSplitLevel=SplitLevel;}
62
63     // Digitisation 
64     virtual AliDigitizer* CreateDigitizer(AliRunDigitizer* manager) const;
65     virtual void   SDigits2Digits();      
66     virtual void   Hits2SDigits();
67     virtual void   Digits2Raw();
68
69
70     // Configuration Methods (per station id)
71     //
72     // Set Chamber Segmentation Parameters
73     // id refers to the station and isec to the cathode plane
74     // Set Z values for all chambers
75     virtual void SetChambersZ(const Float_t *Z);
76     virtual void SetChambersZToDefault(void);
77     // Set Signal Generation Parameters
78     virtual void   SetSigmaIntegration(Int_t id, Float_t p1);
79     virtual void   SetChargeSlope(Int_t id, Float_t p1);
80     virtual void   SetChargeSpread(Int_t id, Float_t p1, Float_t p2);
81     virtual void   SetMaxAdc(Int_t id, Int_t p1);
82     // Set Segmentation and Response Model
83     virtual void   SetSegmentationModel(Int_t id, Int_t isec,
84                                         AliMUONGeometrySegmentation* segmentation);
85
86     virtual void   SetResponseModel(Int_t id, AliMUONResponse *response);
87
88     // Set Stepping Parameters
89     virtual void   SetMaxStepGas(Float_t p1);
90     virtual void   SetMaxStepAlu(Float_t p1);
91     virtual void   SetMaxDestepGas(Float_t p1);
92     virtual void   SetMaxDestepAlu(Float_t p1);
93    
94     // Get Stepping Parameters
95     virtual Float_t  GetMaxStepGas() const;
96     virtual Float_t  GetMaxStepAlu() const;
97     virtual Float_t  GetMaxDestepGas() const;
98     virtual Float_t  GetMaxDestepAlu() const;
99     
100     // Set alignement option
101     virtual void  SetAlign(Bool_t align);
102    
103     // Return reference to Chamber #id
104     virtual AliMUONChamber& Chamber(Int_t id)
105       {return *((AliMUONChamber *) (*fChambers)[id]);}
106     // Return reference to Circuit #id
107     virtual AliMUONTriggerCircuit& TriggerCircuit(Int_t id)
108       {return *((AliMUONTriggerCircuit *) (*fTriggerCircuits)[id]);}
109     // Return pointers to digits
110     AliMUONRawCluster    *RawCluster(Int_t ichamber, Int_t icathod,
111                                      Int_t icluster);
112     // Inherited and overridden from AliModule:
113     //PH    virtual void RemapTrackHitIDs(Int_t * map);
114
115   protected:
116     AliMUON(const AliMUON& rMUON);
117     AliMUON& operator = (const AliMUON& rhs);
118
119
120     Int_t                 fNCh;                // Number of chambers   
121     Int_t                 fNTrackingCh;        // Number of tracking chambers*
122     AliMUONData*          fMUONData;           // Data container for MUON subsystem  
123     Int_t                 fSplitLevel;         // Splitlevel when making branches in outfiles.
124     TObjArray*            fChambers;           // List of Tracking Chambers
125     TObjArray*            fTriggerCircuits;    // List of Trigger Circuits
126     AliMUONGeometryBuilder*     fGeometryBuilder; // Geometry builder 
127     AliMUONGeometryDEIndexing*  fDEIndexing;   // Geometry DE indexing 
128    
129     //
130     Bool_t   fAccCut;          //Transport acceptance cut
131     Float_t  fAccMin;          //Minimum acceptance cut used during transport
132     Float_t  fAccMax;          //Minimum acceptance cut used during transport
133     //  
134     //  Stepping Parameters
135     Float_t fMaxStepGas;      // Maximum step size inside the chamber gas
136     Float_t fMaxStepAlu;      // Maximum step size inside the chamber aluminum
137     Float_t fMaxDestepGas;    // Maximum relative energy loss in gas
138     Float_t fMaxDestepAlu;    // Maximum relative energy loss in aluminum
139     
140     // Pad Iterator
141     Int_t fMaxIterPad;        // Maximum pad index
142     Int_t fCurIterPad;        // Current pad index
143     // Background eent for event mixing
144     
145     ClassDef(AliMUON,9)  // MUON Detector base class
146 };
147 #endif
148