Introduce in the ESD the local trigger decisions (not matched to reconstructed tracks...
[u/mrichter/AliRoot.git] / MUON / AliMUONTracker.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 AliMUONTracker
20 ///
21 /// Steering class for use in global tracking framework;
22 /// reconstruct tracks from recpoints
23 ///
24 /// Actual tracking is performed by some AliMUONVTrackReconstructor children
25 /// Tracking modes (ORIGINAL, KALMAN) and associated options and parameters
26 /// can be changed by using:
27 /// AliMUONRecoParam *muonRecoParam = AliMUONRecoParam::GetLow(High)FluxParam();
28 /// muonRecoParam->Set...(); // see methods in AliMUONRecoParam.h for details
29 /// AliMUONReconstructor::SetRecoParam(muonRecoParam);
30 ///
31 /// \author Christian Finck and Laurent Aphecetche, SUBATECH Nantes
32 //-----------------------------------------------------------------------------
33
34 #include "AliMUONTracker.h"
35
36 #include "AliCodeTimer.h"
37 #include "AliESDEvent.h"
38 #include "AliESDMuonTrack.h"
39 #include "AliESDVertex.h"
40 #include "AliLog.h"
41 #include "AliMUONClusterStoreV2.h"
42 #include "AliMUONESDInterface.h"
43 #include "AliMUONLegacyClusterServer.h"
44 #include "AliMUONRecoParam.h"
45 #include "AliMUONReconstructor.h"
46 #include "AliMUONTrack.h"
47 #include "AliMUONTrackExtrap.h"
48 #include "AliMUONTrackHitPattern.h"
49 #include "AliMUONTrackParam.h"
50 #include "AliMUONTrackReconstructor.h"
51 #include "AliMUONTrackReconstructorK.h"
52 #include "AliMUONTrackStoreV1.h"
53 #include "AliMUONTriggerTrackStoreV1.h"
54 #include "AliMUONTriggerTrack.h"
55 #include "AliMUONLocalTrigger.h"
56 #include "AliMUONVCluster.h"
57 #include "AliMUONVClusterServer.h"
58 #include "AliMUONVDigitStore.h"
59 #include "AliMUONVTriggerStore.h"
60 #include <Riostream.h>
61 #include <TRandom.h>
62 #include <TTree.h>
63
64 /// \cond CLASSIMP
65 ClassImp(AliMUONTracker)
66 /// \endcond
67
68
69 //_____________________________________________________________________________
70 AliMUONTracker::AliMUONTracker(AliMUONVClusterServer* clusterServer,
71                                const AliMUONVDigitStore& digitStore,
72                                const AliMUONDigitMaker* digitMaker,
73                                const AliMUONGeometryTransformer* transformer,
74                                const AliMUONTriggerCircuit* triggerCircuit)
75 : AliTracker(),
76   fDigitMaker(digitMaker), // not owner
77   fTransformer(transformer), // not owner
78   fTriggerCircuit(triggerCircuit), // not owner
79   fTrackHitPatternMaker(0x0),
80   fTrackReco(0x0),
81   fClusterStore(0x0),
82   fTriggerStore(0x0),
83   fClusterServer(clusterServer), 
84   fIsOwnerOfClusterServer(kFALSE),
85   fDigitStore(digitStore), // not owner
86   fInputClusterStore(0x0),
87   fTriggerTrackStore(0x0)
88 {
89   /// constructor
90   if (fTransformer && fDigitMaker)
91     fTrackHitPatternMaker = new AliMUONTrackHitPattern(*fTransformer,*fDigitMaker);
92   
93   if (!fClusterServer)
94   {
95     AliInfo("No cluster server given. Will use AliMUONLegacyClusterServer");
96     fIsOwnerOfClusterServer = kTRUE;
97   }
98   else
99   {
100     TIter next(fDigitStore.CreateIterator());
101     fClusterServer->UseDigits(next);
102     
103     SetupClusterServer(*fClusterServer);
104   }
105 }
106
107 //_____________________________________________________________________________
108 AliMUONTracker::~AliMUONTracker()
109 {
110   /// dtor
111   delete fTrackReco;
112   delete fTrackHitPatternMaker;
113   delete fClusterStore;
114   delete fTriggerStore;
115   if ( fIsOwnerOfClusterServer ) delete fClusterServer;
116   delete fInputClusterStore;
117   delete fTriggerTrackStore;
118 }
119
120 //_____________________________________________________________________________
121 AliMUONVClusterStore*
122 AliMUONTracker::ClusterStore() const
123 {
124   /// Return (and create if necessary) the cluster container
125   if (!fClusterStore) 
126   {
127     fClusterStore = new AliMUONClusterStoreV2;
128   }
129   return fClusterStore;
130 }
131
132 //_____________________________________________________________________________
133 AliMUONVTriggerTrackStore*
134 AliMUONTracker::TriggerTrackStore() const
135 {
136   /// Return (and create if necessary) the trigger track container
137   if (!fTriggerTrackStore) 
138   {
139     fTriggerTrackStore = new AliMUONTriggerTrackStoreV1;
140   }
141   return fTriggerTrackStore;
142 }
143
144 //_____________________________________________________________________________
145 Int_t AliMUONTracker::LoadClusters(TTree* clustersTree)
146 {
147   /// Load triggerStore from clustersTree
148
149   delete fTriggerStore;
150   delete fInputClusterStore;
151   fInputClusterStore=0x0;
152
153   if ( ! clustersTree ) {
154     AliFatal("No clustersTree");
155     return 1;
156   }
157
158   fTriggerStore = AliMUONVTriggerStore::Create(*clustersTree);
159   
160   if (!fTriggerStore)
161   {
162     AliError("Could not get triggerStore");
163     return 2;
164   }
165   
166   if ( fIsOwnerOfClusterServer )
167   {
168     fInputClusterStore = AliMUONVClusterStore::Create(*clustersTree);
169     if ( fInputClusterStore ) 
170     {
171       AliInfo(Form("Created %s from cluster tree",fInputClusterStore->ClassName()));
172       fInputClusterStore->Clear();
173       fInputClusterStore->Connect(*clustersTree,kFALSE);
174     }
175     delete fClusterServer;
176     fClusterServer = new AliMUONLegacyClusterServer(*fTransformer,fInputClusterStore);
177     SetupClusterServer(*fClusterServer);
178   }
179   
180   fTriggerStore->Connect(*clustersTree,kFALSE);
181   
182   clustersTree->GetEvent(0);
183
184   return 0;
185 }
186
187 //_____________________________________________________________________________
188 Int_t AliMUONTracker::Clusters2Tracks(AliESDEvent* esd)
189 {
190   /// Performs the tracking and store the resulting tracks in the ESD
191   AliDebug(1,"");
192   AliCodeTimerAuto("")
193   
194   if (!fTrackReco) 
195   {
196     fTrackReco = CreateTrackReconstructor(AliMUONReconstructor::GetRecoParam()->GetTrackingMode(),fClusterServer);
197   }
198   
199   // if the required tracking mode does not exist
200   if  (!fTrackReco) return 1;
201   
202   if ( ! ClusterStore() ) 
203   {
204     AliError("ClusterStore is NULL");
205     return 2;
206   }
207   
208   if (!fTriggerStore) {
209     AliError("TriggerStore is NULL");
210     return 3;
211   }
212
213   // Make trigger tracks
214   if ( fTriggerCircuit ) 
215   {
216     TriggerTrackStore()->Clear();
217     fTrackReco->EventReconstructTrigger(*fTriggerCircuit,*fTriggerStore,*(TriggerTrackStore()));
218   }
219   
220   // Make tracker tracks
221   AliMUONVTrackStore* trackStore = new AliMUONTrackStoreV1;
222   fTrackReco->EventReconstruct(*(ClusterStore()),*trackStore);
223   
224   // Match tracker/trigger tracks
225   if ( fTrackHitPatternMaker ) 
226   {
227     fTrackReco->ValidateTracksWithTrigger(*trackStore,*(TriggerTrackStore()),*fTriggerStore,*fTrackHitPatternMaker);
228   }
229   
230   // Fill ESD
231   FillESD(*trackStore,esd);
232   
233   // cleanup
234   delete trackStore;
235   
236   return 0;
237 }
238
239 //_____________________________________________________________________________
240 void AliMUONTracker::FillESD(AliMUONVTrackStore& trackStore, AliESDEvent* esd) const
241 {
242   /// Fill the ESD from the trackStore
243   AliDebug(1,"");
244   AliCodeTimerAuto("")
245   
246   AliMUONTrack* track;
247   AliESDMuonTrack esdTrack;
248   Double_t vertex[3] = {0., 0., 0.};
249   TIter next(trackStore.CreateIterator());
250   
251   // get ITS vertex
252   const AliESDVertex* esdVert = esd->GetVertex(); 
253   if (esdVert->GetNContributors()) {
254     esdVert->GetXYZ(vertex);
255     AliDebug(1,Form("found vertex (%e,%e,%e)",vertex[0],vertex[1],vertex[2]));
256   }
257   
258   // fill ESD event including all info in ESD cluster if required and only for the given fraction of events
259   if (AliMUONReconstructor::GetRecoParam()->SaveFullClusterInESD() && 
260       gRandom->Uniform(100.) <= AliMUONReconstructor::GetRecoParam()->GetPercentOfFullClusterInESD()) {
261     
262     while ( ( track = static_cast<AliMUONTrack*>(next()) ) ) {
263       AliMUONESDInterface::MUONToESD(*track, esdTrack, vertex, &fDigitStore);
264       // set the trigger x/y strips pattern
265       if (esdTrack.GetMatchTrigger()) {
266         AliMUONLocalTrigger* locTrg = static_cast<AliMUONLocalTrigger*>(fTriggerStore->FindLocal(esdTrack.LoCircuit()));
267         esdTrack.SetTriggerX1Pattern(locTrg->GetX1Pattern());
268         esdTrack.SetTriggerY1Pattern(locTrg->GetY1Pattern());
269         esdTrack.SetTriggerX2Pattern(locTrg->GetX2Pattern());
270         esdTrack.SetTriggerY2Pattern(locTrg->GetY2Pattern());
271         esdTrack.SetTriggerX3Pattern(locTrg->GetX3Pattern());
272         esdTrack.SetTriggerY3Pattern(locTrg->GetY3Pattern());
273         esdTrack.SetTriggerX4Pattern(locTrg->GetX4Pattern());
274         esdTrack.SetTriggerY4Pattern(locTrg->GetY4Pattern());
275       }
276       esd->AddMuonTrack(&esdTrack);
277     }
278     
279   } else {
280     
281     while ( ( track = static_cast<AliMUONTrack*>(next()) ) ) {
282       AliMUONESDInterface::MUONToESD(*track, esdTrack, vertex);
283       // set the trigger x/y strips pattern
284       if (esdTrack.GetMatchTrigger()) {
285         AliMUONLocalTrigger* locTrg = static_cast<AliMUONLocalTrigger*>(fTriggerStore->FindLocal(esdTrack.LoCircuit()));
286         esdTrack.SetTriggerX1Pattern(locTrg->GetX1Pattern());
287         esdTrack.SetTriggerY1Pattern(locTrg->GetY1Pattern());
288         esdTrack.SetTriggerX2Pattern(locTrg->GetX2Pattern());
289         esdTrack.SetTriggerY2Pattern(locTrg->GetY2Pattern());
290         esdTrack.SetTriggerX3Pattern(locTrg->GetX3Pattern());
291         esdTrack.SetTriggerY3Pattern(locTrg->GetY3Pattern());
292         esdTrack.SetTriggerX4Pattern(locTrg->GetX4Pattern());
293         esdTrack.SetTriggerY4Pattern(locTrg->GetY4Pattern());
294       }
295       esd->AddMuonTrack(&esdTrack);
296     }
297     
298   }
299
300   // fill the local trigger decisions not matched with tracks 
301   // associate them to "ghost" tracks
302
303   Int_t loTrgNum(-1);
304   Bool_t matched = kFALSE;
305
306   AliMUONTriggerTrack *triggerTrack;
307   AliMUONTrack muonTrack;
308   AliESDMuonTrack esdGhostTrack;
309   TIter itTriggerTrack(fTriggerTrackStore->CreateIterator());
310   while ( ( triggerTrack = static_cast<AliMUONTriggerTrack*>(itTriggerTrack() )
311 ) )
312     {
313       loTrgNum = triggerTrack->GetLoTrgNum();
314       AliMUONLocalTrigger* locTrg = static_cast<AliMUONLocalTrigger*>(fTriggerStore->FindLocal(loTrgNum));
315
316       /* verify if this local trigger has been already matched */
317       TIter itTrack(trackStore.CreateIterator());
318       while ( ( track = static_cast<AliMUONTrack*>(itTrack()) ) )
319         {
320           if (matched = (track->LoCircuit() == locTrg->LoCircuit())) break;
321         }
322       if (matched) continue;
323
324       muonTrack.SetLocalTrigger(locTrg->LoCircuit(),
325                                 locTrg->LoStripX(),
326                                 locTrg->LoStripY(),
327                                 locTrg->LoDev(),
328                                 locTrg->LoLpt(),
329                                 locTrg->LoHpt());
330
331       /* make the AliESDMuonTrack from the "track" object */
332
333       esdGhostTrack.SetLocalTrigger(muonTrack.GetLocalTrigger());
334       // set the transverse momentum of this track to "zero"
335       esdGhostTrack.SetInverseBendingMomentum(1.E+10);
336       esdGhostTrack.SetInverseBendingMomentumAtDCA(1.E+10);
337       esdGhostTrack.SetInverseBendingMomentumUncorrected(1.E+10);
338       // set the trigger x/y strips pattern
339       esdGhostTrack.SetTriggerX1Pattern(locTrg->GetX1Pattern());
340       esdGhostTrack.SetTriggerY1Pattern(locTrg->GetY1Pattern());
341       esdGhostTrack.SetTriggerX2Pattern(locTrg->GetX2Pattern());
342       esdGhostTrack.SetTriggerY2Pattern(locTrg->GetY2Pattern());
343       esdGhostTrack.SetTriggerX3Pattern(locTrg->GetX3Pattern());
344       esdGhostTrack.SetTriggerY3Pattern(locTrg->GetY3Pattern());
345       esdGhostTrack.SetTriggerX4Pattern(locTrg->GetX4Pattern());
346       esdGhostTrack.SetTriggerY4Pattern(locTrg->GetY4Pattern());
347       esd->AddMuonTrack(&esdGhostTrack);
348
349     }
350   
351 }
352
353 //_____________________________________________________________________________
354 AliMUONVTrackReconstructor* AliMUONTracker::CreateTrackReconstructor(const char* trackingMode, AliMUONVClusterServer* clusterServer)
355 {
356   /// Create track reconstructor, depending on tracking mode set in RecoParam
357   
358   AliMUONVTrackReconstructor* trackReco(0x0);
359   
360   TString opt(trackingMode);
361   opt.ToUpper();
362   
363   if (strstr(opt,"ORIGINAL"))
364   {
365     trackReco = new AliMUONTrackReconstructor(*clusterServer);
366   }
367   else if (strstr(opt,"KALMAN"))
368   {
369     trackReco = new AliMUONTrackReconstructorK(*clusterServer);
370   }
371   else
372   {
373     AliErrorClass(Form("tracking mode \"%s\" does not exist",opt.Data()));
374     return 0x0;
375   }
376   
377   AliInfoClass(Form("Will use %s for tracking",trackReco->ClassName()));
378   
379   return trackReco;
380 }
381
382 //_____________________________________________________________________________
383 void AliMUONTracker::UnloadClusters()
384 {
385   /// Clear internal clusterStore
386   
387   delete fInputClusterStore;
388   fInputClusterStore = 0x0;
389 }
390
391
392 //_____________________________________________________________________________
393 void
394 AliMUONTracker::SetupClusterServer(AliMUONVClusterServer& clusterServer)
395 {
396   /// Setup the cluster server
397   
398   if ( AliMUONReconstructor::GetRecoParam()->BypassSt45() )
399   {
400     Bool_t ok = clusterServer.UseTriggerTrackStore(TriggerTrackStore());
401   
402     if ( ok ) 
403     
404     {
405       AliWarning("WILL USE TRIGGER TRACKS TO GENERATE CLUSTERS IN STATIONS 4 AND 5, THUS BYPASSING REAL CLUSTERS IN THOSE TWO STATIONS !!!");    
406     }
407     else
408     {
409       AliWarning("BYPASSING OF ST45 REQUESTED, BUT CLUSTERSERVER DOES NOT SEEM TO SUPPORT IT !!!");    
410     }
411   }
412 }
413
414