Adding comment lines to class description needed for Root documentation,
[u/mrichter/AliRoot.git] / MUON / AliMUONResponseV0.cxx
1 /**************************************************************************
2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
3  *                                                                        *
4  * Author: The ALICE Off-line Project.                                    *
5  * Contributors are mentioned in the code where appropriate.              *
6  *                                                                        *
7  * Permission to use, copy, modify and distribute this software and its   *
8  * documentation strictly for non-commercial purposes is hereby granted   *
9  * without fee, provided that the above copyright notice appears in all   *
10  * copies and that both the copyright notice and this permission notice   *
11  * appear in the supporting documentation. The authors make no claims     *
12  * about the suitability of this software for any purpose. It is          *
13  * provided "as is" without express or implied warranty.                  *
14  **************************************************************************/
15
16 /* $Id$ */
17
18 //-----------------------------------------------------------------------------
19 // Class AliMUONResponseV0
20 // --------------------------
21 // Implementation of 
22 // Mathieson response
23 //-----------------------------------------------------------------------------
24
25 #include "AliMUONResponseV0.h"
26 #include "AliMUON.h"
27 #include "AliMUONConstants.h"
28 #include "AliMUONDigit.h"
29 #include "AliMUONGeometryTransformer.h"
30 #include "AliMUONHit.h"
31
32 #include "AliMpArea.h"
33 #include "AliMpDEManager.h"
34 #include "AliMpVPadIterator.h"
35 #include "AliMpSegmentation.h"
36 #include "AliMpVSegmentation.h"
37 #include "AliMpCathodType.h"
38
39 #include "AliRun.h"
40 #include "AliLog.h"
41
42 #include "Riostream.h"
43 #include "TVector2.h"
44 #include <TMath.h>
45 #include <TRandom.h>
46
47 /// \cond CLASSIMP
48 ClassImp(AliMUONResponseV0)
49 /// \endcond
50         
51 AliMUON* muon()
52 {
53     return static_cast<AliMUON*>(gAlice->GetModule("MUON"));
54 }
55
56 void Global2Local(Int_t detElemId, Double_t xg, Double_t yg, Double_t zg,
57                   Double_t& xl, Double_t& yl, Double_t& zl)
58 {  
59   /// ideally should be : 
60   /// Double_t x,y,z;
61   /// AliMUONGeometry::Global2Local(detElemId,xg,yg,zg,x,y,z);
62   /// but while waiting for this geometry singleton, let's go through
63   /// AliMUON still.
64   
65   const AliMUONGeometryTransformer* transformer = muon()->GetGeometryTransformer();
66   transformer->Global2Local(detElemId,xg,yg,zg,xl,yl,zl);
67 }
68
69 //__________________________________________________________________________
70 AliMUONResponseV0::AliMUONResponseV0()
71   : AliMUONResponse(),
72   fChargeSlope(0.0),
73   fChargeSpreadX(0.0),
74   fChargeSpreadY(0.0),
75   fSigmaIntegration(0.0),
76   fMaxAdc(0),
77   fSaturation(0),
78   fZeroSuppression(0),
79   fChargeCorrel(0.0),
80   fMathieson(new AliMUONMathieson),
81   fChargeThreshold(1e-4)
82 {
83     /// Normal constructor
84     AliDebug(1,Form("Default ctor"));
85 }
86
87 //__________________________________________________________________________
88 AliMUONResponseV0::AliMUONResponseV0(const AliMUONResponseV0& other)
89 : AliMUONResponse(),
90 fChargeSlope(0.0),
91 fChargeSpreadX(0.0),
92 fChargeSpreadY(0.0),
93 fSigmaIntegration(0.0),
94 fMaxAdc(0),
95 fSaturation(0),
96 fZeroSuppression(0),
97 fChargeCorrel(0.0),
98 fMathieson(0),
99 fChargeThreshold(1e-4)
100 {
101   /// copy ctor
102   other.CopyTo(*this);
103 }
104
105 //__________________________________________________________________________
106 AliMUONResponseV0& 
107 AliMUONResponseV0::operator=(const AliMUONResponseV0& other)
108 {
109   /// Assignment operator
110   other.CopyTo(*this);
111   return *this;
112 }
113
114 //__________________________________________________________________________
115 AliMUONResponseV0::~AliMUONResponseV0()
116 {
117 /// Destructor
118
119   AliDebug(1,"");
120   delete fMathieson;
121 }
122
123 //______________________________________________________________________________
124 void
125 AliMUONResponseV0::CopyTo(AliMUONResponseV0& other) const
126 {
127   /// Copy *this to other
128   other.fChargeSlope=fChargeSlope;
129   other.fChargeSpreadX=fChargeSpreadX;
130   other.fChargeSpreadY=fChargeSpreadY;
131   other.fSigmaIntegration=fSigmaIntegration;
132   other.fMaxAdc=fMaxAdc;
133   other.fSaturation=fSaturation;
134   other.fZeroSuppression=fZeroSuppression;
135   other.fChargeCorrel=fChargeCorrel;
136   delete other.fMathieson;
137   other.fMathieson = new AliMUONMathieson(*fMathieson);
138   other.fChargeThreshold=fChargeThreshold;
139 }
140
141 //______________________________________________________________________________
142 void
143 AliMUONResponseV0::Print(Option_t*) const
144 {
145 /// Printing
146
147   cout << " ChargeSlope=" << fChargeSlope
148     << " ChargeSpreadX,Y=" << fChargeSpreadX
149     << fChargeSpreadY
150     << " ChargeCorrelation=" << fChargeCorrel
151     << endl;
152 }
153
154   //__________________________________________________________________________
155 void AliMUONResponseV0::SetSqrtKx3AndDeriveKx2Kx4(Float_t SqrtKx3)
156 {
157   /// Set to "SqrtKx3" the Mathieson parameter K3 ("fSqrtKx3")
158   /// in the X direction, perpendicular to the wires,
159   /// and derive the Mathieson parameters K2 ("fKx2") and K4 ("fKx4")
160   /// in the same direction
161   fMathieson->SetSqrtKx3AndDeriveKx2Kx4(SqrtKx3);
162 }
163         
164   //__________________________________________________________________________
165 void AliMUONResponseV0::SetSqrtKy3AndDeriveKy2Ky4(Float_t SqrtKy3)
166 {
167   /// Set to "SqrtKy3" the Mathieson parameter K3 ("fSqrtKy3")
168   /// in the Y direction, along the wires,
169   /// and derive the Mathieson parameters K2 ("fKy2") and K4 ("fKy4")
170   /// in the same direction
171   fMathieson->SetSqrtKy3AndDeriveKy2Ky4(SqrtKy3);
172 }
173   //__________________________________________________________________________
174 Float_t AliMUONResponseV0::IntPH(Float_t eloss) const
175 {
176   /// Calculate charge from given ionization energy loss
177   Int_t nel;
178   nel= Int_t(eloss*1.e9/27.4);
179   Float_t charge=0;
180   if (nel == 0) nel=1;
181   for (Int_t i=1;i<=nel;i++) {
182       Float_t arg=0.;
183       while(!arg) arg = gRandom->Rndm();
184       charge -= fChargeSlope*TMath::Log(arg);    
185   }
186   return charge;
187 }
188
189 //_____________________________________________________________________________
190 Float_t
191 AliMUONResponseV0::GetAnod(Float_t x) const
192 {
193   /// Return wire coordinate closest to x.
194
195   Int_t n = Int_t(x/Pitch());
196   Float_t wire = (x>0) ? n+0.5 : n-0.5;
197   return Pitch()*wire;
198 }
199
200 //______________________________________________________________________________
201 void 
202 AliMUONResponseV0::DisIntegrate(const AliMUONHit& hit, TList& digits)
203 {
204   /// Go from 1 hit to a list of digits.
205   /// The energy deposition of that hit is first converted into charge
206   /// (in IntPH() method), and then this charge is dispatched on several
207   /// pads, according to the Mathieson distribution.
208   
209   digits.Clear();
210   
211   Int_t detElemId = hit.DetElemId();
212   
213   // Width of the integration area
214   Double_t dx = SigmaIntegration()*ChargeSpreadX();
215   Double_t dy = SigmaIntegration()*ChargeSpreadY();
216   
217   // Use that (dx,dy) to specify the area upon which
218   // we will iterate to spread charge into.
219   Double_t x,y,z;
220   Global2Local(detElemId,hit.X(),hit.Y(),hit.Z(),x,y,z);
221   x = GetAnod(x);
222   TVector2 hitPosition(x,y);
223   AliMpArea area(hitPosition,TVector2(dx,dy));
224   
225   // Get pulse height from energy loss.
226   Float_t qtot = IntPH(hit.Eloss());
227   
228   // Get the charge correlation between cathodes.
229   Float_t currentCorrel = TMath::Exp(gRandom->Gaus(0.0,ChargeCorrel()/2.0));
230
231   for ( Int_t cath = AliMp::kCath0; cath <= AliMp::kCath1; ++cath )
232   {
233     Float_t qcath = qtot * ( cath == 0 ? currentCorrel : 1.0/currentCorrel);
234     
235     // Get an iterator to loop over pads, within the given area.
236     const AliMpVSegmentation* seg = 
237         AliMpSegmentation::Instance()
238           ->GetMpSegmentation(detElemId,AliMp::GetCathodType(cath));
239       
240     AliMpVPadIterator* it = seg->CreateIterator(area);
241       
242     if (!it)
243     {
244       AliError(Form("Could not get iterator for detElemId %d",detElemId));
245       return;
246     }
247     
248     // Start loop over pads.
249     it->First();
250     
251     if ( it->IsDone() )
252     {
253       // Exceptional case : iterator is built, but is invalid from the start.
254       AliMpPad pad = seg->PadByPosition(area.Position(),kFALSE);
255       if ( pad.IsValid() )
256       {
257         AliWarning(Form("Got an invalid iterator bug (area.Position() is within "
258                       " DE but the iterator is void) for detElemId %d cath %d",
259                       detElemId,cath));        
260       }
261       else
262       {
263         AliError(Form("Got an invalid iterator bug for detElemId %d cath %d."
264                       "Might be a bad hit ? area.Position()=(%e,%e) "
265                       "Dimensions()=(%e,%e)",
266                       detElemId,cath,area.Position().X(),area.Position().Y(),
267                       area.Dimensions().X(),area.Dimensions().Y()));
268       }
269       delete it;
270       return;
271     }
272     
273     while ( !it->IsDone() )
274     {
275       // For each pad given by the iterator, compute the charge of that
276       // pad, according to the Mathieson distribution.
277       AliMpPad pad = it->CurrentItem();      
278       TVector2 lowerLeft(hitPosition-pad.Position()-pad.Dimensions());
279       TVector2 upperRight(lowerLeft + pad.Dimensions()*2.0);
280       Float_t qp = TMath::Abs(fMathieson->IntXY(lowerLeft.X(),lowerLeft.Y(),
281                                                 upperRight.X(),upperRight.Y()));
282             
283       Int_t icharge = Int_t(qp*qcath);
284       
285       if ( qp > fChargeThreshold )
286       {
287         // If we're above threshold, then we create a digit,
288         // and fill it with relevant information, including electronics.
289         AliMUONDigit* d = new AliMUONDigit(detElemId,pad.GetLocation().GetFirst(),
290                                            pad.GetLocation().GetSecond(),cath);
291         d->SetPadXY(pad.GetIndices().GetFirst(),pad.GetIndices().GetSecond());
292         d->SetCharge(icharge);
293         digits.Add(d);   
294       }       
295       it->Next();
296     }
297     delete it;
298   }
299 }
300
301
302