adding the HLT offline QA skeleton
[u/mrichter/AliRoot.git] / MUON / AliMUONv1.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 purpeateose. It is      *
13  * provided "as is" without express or implied warranty.                  *
14  **************************************************************************/
15
16 /* $Id$ */
17
18 //-----------------------------------------------------------------------------
19 // Class AliMUONv1
20 // --------------------
21 // AliDetector class for MUON subsystem which implements
22 // functions for simulation 
23 //-----------------------------------------------------------------------------
24
25 #include "AliMUONv1.h"
26 #include "AliMUONConstants.h"
27 #include "AliMUONResponseFactory.h"
28 #include "AliMUONHit.h"
29 #include "AliMUONGeometryBuilder.h"     
30 #include "AliMUONGeometry.h"    
31 #include "AliMUONGeometryTransformer.h" 
32 #include "AliMUONGeometryModule.h"      
33 #include "AliMUONStringIntMap.h"        
34 #include "AliMUONGeometryDetElement.h"  
35
36 #include "AliMpCDB.h"
37 #include "AliMpDEManager.h"
38
39 #include "AliConst.h" 
40 #include "AliMagF.h"
41 #include "AliRun.h"
42 #include "AliMC.h"
43 #include "AliTrackReference.h"
44 #include "AliLog.h"
45
46 #include <TClonesArray.h>
47 #include <TF1.h>
48 #include <TF2.h>
49 #include <TGeoGlobalMagField.h>
50 #include <TGeoMatrix.h>
51 #include <TRandom.h>
52 #include <TRandom.h> 
53 #include <TVirtualMC.h>
54
55 #include <string>
56
57 #include "AliMUONVHitStore.h"
58
59 /// \cond CLASSIMP
60 ClassImp(AliMUONv1)
61 /// \endcond
62  
63 //___________________________________________
64 AliMUONv1::AliMUONv1() 
65   : AliMUON(),
66     fAngleEffect(kTRUE),
67     fMagEffect(kTRUE),
68     fStepMaxInActiveGas(0.6),
69     fStepSum(0x0),
70     fDestepSum(0x0),
71     fTrackMomentum(), 
72     fTrackPosition(),
73     fElossRatio(0x0),
74     fAngleEffect10(0x0),
75     fAngleEffectNorma(0x0),
76     fMagAngleEffectNorma(0x0)
77 {
78 /// Default constructor
79   
80   AliDebug(1,Form("default (empty) ctor this=%p",this));
81
82
83 //___________________________________________
84 AliMUONv1::AliMUONv1(const char *name, const char* title)
85 : AliMUON(name, title), 
86     fAngleEffect(kTRUE),
87     fMagEffect(kTRUE),
88     fStepMaxInActiveGas(0.6),
89     fStepSum(0x0),
90     fDestepSum(0x0),
91     fTrackMomentum(), 
92     fTrackPosition(),
93     fElossRatio(0x0),
94     fAngleEffect10(0x0),
95     fAngleEffectNorma(0x0),
96     fMagAngleEffectNorma(0x0)
97 {
98 /// Standard onstructor
99
100     AliDebug(1,Form("ctor this=%p",this));      
101         
102     // Load mapping
103     if ( ! AliMpCDB::LoadMpSegmentation() ) {
104       AliFatal("Could not access mapping from OCDB !");
105     }
106        
107     // By default include all stations
108
109     fStepSum   = new Float_t [AliMUONConstants::NCh()];
110     fDestepSum = new Float_t [AliMUONConstants::NCh()];
111     for (Int_t i=0; i<AliMUONConstants::NCh(); i++) {
112       fStepSum[i] =0.0;
113       fDestepSum[i]=0.0;
114     }
115     // Ratio of particle mean eloss with respect MIP's Khalil Boudjemline, sep 2003, PhD.Thesis and Particle Data Book
116     fElossRatio = new TF1("ElossRatio","[0]+[1]*x+[2]*x*x+[3]*x*x*x+[4]*x*x*x*x",0.5,5.); 
117     fElossRatio->SetParameter(0,1.02138);
118     fElossRatio->SetParameter(1,-9.54149e-02);
119     fElossRatio->SetParameter(2,+7.83433e-02); 
120     fElossRatio->SetParameter(3,-9.98208e-03);
121     fElossRatio->SetParameter(4,+3.83279e-04);
122
123     // Angle effect in tracking chambers at theta =10 degres as a function of ElossRatio (Khalil BOUDJEMLINE sep 2003 Ph.D Thesis) (in micrometers)
124     fAngleEffect10 = new TF1("AngleEffect10","[0]+[1]*x+[2]*x*x",0.5,3.0);
125     fAngleEffect10->SetParameter(0, 1.90691e+02);
126     fAngleEffect10->SetParameter(1,-6.62258e+01);
127     fAngleEffect10->SetParameter(2,+1.28247e+01);
128     // Angle effect: Normalisation form theta=10 degres to theta between 0 and 10 (Khalil BOUDJEMLINE sep 2003 Ph.D Thesis)  
129     // Angle with respect to the wires assuming that chambers are perpendicular to the z axis.
130     fAngleEffectNorma = new TF1("AngleEffectNorma","[0]+[1]*x+[2]*x*x+[3]*x*x*x",0.0,10.0);
131     fAngleEffectNorma->SetParameter(0,4.148);
132     fAngleEffectNorma->SetParameter(1,-6.809e-01);
133     fAngleEffectNorma->SetParameter(2,5.151e-02);
134     fAngleEffectNorma->SetParameter(3,-1.490e-03);
135
136     // Magnetic field effect: Normalisation form theta=16 degres (eq. 10 degrees B=0) to theta between -20 and 20 (Lamia Benhabib jun 2006 )  
137     // Angle with respect to the wires assuming that chambers are perpendicular to the z axis.
138     fMagAngleEffectNorma = new TF2("MagAngleEffectNorma","121.24/(([1]+[2]*abs(y))+[3]*abs(x-[0]*y)+[4]*abs((x-[0]*y)*(x-[0]*y))+[5]*abs((x-[0]*y)*(x-[0]*y)*(x-[0]*y))+[6]*abs((x-[0]*y)*(x-[0]*y)*(x-[0]*y)*(x-[0]*y)))",-20.0,20.0,-1.,1.);
139     fMagAngleEffectNorma->SetParameters(8.6995, 25.4022, 13.8822, 2.4717, 1.1551, -0.0624, 0.0012);
140 }
141
142 //___________________________________________
143 AliMUONv1::~AliMUONv1()
144 {
145 /// Destructor
146   
147   AliDebug(1,Form("dtor this=%p",this));
148   delete [] fStepSum;
149   delete [] fDestepSum;
150   delete fElossRatio;
151   delete fAngleEffect10;
152   delete fAngleEffectNorma; 
153   delete fMagAngleEffectNorma;
154 }
155
156 //__________________________________________________
157 void AliMUONv1::CreateGeometry()
158 {
159 /// Construct geometry using geometry builder
160
161   fGeometryBuilder->CreateGeometry();
162 }
163
164 //________________________________________________________________
165 void AliMUONv1::CreateMaterials()
166 {
167 /// Construct materials using geometry builder
168
169   fGeometryBuilder->CreateMaterials();
170 }
171
172 //________________________________________________________________
173 void AliMUONv1::UpdateInternalGeometry()
174 {
175 /// Update geometry after applying mis-alignment
176
177   fGeometryBuilder->UpdateInternalGeometry();
178 }
179
180 //________________________________________________________________
181 void AliMUONv1::AddAlignableVolumes() const
182 {
183 /// Construct materials using geometry builder
184
185   GetGeometryTransformer()->AddAlignableVolumes();
186 }
187
188
189 //___________________________________________
190 void AliMUONv1::Init()
191
192 /// Initialize geometry
193
194   AliDebug(1,"Start Init for version 1 - CPC chamber type");
195    
196   fGeometryBuilder->InitGeometry();
197   AliDebug(1,"Finished Init for version 1 - CPC chamber type");   
198  
199
200   // Build segmentation
201   // using geometry parametrisation
202   //
203   // Build response
204   //
205   AliMUONResponseFactory respFactory("default", fIsTailEffect);
206   respFactory.Build(this);
207   
208 }
209
210 //__________________________________________________________________
211 Int_t  AliMUONv1::GetGeomModuleId(Int_t volId) const
212 {
213 /// Check if the volume with specified  volId is a sensitive volume (gas) 
214 /// of some chamber and return the chamber number;
215 /// if not sensitive volume - return 0.
216
217   for (Int_t i = 0; i < AliMUONConstants::NGeomModules(); i++) {
218     if ( GetGeometry()->GetModule(i)->IsSensitiveVolume(volId) )
219       return i;
220   }    
221
222   return -1;
223 }
224
225 //_______________________________________________________________________________
226 TString  AliMUONv1::CurrentVolumePath() const
227 {
228 /// Return current volume path
229 /// (Could be removed when this function is available via gMC)
230
231   TString path = "";
232   TString name;
233   Int_t copyNo;
234   Int_t imother = 0;
235   do {
236     name = gMC->CurrentVolOffName(imother);
237     gMC->CurrentVolOffID(imother++, copyNo);
238     TString add = "/";
239     add += name;
240     add += "_";
241     add += copyNo;
242     path.Insert(0,add); 
243   }
244   while ( name != TString("ALIC") );
245   
246   return path;  
247 }
248
249 //_______________________________________________________________________________
250 void AliMUONv1::StepManager()
251 {
252 /// Step manager for the chambers
253
254   // Only charged tracks
255   if( !(gMC->TrackCharge()) ) return; 
256   // Only charged tracks
257   
258   // Only gas gap inside chamber
259   // Tag chambers and record hits when track enters 
260   static Int_t   idvol=-1, iEnter = 0;
261   Int_t   copy;
262   const  Float_t kBig = 1.e10;
263   static Double_t xyzEnter[3];
264
265   //
266   // Only gas gap inside chamber
267   // Tag chambers and record hits when track enters 
268   Int_t id=gMC->CurrentVolID(copy);
269   Int_t iGeomModule = GetGeomModuleId(id);
270   if (iGeomModule == -1) return;
271
272   // Detection elements id
273   const AliMUONGeometryModule* kGeometryModule
274     = GetGeometry()->GetModule(iGeomModule);
275   AliMUONGeometryDetElement* detElement
276     = kGeometryModule->FindBySensitiveVolume(CurrentVolumePath());
277     
278   if (!detElement && iGeomModule < AliMUONConstants::NGeomModules()-2) {
279     iGeomModule++;
280     const AliMUONGeometryModule* kGeometryModule2
281       = GetGeometry()->GetModule(iGeomModule);
282     detElement 
283       = kGeometryModule2->FindBySensitiveVolume(CurrentVolumePath());
284   }    
285
286   Int_t detElemId = 0;
287   if (detElement) detElemId = detElement->GetUniqueID(); 
288  
289   if (!detElemId) {
290     AliErrorStream() 
291          << "Geometry module id: "
292          << setw(3) << iGeomModule << "  "
293          << "Current SV: " 
294          <<  CurrentVolumePath() 
295          << "  detElemId: "
296          << setw(5) << detElemId 
297          << endl;
298     Double_t x, y, z;
299     gMC->TrackPosition(x, y, z);         
300     AliErrorStream() 
301          << "   global position: "
302          << x << ", " << y << ", " << z
303          << endl;
304     AliErrorStream() << "DetElemId not identified." << endl;
305   } 
306   
307   Int_t iChamber = AliMpDEManager::GetChamberId(detElemId) + 1; 
308   idvol = iChamber -1;
309     
310   // Filling TrackRefs file for MUON. Our Track references are the active volume of the chambers
311   if ( (gMC->IsTrackEntering() || gMC->IsTrackExiting() ) ) {
312     AliTrackReference* trackReference    
313       = AddTrackReference(gAlice->GetMCApp()->GetCurrentTrackNumber(), AliTrackReference::kMUON);
314     trackReference->SetUserId(detElemId);
315   }  
316   
317   if( gMC->IsTrackEntering() ) {
318      Float_t theta = fTrackMomentum.Theta();
319      if ((TMath::Pi()-theta)*kRaddeg>=15.) gMC->SetMaxStep(fStepMaxInActiveGas); // We use Pi-theta because z is negative
320      iEnter = 1;
321      gMC->TrackPosition(xyzEnter[0], xyzEnter[1], xyzEnter[2]); // save coordinates of entrance point
322   }
323
324    //   AliDebug(1,
325    //       Form("Active volume found %d chamber %d Z chamber is %f ",idvol,iChamber,
326    //            ( (AliMUONChamber*)(*fChambers)[idvol])->Z())) ;
327   // Particule id and mass, 
328   Int_t     ipart = gMC->TrackPid();
329   Float_t   mass  = gMC->TrackMass();
330
331   fDestepSum[idvol]+=gMC->Edep();
332   // Get current particle id (ipart), track position (pos)  and momentum (mom)
333   if ( fStepSum[idvol]==0.0 )  gMC->TrackMomentum(fTrackMomentum);
334   fStepSum[idvol]+=gMC->TrackStep();
335   
336   //  if (AliDebugLevel()) {
337   //   AliDebug(1,Form("Step, iChamber %d, Particle %d, theta %f phi %f mass %f StepSum %f eloss %g",
338   //                 iChamber,ipart, fTrackMomentum.Theta()*kRaddeg, fTrackMomentum.Phi()*kRaddeg,
339   //         mass, fStepSum[idvol], gMC->Edep()));
340   // AliDebug(1,Form("Step:Track Momentum %f %f %f", fTrackMomentum.X(), fTrackMomentum.Y(), 
341   //         fTrackMomentum.Z()));
342   // gMC->TrackPosition(fTrackPosition);
343   // AliDebug(1,Form("Step: Track Position %f %f %f",fTrackPosition.X(),
344   //         fTrackPosition.Y(),fTrackPosition.Z())) ;
345   //}
346
347   // Track left chamber or StepSum larger than fStepMaxInActiveGas
348   if ( gMC->IsTrackExiting() || 
349        gMC->IsTrackStop() || 
350        gMC->IsTrackDisappeared()||
351        (fStepSum[idvol]>fStepMaxInActiveGas) ) {
352     
353     if   ( gMC->IsTrackExiting() || 
354            gMC->IsTrackStop() || 
355            gMC->IsTrackDisappeared() ) gMC->SetMaxStep(kBig);
356     if (fDestepSum[idvol] == 0) {
357       // AZ - no energy release
358       fStepSum[idvol] = 0; // Reset for the next event
359       iEnter = 0;
360       return; 
361     }
362
363     gMC->TrackPosition(fTrackPosition);
364     Float_t theta = fTrackMomentum.Theta();
365     Float_t phi   = fTrackMomentum.Phi();
366     
367     Int_t merge = 0;
368     Double_t xyz0[3]={0}, xyz1[3]={0}, tmp[3]={0};
369     if (gMC->IsTrackExiting() && iEnter != 0) {
370       // AZ - this code is to avoid artificial hit splitting at the
371       // "fake" boundary inside the same chamber. It will still produce 
372       // 2 hits but with the same coordinates (at the wire) to allow 
373       // their merging at the digitization level.
374
375       // Only for a track going from the entrance to the exit from the volume
376       // Get local coordinates
377       gMC->Gmtod(xyzEnter, xyz0, 1); // local coord. at the entrance
378
379       fTrackPosition.Vect().GetXYZ(tmp);
380       gMC->Gmtod(tmp, xyz1, 1); // local coord. at the exit
381       Float_t dx = xyz0[0] - xyz1[0];
382       Float_t dy = xyz0[1] - xyz1[1];
383       Float_t thLoc = TMath::ATan2 (TMath::Sqrt(dx*dx+dy*dy), TMath::Abs(xyz0[2]-xyz1[2]));
384       if (thLoc * TMath::RadToDeg() < 15) merge = 1; 
385     }
386
387     if (merge) {
388       Double_t dz = -0.5;
389       if (xyz1[2] != xyz0[2]) dz = xyz0[2] / (xyz1[2] - xyz0[2]);
390       tmp[0] = xyz0[0] - (xyz1[0] - xyz0[0]) * dz; // local coord. at the wire
391       tmp[1] = xyz0[1] - (xyz1[1] - xyz0[1]) * dz;
392       tmp[2] = xyz0[2] - (xyz1[2] - xyz0[2]) * dz;
393       gMC->Gdtom(tmp, xyz1, 1); // global coord. at the wire
394       fTrackPosition.SetXYZT(xyz1[0], xyz1[1], xyz1[2], fTrackPosition.T());
395     } else {
396       TLorentzVector backToWire( fStepSum[idvol]/2.*sin(theta)*cos(phi),
397                                  fStepSum[idvol]/2.*sin(theta)*sin(phi),
398                                  fStepSum[idvol]/2.*cos(theta),0.0       );
399       fTrackPosition-=backToWire;
400       //printf(" %d %d %d %f %d \n", gMC->IsTrackExiting(), gMC->IsTrackStop(), gMC->IsTrackDisappeared(), fStepSum[idvol], iEnter);
401       //    AliDebug(1,
402       //     Form("Track Position %f %f %f",fTrackPosition.X(),fTrackPosition.Y(),fTrackPosition.Z()));
403       // AliDebug(1,
404       //     Form("Exit: Track backToWire %f %f %f",backToWire.X(),backToWire.Y(),backToWire.Z())) ;
405     }
406     
407     //-------------- Angle effect 
408     // Ratio between energy loss of particle and Mip as a function of BetaGamma of particle (Energy/Mass)
409     
410     Float_t betaxGamma    = fTrackMomentum.P()/mass;//  pc/mc2
411     Float_t sigmaEffect10degrees;
412     Float_t sigmaEffectThetadegrees;
413     Float_t eLossParticleELossMip;
414     Float_t yAngleEffect=0.;
415     Float_t thetawires      =  TMath::ASin( TMath::Sin(TMath::Pi()-theta) * TMath::Sin(phi) ) ;// We use Pi-theta because z is negative
416     Double_t bField[3] = {0};
417     fTrackPosition.Vect().GetXYZ(tmp);
418     TGeoGlobalMagField::Instance()->Field(tmp,bField);
419
420     if (fAngleEffect && !fMagEffect){
421       thetawires = TMath::Abs(thetawires);
422     if ( (betaxGamma >3.2)   &&  (thetawires*kRaddeg<=15.) ) {
423       betaxGamma=TMath::Log(betaxGamma);
424       eLossParticleELossMip = fElossRatio->Eval(betaxGamma);
425       // 10 degrees is a reference for a model (arbitrary)
426       sigmaEffect10degrees=fAngleEffect10->Eval(eLossParticleELossMip);// in micrometers
427       // Angle with respect to the wires assuming that chambers are perpendicular to the z axis.
428       sigmaEffectThetadegrees =  sigmaEffect10degrees/fAngleEffectNorma->Eval(thetawires*kRaddeg);  // For 5mm gap  
429       if ( (iChamber==1)  ||  (iChamber==2) )  
430         sigmaEffectThetadegrees/=(1.09833e+00+1.70000e-02*(thetawires*kRaddeg)); // The gap is different (4mm)
431       yAngleEffect=1.e-04*gRandom->Gaus(0,sigmaEffectThetadegrees); // Error due to the angle effect in cm
432     }
433     }
434     else if (fAngleEffect && fMagEffect) {
435       if ( (betaxGamma >3.2)   &&  (TMath::Abs(thetawires*kRaddeg)<=15.) ) {
436         betaxGamma=TMath::Log(betaxGamma);
437         eLossParticleELossMip = fElossRatio->Eval(betaxGamma);
438         // 10 degrees is a reference for a model (arbitrary)
439         sigmaEffect10degrees=fAngleEffect10->Eval(eLossParticleELossMip);// in micrometers
440         // Angle with respect to the wires assuming that chambers are perpendicular to the z axis.
441         sigmaEffectThetadegrees =  sigmaEffect10degrees/fMagAngleEffectNorma->Eval(thetawires*kRaddeg,bField[0]/10.);  // For 5mm gap  
442       if ( (iChamber==1)  ||  (iChamber==2) )  
443         sigmaEffectThetadegrees/=(1.09833e+00+1.70000e-02*(thetawires*kRaddeg)); // The gap is different (4mm)
444         yAngleEffect=1.e-04*gRandom->Gaus(0,sigmaEffectThetadegrees); // Error due to the angle effect in cm
445       }
446     }
447
448     AliMUONHit hit(fIshunt, 
449                    gAlice->GetMCApp()->GetCurrentTrackNumber(), 
450                    detElemId, ipart,
451                    fTrackPosition.X(), 
452                    fTrackPosition.Y()+yAngleEffect, 
453                    fTrackPosition.Z(), 
454                    gMC->TrackTime(),
455                    fTrackMomentum.P(),
456                    theta, 
457                    phi, 
458                    fStepSum[idvol], 
459                    fDestepSum[idvol],                        
460                    fTrackPosition.X(),
461                    fTrackPosition.Y(),
462                    fTrackPosition.Z());
463     
464     fHitStore->Add(hit);
465
466     fStepSum[idvol]  =0; // Reset for the next event
467     fDestepSum[idvol]=0; // Reset for the next event
468     iEnter = 0;
469   }
470 }