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