Rename AliPHOSReconstructioner to AliPHOSReconstructor
[u/mrichter/AliRoot.git] / PHOS / AliPHOSTrackSegmentMakerv1.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 /* $Id$ */
16 //_________________________________________________________________________
17 // Implementation version 1 of algorithm class to construct PHOS track segments
18 // Track segment for PHOS is list of 
19 //        EMC RecPoint + (possibly) CPV RecPoint + (possibly) PPSD RecPoint
20 // To find TrackSegments we do the following: 
21 //  for each EMC RecPoints we look at
22 //   CPV/PPSD RecPoints in the radious fRcpv. 
23 //  If there is such a CPV RecPoint, 
24 //   we make "Link" it is just indexes of EMC and CPV/PPSD RecPoint and distance
25 //   between them in the PHOS plane. 
26 //  Then we sort "Links" and starting from the 
27 //   least "Link" pointing to the unassined EMC and CPV RecPoints assing them to 
28 //   new TrackSegment. 
29 // If there is no CPV/PPSD RecPoint we make TrackSegment 
30 // consisting from EMC alone. There is no TrackSegments without EMC RecPoint.
31 //// In principle this class should be called from AliPHOSReconstructor, but 
32 // one can use it as well in standalone mode.
33 // Use  case:
34 //  root [0] AliPHOSTrackSegmentMakerv1 * t = new AliPHOSTrackSegmentMaker("galice.root", "tracksegmentsname", "recpointsname")
35 //  Warning in <TDatabasePDG::TDatabasePDG>: object already instantiated
36 //               // reads gAlice from header file "galice.root", uses recpoints stored in the branch names "recpointsname" (default = "Default")
37 //               // and saves recpoints in branch named "tracksegmentsname" (default = "recpointsname")                       
38 //  root [1] t->ExecuteTask()
39 //  root [2] t->SetMaxEmcPpsdDistance(5)
40 //  root [3] t->SetTrackSegmentsBranch("max distance 5 cm")
41 //  root [4] t->ExecuteTask("deb all time") 
42 //                 
43 //*-- Author: Dmitri Peressounko (RRC Ki & SUBATECH) & Yves Schutz (SUBATECH) 
44 //
45
46 // --- ROOT system ---
47 #include "TTree.h"
48 #include "TBenchmark.h"
49
50 // --- Standard library ---
51
52 // --- AliRoot header files ---
53 #include "AliPHOSGeometry.h"
54 #include "AliPHOSTrackSegmentMakerv1.h"
55 #include "AliPHOSTrackSegment.h"
56 #include "AliPHOSLink.h"
57 #include "AliPHOSGetter.h"
58 #include "AliESD.h"
59 #include "AliESDtrack.h"
60
61 ClassImp( AliPHOSTrackSegmentMakerv1) 
62
63
64 //____________________________________________________________________________
65   AliPHOSTrackSegmentMakerv1::AliPHOSTrackSegmentMakerv1() : AliPHOSTrackSegmentMaker()
66 {
67   // default ctor (to be used mainly by Streamer)
68
69   InitParameters() ; 
70   fDefaultInit = kTRUE ; 
71 }
72
73 //____________________________________________________________________________
74  AliPHOSTrackSegmentMakerv1::AliPHOSTrackSegmentMakerv1(const TString alirunFileName, const TString eventFolderName)
75    :AliPHOSTrackSegmentMaker(alirunFileName, eventFolderName)
76 {
77   // ctor
78
79   InitParameters() ; 
80   Init() ;
81   fDefaultInit = kFALSE ; 
82   fESD = 0;
83 }
84
85 //____________________________________________________________________________
86  AliPHOSTrackSegmentMakerv1::~AliPHOSTrackSegmentMakerv1()
87
88   // dtor
89   // fDefaultInit = kTRUE if TrackSegmentMaker created by default ctor (to get just the parameters)
90   if (!fDefaultInit)  
91     delete fLinkUpArray ;
92 }
93
94
95 //____________________________________________________________________________
96 const TString AliPHOSTrackSegmentMakerv1::BranchName() const 
97 {  
98  
99   return GetName() ;
100 }
101
102 //____________________________________________________________________________
103 void  AliPHOSTrackSegmentMakerv1::FillOneModule()
104 {
105   // Finds first and last indexes between which 
106   // clusters from one PHOS module are
107
108   AliPHOSGetter * gime = AliPHOSGetter::Instance() ; 
109   
110   TObjArray * emcRecPoints = gime->EmcRecPoints() ; 
111   TObjArray * cpvRecPoints = gime->CpvRecPoints() ; 
112  
113   //First EMC clusters
114   Int_t totalEmc = emcRecPoints->GetEntriesFast() ;
115   for(fEmcFirst = fEmcLast; (fEmcLast < totalEmc) &&  
116         ((dynamic_cast<AliPHOSRecPoint *>(emcRecPoints->At(fEmcLast)))->GetPHOSMod() == fModule ); 
117       fEmcLast ++)  ;
118   
119   //Now CPV clusters
120   Int_t totalCpv = cpvRecPoints->GetEntriesFast() ;
121
122     for(fCpvFirst = fCpvLast; (fCpvLast < totalCpv) && 
123          ((dynamic_cast<AliPHOSRecPoint *>(cpvRecPoints->At(fCpvLast)))->GetPHOSMod() == fModule ); 
124        fCpvLast ++) ;
125       
126 }
127
128 //____________________________________________________________________________
129 Float_t  AliPHOSTrackSegmentMakerv1::GetDistanceInPHOSPlane(AliPHOSEmcRecPoint * emcClu,AliPHOSCpvRecPoint * cpvClu, Bool_t &toofar) const
130 {
131   // Calculates the distance between the EMC RecPoint and the PPSD RecPoint
132   // Clusters are sorted in "rows" and "columns" of width 1 cm
133
134   Float_t delta = 1 ;  // Width of the rows in sorting of RecPoints (in cm)
135                        // if you change this value, change it as well in xxxRecPoint::Compare()
136   Float_t distance = fRcpv ;
137  
138   TVector3 vecEmc ;   // Local position of EMC recpoint
139   TVector3 vecCpv ;   // Local position of CPV recpoint propagated to EMC
140   TVector3 vecDist ;  // Distance between local positions of two points
141   
142   emcClu->GetLocalPosition(vecEmc) ;
143   cpvClu->GetLocalPosition(vecCpv) ;
144
145   toofar = kTRUE ;
146   if(emcClu->GetPHOSMod() == cpvClu->GetPHOSMod()){ 
147
148     if (fESD != 0x0) {
149       // Extrapolate the global track direction if any to CPV and find the closest track
150       Int_t nTracks = fESD->GetNumberOfTracks();
151       Int_t iClosestTrack = -1;
152       Double_t minDistance = 1e6;
153       Double_t pxyz[3], xyz[3];
154       AliESDtrack *track;
155       for (Int_t iTrack=0; iTrack<nTracks; iTrack++) {
156         track = fESD->GetTrack(iTrack);
157         track->GetOuterXYZ(xyz);     // track coord on the cylinder of PHOS radius
158         if ((TMath::Abs(xyz[0])+TMath::Abs(xyz[1])+TMath::Abs(xyz[2]))<=0)
159           continue;
160         track->GetOuterPxPyPz(pxyz); // track momentum ibid.
161         vecDist = PropagateToPlane(xyz,pxyz,"CPV",cpvClu->GetPHOSMod());
162 //      Info("GetDistanceInPHOSPlane","Track %d propagation to CPV = (%f,%f,%f)",
163 //           iTrack,vecDist.X(),vecDist.Y(),vecDist.Z());
164         vecDist -= vecCpv;
165         distance = TMath::Sqrt(vecDist.X()*vecDist.X() + vecDist.Z()*vecDist.Z());
166         // Find the closest track to the EMC recpoint
167         if (distance < minDistance) {
168           minDistance = distance;
169           iClosestTrack = iTrack;
170         }
171       }
172
173       if (iClosestTrack != -1) {
174         track = fESD->GetTrack(iClosestTrack);
175         track->GetOuterPxPyPz(pxyz); // track momentum ibid.
176         TVector3 vecCpvGlobal; // Global position of the CPV recpoint
177         AliPHOSGetter * gime = AliPHOSGetter::Instance() ; 
178         const AliPHOSGeometry * geom = gime->PHOSGeometry() ; 
179         geom->GetGlobal((AliRecPoint*)cpvClu,vecCpvGlobal);
180         for (Int_t ixyz=0; ixyz<3; ixyz++)
181           xyz[ixyz] = vecCpvGlobal[ixyz];
182         vecDist = PropagateToPlane(xyz,pxyz,"EMC",cpvClu->GetPHOSMod());
183 //      Info("GetDistanceInPHOSPlane","Track %d propagation to EMC = (%f,%f,%f)",
184 //           iClosestTrack,vecDist.X(),vecDist.Y(),vecDist.Z());
185         vecDist -= vecEmc;
186         distance = TMath::Sqrt(vecDist.X()*vecDist.X() + vecDist.Z()*vecDist.Z());
187       }
188     } else {
189       // If no ESD exists, than simply find EMC-CPV distance
190       distance = (vecCpv - vecEmc).Mag() ;
191     }
192 //     Info("GetDistanceInPHOSPlane","cpv-emc distance is %f cm",
193 //       distance);
194     if(distance < fRcpv + 2*delta )
195       toofar = kFALSE ;
196   }
197   
198   return distance ;
199 }
200
201 //____________________________________________________________________________
202 TVector3  AliPHOSTrackSegmentMakerv1::PropagateToPlane(Double_t *x, Double_t *p,
203                                                        char *det, Int_t moduleNumber) const
204 {
205   // Propagate a straight-line track from the origin point x
206   // along the direction p to the CPV or EMC module moduleNumber
207   // Returns a local position of such a propagation
208
209   AliPHOSGetter * gime = AliPHOSGetter::Instance() ; 
210   const AliPHOSGeometry * geom = gime->PHOSGeometry() ; 
211   TVector3 moduleCenter = geom->GetModuleCenter(det,moduleNumber);
212   TVector3 vertex(x);
213   TVector3 direction(p);
214
215 //   Info("PropagateToCPV","Center of the %s module %d is (%f,%f,%f)",
216 //        det,moduleNumber,moduleCenter[0],moduleCenter[1],moduleCenter[2]);
217
218   Double_t time = (moduleCenter.Mag2() - vertex.Dot(moduleCenter)) /
219     (direction.Dot(moduleCenter));
220   TVector3 globalIntersection = vertex + direction*time;
221   return geom->Global2Local(globalIntersection,moduleNumber);
222 }
223
224 //____________________________________________________________________________
225 void  AliPHOSTrackSegmentMakerv1::Init()
226 {
227   // Make all memory allocations that are not possible in default constructor
228   
229   AliPHOSGetter* gime = AliPHOSGetter::Instance(GetTitle(), fEventFolderName.Data());
230   
231   fLinkUpArray  = new TClonesArray("AliPHOSLink", 1000); 
232   if ( !gime->TrackSegmentMaker() ) {
233     gime->PostTrackSegmentMaker(this);
234   }
235 }
236
237 //____________________________________________________________________________
238 void  AliPHOSTrackSegmentMakerv1::InitParameters()
239 {
240   //Initializes parameters
241   fRcpv      = 10. ;   
242   fEmcFirst  = 0 ;    
243   fEmcLast   = 0 ;   
244   fCpvFirst  = 0 ;   
245   fCpvLast   = 0 ;   
246   fLinkUpArray = 0 ;
247   fTrackSegmentsInRun       = 0 ; 
248   SetEventRange(0,-1) ;
249 }
250
251
252 //____________________________________________________________________________
253 void  AliPHOSTrackSegmentMakerv1::MakeLinks()const
254
255   // Finds distances (links) between all EMC and PPSD clusters, 
256   // which are not further apart from each other than fRcpv 
257   // and sort them in accordance with this distance
258   
259   AliPHOSGetter * gime = AliPHOSGetter::Instance() ; 
260   TObjArray * emcRecPoints = gime->EmcRecPoints() ; 
261   TObjArray * cpvRecPoints = gime->CpvRecPoints() ; 
262
263   fLinkUpArray->Clear() ;    
264
265   AliPHOSCpvRecPoint * cpv ;
266   AliPHOSEmcRecPoint * emcclu ;
267
268   Int_t iLinkUp  = 0 ;
269   
270   Int_t iEmcRP;
271   for(iEmcRP = fEmcFirst; iEmcRP < fEmcLast; iEmcRP++ ) {
272     emcclu = dynamic_cast<AliPHOSEmcRecPoint *>(emcRecPoints->At(iEmcRP)) ;
273
274     Bool_t toofar ;        
275     Int_t iCpv = 0 ;    
276     for(iCpv = fCpvFirst; iCpv < fCpvLast;iCpv++ ) { 
277       
278       cpv = dynamic_cast<AliPHOSCpvRecPoint *>(cpvRecPoints->At(iCpv)) ;
279       Float_t r = GetDistanceInPHOSPlane(emcclu, cpv, toofar) ;
280       
281       if(toofar)
282         break ;  
283       if(r < fRcpv) { 
284         new ((*fLinkUpArray)[iLinkUp++])  AliPHOSLink(r, iEmcRP, iCpv) ;
285       }      
286     }
287   } 
288   
289   fLinkUpArray->Sort() ;  //first links with smallest distances
290 }
291
292 //____________________________________________________________________________
293 void  AliPHOSTrackSegmentMakerv1::MakePairs()
294
295   // Using the previously made list of "links", we found the smallest link - i.e. 
296   // link with the least distance between EMC and CPV and pointing to still 
297   // unassigned RecParticles. We assign these RecPoints to TrackSegment and 
298   // remove them from the list of "unassigned". 
299
300   AliPHOSGetter * gime = AliPHOSGetter::Instance() ; 
301
302   TObjArray * emcRecPoints = gime->EmcRecPoints() ; 
303   TObjArray * cpvRecPoints = gime->CpvRecPoints() ; 
304   TClonesArray * trackSegments = gime->TrackSegments();
305     
306   //Make arrays to mark clusters already chosen
307   Int_t * emcExist = 0;
308   if(fEmcLast > fEmcFirst)
309     emcExist = new Int_t[fEmcLast-fEmcFirst] ;
310   
311   Int_t index;
312   for(index = 0; index <fEmcLast-fEmcFirst; index ++)
313     emcExist[index] = 1 ;
314   
315   Bool_t * cpvExist = 0;
316   if(fCpvLast > fCpvFirst)
317     cpvExist = new Bool_t[fCpvLast-fCpvFirst] ;
318   for(index = 0; index <fCpvLast-fCpvFirst; index ++)
319     cpvExist[index] = kTRUE ;
320   
321   
322   // Finds the smallest links and makes pairs of CPV and EMC clusters with smallest distance 
323   TIter nextUp(fLinkUpArray) ;
324   
325   AliPHOSLink * linkUp ;
326   
327   AliPHOSCpvRecPoint * nullpointer = 0 ;
328   
329   while ( (linkUp =  static_cast<AliPHOSLink *>(nextUp()) ) ){  
330
331     if(emcExist[linkUp->GetEmc()-fEmcFirst] != -1){ //without ppsd Up yet 
332
333       if(cpvExist[linkUp->GetPpsd()-fCpvFirst]){ //CPV still exist
334        
335        new ((* trackSegments)[fNTrackSegments]) 
336          AliPHOSTrackSegment(dynamic_cast<AliPHOSEmcRecPoint *>(emcRecPoints->At(linkUp->GetEmc())) , 
337                              dynamic_cast<AliPHOSCpvRecPoint *>(cpvRecPoints->At(linkUp->GetPpsd()))) ;
338        (dynamic_cast<AliPHOSTrackSegment *>(trackSegments->At(fNTrackSegments)))->SetIndexInList(fNTrackSegments);
339        fNTrackSegments++ ;
340        
341        emcExist[linkUp->GetEmc()-fEmcFirst] = -1 ; //Mark emc  that Cpv was found 
342        //mark CPV recpoint as already used 
343        cpvExist[linkUp->GetPpsd()-fCpvFirst] = kFALSE ;
344       } //if ppsdUp still exist
345     } 
346   }        
347
348   //look through emc recPoints left without CPV/PPSD
349   if(emcExist){ //if there is emc rec point
350     Int_t iEmcRP ;
351     for(iEmcRP = 0; iEmcRP < fEmcLast-fEmcFirst  ; iEmcRP++ ){
352       if(emcExist[iEmcRP] > 0 ){
353        new ((*trackSegments)[fNTrackSegments])  
354          AliPHOSTrackSegment(dynamic_cast<AliPHOSEmcRecPoint *>(emcRecPoints->At(iEmcRP+fEmcFirst)), 
355                            nullpointer) ;
356        (dynamic_cast<AliPHOSTrackSegment *>(trackSegments->At(fNTrackSegments)))->SetIndexInList(fNTrackSegments);
357        fNTrackSegments++;    
358       } 
359     }
360   }
361   delete [] emcExist ; 
362   delete [] cpvExist ; 
363 }
364
365 //____________________________________________________________________________
366 void  AliPHOSTrackSegmentMakerv1::Exec(Option_t *option)
367 {
368   // Steering method to perform track segment construction for events
369   // in the range from fFirstEvent to fLastEvent.
370   // This range is optionally set by SetEventRange().
371   // if fLastEvent=-1 (by default), then process events until the end.
372   
373   if(strstr(option,"tim"))
374     gBenchmark->Start("PHOSTSMaker");
375  
376   if(strstr(option,"print")) {
377     Print() ; 
378     return ; 
379   }
380   
381   AliPHOSGetter * gime = AliPHOSGetter::Instance(GetTitle()) ;  
382  
383   const AliPHOSGeometry * geom = gime->PHOSGeometry() ; 
384
385   if (fLastEvent == -1) fLastEvent = gime->MaxEvent() - 1 ;
386   else fLastEvent = TMath::Min(fFirstEvent,gime->MaxEvent());
387   Int_t nEvents   = fLastEvent - fFirstEvent + 1;
388
389   Int_t ievent ; 
390   for (ievent = fFirstEvent; ievent <= fLastEvent; ievent++) {
391     gime->Event(ievent,"R") ;
392     //Make some initializations 
393     fNTrackSegments = 0 ;
394     fEmcFirst = 0 ;    
395     fEmcLast  = 0 ;   
396     fCpvFirst = 0 ;   
397     fCpvLast  = 0 ;   
398     
399     gime->TrackSegments()->Clear();
400
401     //    if(!ReadRecPoints(ievent))   continue; //reads RecPoints for event ievent
402     
403     for(fModule = 1; fModule <= geom->GetNModules() ; fModule++ ) {
404       FillOneModule() ; 
405       MakeLinks() ;
406       MakePairs() ;
407     }
408
409     WriteTrackSegments() ;
410
411     if(strstr(option,"deb"))
412       PrintTrackSegments(option);
413     
414     //increment the total number of track segments per run 
415     fTrackSegmentsInRun += gime->TrackSegments()->GetEntriesFast() ; 
416
417   }
418   
419   if(strstr(option,"tim")){
420     gBenchmark->Stop("PHOSTSMaker");
421     Info("Exec", "took %f seconds for making TS %f seconds per event", 
422           gBenchmark->GetCpuTime("PHOSTSMaker"), 
423           gBenchmark->GetCpuTime("PHOSTSMaker")/nEvents) ;
424    }
425   Unload();
426 }
427
428 //____________________________________________________________________________
429 void AliPHOSTrackSegmentMakerv1::Unload() 
430 {
431   // Unloads the task from the folder
432   AliPHOSGetter * gime = AliPHOSGetter::Instance() ;  
433   gime->PhosLoader()->UnloadRecPoints() ;
434   gime->PhosLoader()->UnloadTracks() ;
435 }
436
437 //____________________________________________________________________________
438 void AliPHOSTrackSegmentMakerv1::Print()const
439 {
440   //  Print TrackSegmentMaker parameters
441
442   TString message("") ;
443   if( strcmp(GetName(), "") != 0 ) {
444     message = "\n======== AliPHOSTrackSegmentMakerv1 ========\n" ; 
445     message += "Making Track segments\n" ;
446     message += "with parameters:\n" ; 
447     message += "     Maximal EMC - CPV (PPSD) distance (cm) %f\n" ;
448     message += "============================================\n" ;
449     Info("Print", message.Data(),fRcpv) ;
450   }
451   else
452     Info("Print", "AliPHOSTrackSegmentMakerv1 not initialized ") ;
453 }
454
455 //____________________________________________________________________________
456 void AliPHOSTrackSegmentMakerv1::WriteTrackSegments()
457 {
458   // Writes found TrackSegments to TreeR. Creates branches 
459   // "PHOSTS" and "AliPHOSTrackSegmentMaker" with the same title.
460   // In the former branch found TrackSegments are stored, while 
461   // in the latter all parameters, with which TS were made. 
462   // ROOT does not allow overwriting existing branches, therefore
463   // first we check, if branches with the same title already exist.
464   // If yes - exits without writing.
465
466   AliPHOSGetter *gime = AliPHOSGetter::Instance() ; 
467
468   TClonesArray * trackSegments = gime->TrackSegments() ; 
469   trackSegments->Expand(trackSegments->GetEntriesFast()) ;
470
471   TTree * treeT = gime->TreeT();
472  
473   //First TS
474   Int_t bufferSize = 32000 ; 
475   TBranch * tsBranch = treeT->Branch("PHOSTS",&trackSegments,bufferSize);
476   tsBranch->Fill() ;  
477
478   gime->WriteTracks("OVERWRITE");
479   gime->WriteTrackSegmentMaker("OVERWRITE");
480 }
481
482
483 //____________________________________________________________________________
484 void AliPHOSTrackSegmentMakerv1::PrintTrackSegments(Option_t * option)
485 {
486   // option deb - prints # of found TrackSegments
487   // option deb all - prints as well indexed of found RecParticles assigned to the TS
488
489   TClonesArray * trackSegments = AliPHOSGetter::Instance()->TrackSegments() ; 
490
491   Info("PrintTrackSegments", "Results from TrackSegmentMaker:") ; 
492   printf("nevent: %d\n", gAlice->GetEvNumber()) ; 
493   printf("        Found %d TrackSegments\n", trackSegments->GetEntriesFast() ); 
494   
495   if(strstr(option,"all")) {  // printing found TS
496     printf("TrackSegment #  EMC RP#  CPV RP#\n") ; 
497     Int_t index;
498     for (index = 0 ; index <trackSegments->GetEntriesFast() ; index++) {
499       AliPHOSTrackSegment * ts = (AliPHOSTrackSegment * )trackSegments->At(index) ; 
500       printf("   %d           %d        %d \n", ts->GetIndexInList(), ts->GetEmcIndex(), ts->GetCpvIndex() ) ; 
501     }   
502   }
503 }