AliEveEventManager
[u/mrichter/AliRoot.git] / EVE / EveBase / AliEveEventManager.cxx
1 // $Id$
2 // Main authors: Matevz Tadel & Alja Mrak-Tadel: 2006, 2007
3
4 /**************************************************************************
5  * Copyright(c) 1998-2008, ALICE Experiment at CERN, all rights reserved. *
6  * See http://aliceinfo.cern.ch/Offline/AliRoot/License.html for          *
7  * full copyright notice.                                                 *
8  **************************************************************************/
9
10 #include "AliEveEventManager.h"
11 #include <TEveManager.h>
12
13 #include <AliRunLoader.h>
14 #include <AliRun.h>
15 #include <AliESDEvent.h>
16 #include <AliESDfriend.h>
17 #include <AliDAQ.h>
18 #include <AliRawEventHeaderBase.h>
19 #include <AliRawReaderRoot.h>
20 #include <AliRawReaderFile.h>
21 #include <AliRawReaderDate.h>
22 #include <AliMagFMaps.h>
23 #include <AliCDBManager.h>
24 #include <AliHeader.h>
25 #include <AliGeomManager.h>
26
27 #include <TFile.h>
28 #include <TTree.h>
29 #include <TGeoManager.h>
30 #include <TSystem.h>
31
32 //==============================================================================
33 //==============================================================================
34 // AliEveEventManager
35 //==============================================================================
36
37 //______________________________________________________________________________
38 //
39 // Provide interface for loading and navigating standard AliRoot data
40 // (AliRunLoader) and ESDs.
41 //
42 // Missing support for raw-data. For now this is handled individually
43 // by each sub-detector.
44 //
45 // Also provides interface to magnetic-field and geometry. Mostly
46 // intended as wrappers over standard AliRoot functionality for
47 // convenient use from visualizateion macros.
48
49 ClassImp(AliEveEventManager)
50
51 AliEveEventManager* gAliEveEvent = 0;
52
53 Bool_t AliEveEventManager::fgAssertRunLoader = kFALSE;
54 Bool_t AliEveEventManager::fgAssertESD       = kFALSE;
55 Bool_t AliEveEventManager::fgAssertRaw       = kFALSE;
56
57 TString  AliEveEventManager::fgESDFileName("AliESDs.root");
58 TString  AliEveEventManager::fgRawFileName("raw.root");
59 TString  AliEveEventManager::fgCdbUri("local://$ALICE_ROOT");
60
61 AliMagF* AliEveEventManager::fgMagField = 0;
62
63
64 AliEveEventManager::AliEveEventManager() :
65   TEveEventManager(),
66
67   fPath      ( ), fEventId (-1),
68   fRunLoader (0),
69   fESDFile   (0), fESDTree (0), fESD (0),
70   fESDfriend (0), fESDfriendExists(kFALSE),
71   fRawReader (0),
72   fAutoLoad(kFALSE),
73   fAutoLoadTime(5.),
74   fAutoLoadTimer(0),
75   fIsOnline(kFALSE)
76 {
77   // Default constructor.
78 }
79
80 AliEveEventManager::AliEveEventManager(TString path, Int_t ev) :
81   TEveEventManager("AliEVE AliEveEventManager"),
82
83   fPath   (path), fEventId(-1),
84   fRunLoader (0),
85   fESDFile   (0), fESDTree (0), fESD (0),
86   fESDfriend (0), fESDfriendExists(kFALSE),
87   fRawReader (0),
88   fAutoLoad(kFALSE),
89   fAutoLoadTime(5.),
90   fAutoLoadTimer(0),
91   fIsOnline(kFALSE)
92 {
93   // Constructor with event-directory URL and event-id.
94
95   Open();
96   if (ev >= 0) GotoEvent(ev);
97 }
98
99 AliEveEventManager::~AliEveEventManager()
100 {
101   // Destructor.
102
103   if (fAutoLoadTimer) delete fAutoLoadTimer;
104   // Somewhat unclear what to do here.
105   // In principle should close all data sources and deregister from
106   // TEveManager.
107 }
108
109 /******************************************************************************/
110
111 void AliEveEventManager::SetESDFileName(const Text_t* esd)
112 {
113   // Set file-name for opening ESD, default "AliESDs.root".
114
115   if (esd) fgESDFileName = esd;
116 }
117
118 void AliEveEventManager::SetRawFileName(const Text_t* raw)
119 {
120   // Set file-name for opening of raw-data, default "raw.root"
121   if (raw) fgRawFileName = raw;
122 }
123
124 void AliEveEventManager::SetCdbUri(const Text_t* cdb)
125 {
126   // Set path to CDB, default "local://$ALICE_ROOT".
127
128   if (cdb) fgCdbUri = cdb;
129 }
130
131 void AliEveEventManager::SetAssertElements(Bool_t assertRunloader,
132                                            Bool_t assertEsd,
133                                            Bool_t assertRaw)
134 {
135   // Set global flags that detrmine which parts of the event-data must
136   // be present when the event is opened.
137
138   fgAssertRunLoader = assertRunloader;
139   fgAssertESD = assertEsd;
140   fgAssertRaw = assertRaw;
141 }
142
143 /******************************************************************************/
144
145 void AliEveEventManager::Open()
146 {
147   // Open event-data from URL specified in fPath.
148   // Attempts to create AliRunLoader() and to open ESD with ESDfriends.
149   // Warning is reported if run-loader or ESD is not found.
150   // Global data-members fgAssertRunLoader and fgAssertESD can be set
151   // to throw exceptions instead.
152
153   static const TEveException kEH("AliEveEventManager::Open ");
154
155   gSystem->ExpandPathName(fPath);
156   // The following magick is required for ESDriends to be loaded properly
157   // from non-current directory.
158   if (fPath.IsNull() || fPath == ".")
159   {
160     fPath = gSystem->WorkingDirectory();
161   }
162   else if ( ! fPath.BeginsWith("file:/"))
163   {
164     TUrl    url(fPath, kTRUE);
165     TString protocol(url.GetProtocol());
166     if (protocol == "file" && fPath[0] != '/')
167       fPath = Form("%s/%s", gSystem->WorkingDirectory(), fPath.Data());
168   }
169
170   Int_t runNo = -1;
171
172   // Open ESD and ESDfriends
173
174   TString esdPath(Form("%s/%s", fPath.Data(), fgESDFileName.Data()));
175   if ((fESDFile = TFile::Open(esdPath)))
176   {
177     fESD = new AliESDEvent();
178     fESDTree = (TTree*) fESDFile->Get("esdTree");
179     if (fESDTree != 0)
180     {
181       fESD->ReadFromTree(fESDTree);
182       fESDTree->GetEntry(0);
183       if (runNo < 0)
184         runNo = fESD->GetESDRun()->GetRunNumber();
185
186       // Check if ESDfriends exists and attach the branch
187       TString p(Form("%s/AliESDfriends.root", fPath.Data()));
188       if (gSystem->AccessPathName(p, kReadPermission) == kFALSE)
189       {
190         fESDfriendExists = kTRUE;
191         fESDTree->SetBranchStatus ("ESDfriend*", 1);
192         fESDTree->SetBranchAddress("ESDfriend.", &fESDfriend);
193       }
194     }
195     else // esdtree == 0
196     {
197       delete fESDFile; fESDFile = 0;
198       Warning(kEH, "failed getting the esdTree.");
199     }
200   }
201   else // esd not readable
202   {
203     Warning(kEH, "can not read ESD file '%s'.", esdPath.Data());
204   }
205   if (fESDTree == 0)
206   {
207     if (fgAssertESD)
208     {
209       throw (kEH + "ESD not initialized. Its precence was requested.");
210     } else {
211       Warning(kEH, "ESD not initialized.");
212     }
213   }
214
215   // Open RunLoader from galice.root
216
217   TString gaPath(Form("%s/galice.root", fPath.Data()));
218   // If i use open directly, we get fatal.
219   // Is AccessPathName check ok for xrootd / alien? Yes, not for http.
220   if (gSystem->AccessPathName(gaPath, kReadPermission) == kFALSE)
221   {
222     fRunLoader = AliRunLoader::Open(gaPath);
223     if (fRunLoader)
224     {
225       TString alicePath = fPath + "/";
226       fRunLoader->SetDirName(alicePath);
227
228       if (fRunLoader->LoadgAlice() != 0)
229         Warning(kEH, "failed loading gAlice via run-loader.");
230
231       if (fRunLoader->LoadHeader() == 0)
232       {
233         if (runNo < 0)
234           runNo = fRunLoader->GetHeader()->GetRun();
235       }
236       else
237       {
238         Warning(kEH, "failed loading run-loader's header.");
239         delete fRunLoader;
240         fRunLoader = 0;
241       }
242     }
243     else // run-loader open failed
244     {
245       Warning(kEH, "failed opening ALICE run-loader from '%s'.", gaPath.Data());
246     }
247   }
248   else // galice not readable
249   {
250     Warning(kEH, "can not read '%s'.", gaPath.Data());
251   }
252   if (fRunLoader == 0)
253   {
254     if (fgAssertRunLoader)
255       throw (kEH + "Bootstraping of run-loader failed. Its precence was requested.");
256     else
257       Warning(kEH, "Bootstraping of run-loader failed.");
258   }
259
260   // Open raw-data file
261
262   TString rawPath(Form("%s/%s", fPath.Data(), fgRawFileName.Data()));
263   // If i use open directly, raw-reader reports an error but i have
264   // no way to detect it.
265   // Is this (AccessPathName check) ok for xrootd / alien? Yes, not for http.
266   if (gSystem->AccessPathName(rawPath, kReadPermission) == kFALSE)
267   {
268     fRawReader = AliRawReader::Create(rawPath);
269   }
270
271   if (fRawReader == 0)
272   {
273     if (fgAssertRaw)
274     {
275       throw (kEH + "raw-data not initialized. Its precence was requested.");
276     } else {
277       Warning(kEH, "raw-data not initialized.");
278     }
279   }
280
281   if (runNo < 0)
282   {
283     if (fRawReader)
284     {
285       fRawReader->NextEvent();
286       runNo = fRawReader->GetRunNumber();
287       Info(kEH, "Determining run-no from raw ... run=%d.", runNo);
288       fRawReader->RewindEvents();
289     } else {
290       throw (kEH + "unknown run number.");
291     }
292   }
293
294   {
295     AliCDBManager* cdb = AliCDBManager::Instance();
296     cdb->SetDefaultStorage(fgCdbUri);
297     if (cdb->IsDefaultStorageSet() == kFALSE)
298       throw (kEH + "CDB initialization failed.");
299     cdb->SetRun(runNo);
300   }
301
302   SetName(Form("Event %d", fEventId));
303   SetTitle(fPath);
304 }
305
306 void AliEveEventManager::SetEvent(AliRunLoader *runLoader, AliRawReader *rawReader, AliESDEvent *esd)
307 {
308   // Set an event from an external source
309   // The method is used in the online visualisation
310   fRunLoader = runLoader;
311   fRawReader = rawReader;
312   fESD = esd;
313   fIsOnline = kTRUE;
314   SetTitle("Online event in memory");
315   SetName("Online Event");
316
317   ElementChanged();
318   AfterNewEventLoaded();
319 }
320
321 Int_t AliEveEventManager::GetMaxEventId(Bool_t refreshESD) const
322 {
323   // Returns maximum available event id.
324   // If raw-data is the only data-source this can not be known
325   // and 10,000,000 is returned.
326   // If neither data-source is initialised an exception is thrown.
327   // If refresh_esd is true and ESD is the primary event-data source
328   // its header is re-read from disk.
329
330   static const TEveException kEH("AliEveEventManager::GetMaxEventId ");
331
332   if (fRunLoader)
333   {
334     return fRunLoader->GetNumberOfEvents() - 1;
335   }
336   else if (fESDTree)
337   {
338     if (refreshESD)
339       fESDTree->Refresh();
340     return fESDTree->GetEntries() - 1;
341   }
342   else if (fRawReader)
343   {
344     return 10000000;
345   }
346   else
347   {
348     throw (kEH + "neither RunLoader, ESD nor Raw loaded.");
349   }
350 }
351
352 void AliEveEventManager::GotoEvent(Int_t event)
353 {
354   // Load data for specified event.
355   // If event is out of range an exception is thrown and old state
356   // is preserved.
357   // After successful loading of event, the virtual function
358   // AfterNewEventLoaded() is called. This executes commands that
359   // were registered via TEveEventManager::AddNewEventCommand().
360   //
361   // If event is negative, it is subtracted from the number of
362   // available events, thus passing -1 will load the last event.
363   // This is not supported when raw-data is the only data-source
364   // as the number of events is not known.
365
366   static const TEveException kEH("AliEveEventManager::GotoEvent ");
367
368   Int_t maxEvent = 0;
369   if (fESDTree)
370   {
371     // Refresh crashes with root-5.21.1-alice.
372     // Fixed by Philippe 5.8.2008 r25053, can be reactivated
373     // when we move to a newer root.
374     // fESDTree->Refresh();
375     maxEvent = fESDTree->GetEntries() - 1;
376     if (event < 0)
377       event = fESDTree->GetEntries() + event;
378   }
379   else if (fRunLoader)
380   {
381     maxEvent = fRunLoader->GetNumberOfEvents() - 1;
382     if (event < 0)
383       event = fRunLoader->GetNumberOfEvents() + event;
384   }
385   else if (fRawReader)
386   {
387     maxEvent = 10000000;
388     if (event < 0) {
389       Error(kEH, "negative event id passed for raw-data as source. Operation not supported.");
390       return;
391     }
392     Info(kEH, "number of events unknown for raw-data, setting max-event id to 10M.");
393   }
394   else
395   {
396     throw (kEH + "neither RunLoader, ESD nor Raw loaded.");
397   }
398   if (event < 0 || event > maxEvent)
399   {
400     throw (kEH + Form("event %d not present, available range [%d, %d].",
401                       event, 0, maxEvent));
402   }
403
404   TEveManager::TRedrawDisabler rd(gEve);
405   gEve->Redraw3D(kFALSE, kTRUE); // Enforce drop of all logicals.
406
407   // !!! MT this is somewhat brutal; at least optionally, one could be
408   // a bit gentler, checking for objs owning their external refs and having
409   // additinal parents.
410   DestroyElements();
411
412   if (fESDTree) {
413     if (fESDTree->GetEntry(event) <= 0)
414       throw (kEH + "failed getting required event from ESD.");
415
416     if (fESDfriendExists)
417       fESD->SetESDfriend(fESDfriend);
418   }
419
420   if (fRunLoader) {
421     if (fRunLoader->GetEvent(event) != 0)
422       throw (kEH + "failed getting required event.");
423   }
424
425   if (fRawReader)
426   {
427     // AliRawReader::GotoEvent(Int_t) works for AliRawReaderRoot/Chain.
428     if (fRawReader->GotoEvent(event) == kFALSE)
429     {
430       // Use fallback method - iteration with NextEvent().
431       Int_t rawEv = fEventId;
432       if (event < rawEv)
433       {
434         fRawReader->RewindEvents();
435         rawEv = -1;
436       }
437
438       while (rawEv < event)
439       {
440         if ( ! fRawReader->NextEvent())
441         {
442           fRawReader->RewindEvents();
443           fEventId = -1;
444           throw (kEH + Form("Error going to next raw-event from event %d.", rawEv));
445         }
446         ++rawEv;
447       }
448       Warning(kEH, "Loaded raw-event %d with fallback method.\n", rawEv);
449     }
450   }
451
452   fEventId = event;
453   SetName(Form("Event %d", fEventId));
454   ElementChanged();
455
456   AfterNewEventLoaded();
457 }
458
459 void AliEveEventManager::NextEvent()
460 {
461   // Loads next event
462   // either in automatic (online) or
463   // manual mode
464   
465   if (fIsOnline) {
466     if (fAutoLoadTimer) fAutoLoadTimer->Stop();
467
468     DestroyElements();
469
470     gSystem->ExitLoop();
471   }
472   else {
473     if (fEventId < GetMaxEventId(kTRUE))
474       GotoEvent(fEventId + 1);
475     else
476       GotoEvent(0);
477     StartStopAutoLoadTimer();
478   }
479 }
480
481 void AliEveEventManager::PrevEvent()
482 {
483   // Loads previous event
484   // only in case of manual mode
485   if (!fIsOnline) {
486     GotoEvent(fEventId - 1);
487     StartStopAutoLoadTimer();
488   }
489 }
490
491 void AliEveEventManager::Close()
492 {
493   // Close the event data-files and delete ESD, ESDfriend, run-loader
494   // and raw-reader.
495
496   if (fESDTree) {
497     delete fESD;       fESD       = 0;
498     delete fESDfriend; fESDfriend = 0;
499
500     delete fESDTree;   fESDTree = 0;
501     delete fESDFile;   fESDFile = 0;
502   }
503
504   if (fRunLoader) {
505     delete fRunLoader; fRunLoader = 0;
506   }
507
508   if (fRawReader) {
509     delete fRawReader; fRawReader = 0;
510   }
511 }
512
513
514 /******************************************************************************/
515 // Static convenience functions, mainly used from macros.
516 /******************************************************************************/
517
518 AliRunLoader* AliEveEventManager::AssertRunLoader()
519 {
520   // Make sure AliRunLoader is initialized and return it.
521   // Throws exception in case run-loader is not available.
522   // Static utility for macros.
523
524   static const TEveException kEH("AliEveEventManager::AssertRunLoader ");
525
526   if (gAliEveEvent == 0)
527     throw (kEH + "ALICE event not ready.");
528   if (gAliEveEvent->fRunLoader == 0)
529     throw (kEH + "AliRunLoader not initialised.");
530   return gAliEveEvent->fRunLoader;
531 }
532
533 AliESDEvent* AliEveEventManager::AssertESD()
534 {
535   // Make sure AliESDEvent is initialized and return it.
536   // Throws exception in case ESD is not available.
537   // Static utility for macros.
538
539   static const TEveException kEH("AliEveEventManager::AssertESD ");
540
541   if (gAliEveEvent == 0)
542     throw (kEH + "ALICE event not ready.");
543   if (gAliEveEvent->fESD == 0)
544     throw (kEH + "AliESD not initialised.");
545   return gAliEveEvent->fESD;
546 }
547
548 AliESDfriend* AliEveEventManager::AssertESDfriend()
549 {
550   // Make sure AliESDfriend is initialized and return it.
551   // Throws exception in case ESDfriend-loader is not available.
552   // Static utility for macros.
553
554   static const TEveException kEH("AliEveEventManager::AssertESDfriend ");
555
556   if (gAliEveEvent == 0)
557     throw (kEH + "ALICE event not ready.");
558   if (gAliEveEvent->fESDfriend == 0)
559     throw (kEH + "AliESDfriend not initialised.");
560   return gAliEveEvent->fESDfriend;
561 }
562
563 AliRawReader* AliEveEventManager::AssertRawReader()
564 {
565   // Make sure raw-reader is initialized and return it.
566
567   static const TEveException kEH("AliEveEventManager::AssertRawReader ");
568
569   if (gAliEveEvent == 0)
570     throw (kEH + "ALICE event not ready.");
571   if (gAliEveEvent->fRawReader == 0)
572     throw (kEH + "RawReader not ready.");
573
574   return gAliEveEvent->fRawReader;
575 }
576
577 AliMagF* AliEveEventManager::AssertMagField()
578 {
579   // Make sure AliMagF is initialized and return it.
580   // Throws exception in case magnetic field is not available.
581   // Static utility for macros.
582
583   if (fgMagField == 0)
584   {
585     if (gAliEveEvent && gAliEveEvent->fRunLoader && gAliEveEvent->fRunLoader->GetAliRun())
586       fgMagField = gAliEveEvent->fRunLoader->GetAliRun()->Field();
587     else
588       fgMagField = new AliMagFMaps("Maps","Maps", 1, 1., 10., AliMagFMaps::k5kG);
589   }
590   return fgMagField;
591 }
592
593 TGeoManager* AliEveEventManager::AssertGeometry()
594 {
595   // Make sure AliGeomManager is initialized and returns the
596   // corresponding TGeoManger.
597   // gGeoManager is set to the return value.
598   // Throws exception if geometry can not be loaded or if it is not
599   // available and the TGeoManager is locked.
600   // Static utility for macros.
601
602   static const TEveException kEH("AliEveEventManager::AssertGeometry ");
603
604   if (AliGeomManager::GetGeometry() == 0)
605   {
606     if (TGeoManager::IsLocked())
607       throw (kEH + "geometry is not loaded but TGeoManager is locked.");
608
609     gGeoManager = 0;
610     AliGeomManager::LoadGeometry();
611     if ( ! AliGeomManager::GetGeometry())
612     {
613       throw (kEH + "can not load geometry.");
614     }
615     if ( ! AliGeomManager::ApplyAlignObjsFromCDB("ITS TPC TRD TOF PHOS HMPID EMCAL MUON FMD ZDC PMD T0 VZERO ACORDE"))
616     {
617       ::Warning(kEH, "mismatch of alignable volumes. Proceeding.");
618       // throw (kEH + "could not apply align objs.");
619     }
620     AliGeomManager::GetGeometry()->DefaultColors();
621   }
622
623   gGeoManager = AliGeomManager::GetGeometry();
624   return gGeoManager;
625 }
626
627 void AliEveEventManager::SetAutoLoad(Bool_t autoLoad)
628 {
629   // Set the automatic event loading mode
630   fAutoLoad = autoLoad;
631   StartStopAutoLoadTimer();
632 }
633
634 void AliEveEventManager::SetAutoLoadTime(Double_t time)
635 {
636   // Set the auto-load time in seconds
637   fAutoLoadTime = time;
638   StartStopAutoLoadTimer();
639 }
640
641 void AliEveEventManager::StartStopAutoLoadTimer()
642 {
643   // Create if needed and start
644   // the automatic event loading timer
645   if (fAutoLoad) {
646     if (!fAutoLoadTimer) {
647       fAutoLoadTimer = new TTimer;
648       fAutoLoadTimer->Connect("Timeout()","AliEveEventManager",this,"NextEvent()");
649     }
650     fAutoLoadTimer->Start((Long_t)fAutoLoadTime*1000,kTRUE);
651   }
652   else {
653     if (fAutoLoadTimer) fAutoLoadTimer->Stop();
654   }
655 }
656
657 const char* AliEveEventManager::GetEventInfo() const
658 {
659   // Dumps the event-header contents
660
661   static TString eventInfo;
662
663   if (!fRawReader) {
664     eventInfo.Form("No raw-data event info is available!\n");
665   }
666   else {
667     const UInt_t* attr = fRawReader->GetAttributes();
668     eventInfo.Form("Raw-data event info:\nRun#: %d\nEvent type: %d (%s)\nPeriod: %x\nOrbit: %x   BC: %x\nTrigger: %llx\nDetectors: %x (%s)\nAttributes:%x-%x-%x\nTimestamp: %x\n",
669                    fRawReader->GetRunNumber(),fRawReader->GetType(),AliRawEventHeaderBase::GetTypeName(fRawReader->GetType()),
670                    fRawReader->GetPeriod(),fRawReader->GetOrbitID(),fRawReader->GetBCID(),
671                    fRawReader->GetClassMask(),
672                    *fRawReader->GetDetectorPattern(),AliDAQ::ListOfTriggeredDetectors(*fRawReader->GetDetectorPattern()),
673                    attr[0],attr[1],attr[2],
674                    fRawReader->GetTimestamp());
675   }
676   if (!fESD) {
677     eventInfo.Append(Form("\nNo ESD event info is available!\n"));
678   }
679   else {
680     TString acttrclasses = fESD->GetESDRun()->GetActiveTriggerClasses();
681     TString firedtrclasses = fESD->GetFiredTriggerClasses();
682     eventInfo.Append(Form("\nESD event info:\nRun#: %d\nActive trigger classes: %s\nEvent type: %d (%s)\nPeriod: %x\nOrbit: %x   BC: %x\nTrigger: %llx (%s)\nEvent# in file:%d\nTimestamp: %x\n",
683                           fESD->GetRunNumber(),
684                           acttrclasses.Data(),
685                           fESD->GetEventType(),AliRawEventHeaderBase::GetTypeName(fESD->GetEventType()),
686                           fESD->GetPeriodNumber(),fESD->GetOrbitNumber(),fESD->GetBunchCrossNumber(),
687                           fESD->GetTriggerMask(),firedtrclasses.Data(),
688                           fESD->GetEventNumberInFile(),
689                           fESD->GetTimeStamp()));
690   }
691
692   return eventInfo.Data();
693 }
694