We don't check the path to the raw-data file, it is done inside AliRawReader::Create...
[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   fRawReader = AliRawReader::Create(rawPath);
264   if (fRawReader == 0)
265   {
266     if (fgAssertRaw)
267     {
268       throw (kEH + "raw-data not initialized. Its precence was requested.");
269     } else {
270       Warning(kEH, "raw-data not initialized.");
271     }
272   }
273
274   if (runNo < 0)
275   {
276     if (fRawReader)
277     {
278       fRawReader->NextEvent();
279       runNo = fRawReader->GetRunNumber();
280       Info(kEH, "Determining run-no from raw ... run=%d.", runNo);
281       fRawReader->RewindEvents();
282     } else {
283       throw (kEH + "unknown run number.");
284     }
285   }
286
287   {
288     AliCDBManager* cdb = AliCDBManager::Instance();
289     cdb->SetDefaultStorage(fgCdbUri);
290     if (cdb->IsDefaultStorageSet() == kFALSE)
291       throw (kEH + "CDB initialization failed.");
292     cdb->SetRun(runNo);
293   }
294
295   SetName(Form("Event %d", fEventId));
296   SetTitle(fPath);
297 }
298
299 void AliEveEventManager::SetEvent(AliRunLoader *runLoader, AliRawReader *rawReader, AliESDEvent *esd)
300 {
301   // Set an event from an external source
302   // The method is used in the online visualisation
303   fRunLoader = runLoader;
304   fRawReader = rawReader;
305   fESD = esd;
306   fIsOnline = kTRUE;
307   SetTitle("Online event in memory");
308   SetName("Online Event");
309
310   ElementChanged();
311   AfterNewEventLoaded();
312 }
313
314 Int_t AliEveEventManager::GetMaxEventId(Bool_t refreshESD) const
315 {
316   // Returns maximum available event id.
317   // If raw-data is the only data-source this can not be known
318   // and 10,000,000 is returned.
319   // If neither data-source is initialised an exception is thrown.
320   // If refresh_esd is true and ESD is the primary event-data source
321   // its header is re-read from disk.
322
323   static const TEveException kEH("AliEveEventManager::GetMaxEventId ");
324
325   if (fRunLoader)
326   {
327     return fRunLoader->GetNumberOfEvents() - 1;
328   }
329   else if (fESDTree)
330   {
331     if (refreshESD)
332       fESDTree->Refresh();
333     return fESDTree->GetEntries() - 1;
334   }
335   else if (fRawReader)
336   {
337     return 10000000;
338   }
339   else
340   {
341     throw (kEH + "neither RunLoader, ESD nor Raw loaded.");
342   }
343 }
344
345 void AliEveEventManager::GotoEvent(Int_t event)
346 {
347   // Load data for specified event.
348   // If event is out of range an exception is thrown and old state
349   // is preserved.
350   // After successful loading of event, the virtual function
351   // AfterNewEventLoaded() is called. This executes commands that
352   // were registered via TEveEventManager::AddNewEventCommand().
353   //
354   // If event is negative, it is subtracted from the number of
355   // available events, thus passing -1 will load the last event.
356   // This is not supported when raw-data is the only data-source
357   // as the number of events is not known.
358
359   static const TEveException kEH("AliEveEventManager::GotoEvent ");
360
361   Int_t maxEvent = 0;
362   if (fESDTree)
363   {
364     // Refresh crashes with root-5.21.1-alice.
365     // Fixed by Philippe 5.8.2008 r25053, can be reactivated
366     // when we move to a newer root.
367     // fESDTree->Refresh();
368     maxEvent = fESDTree->GetEntries() - 1;
369     if (event < 0)
370       event = fESDTree->GetEntries() + event;
371   }
372   else if (fRunLoader)
373   {
374     maxEvent = fRunLoader->GetNumberOfEvents() - 1;
375     if (event < 0)
376       event = fRunLoader->GetNumberOfEvents() + event;
377   }
378   else if (fRawReader)
379   {
380     maxEvent = 10000000;
381     if (event < 0) {
382       Error(kEH, "negative event id passed for raw-data as source. Operation not supported.");
383       return;
384     }
385     Info(kEH, "number of events unknown for raw-data, setting max-event id to 10M.");
386   }
387   else
388   {
389     throw (kEH + "neither RunLoader, ESD nor Raw loaded.");
390   }
391   if (event < 0 || event > maxEvent)
392   {
393     throw (kEH + Form("event %d not present, available range [%d, %d].",
394                       event, 0, maxEvent));
395   }
396
397   TEveManager::TRedrawDisabler rd(gEve);
398   gEve->Redraw3D(kFALSE, kTRUE); // Enforce drop of all logicals.
399
400   // !!! MT this is somewhat brutal; at least optionally, one could be
401   // a bit gentler, checking for objs owning their external refs and having
402   // additinal parents.
403   DestroyElements();
404
405   if (fESDTree) {
406     if (fESDTree->GetEntry(event) <= 0)
407       throw (kEH + "failed getting required event from ESD.");
408
409     if (fESDfriendExists)
410       fESD->SetESDfriend(fESDfriend);
411   }
412
413   if (fRunLoader) {
414     if (fRunLoader->GetEvent(event) != 0)
415       throw (kEH + "failed getting required event.");
416   }
417
418   if (fRawReader)
419   {
420     // AliRawReader::GotoEvent(Int_t) works for AliRawReaderRoot/Chain.
421     if (fRawReader->GotoEvent(event) == kFALSE)
422     {
423       // Use fallback method - iteration with NextEvent().
424       Int_t rawEv = fEventId;
425       if (event < rawEv)
426       {
427         fRawReader->RewindEvents();
428         rawEv = -1;
429       }
430
431       while (rawEv < event)
432       {
433         if ( ! fRawReader->NextEvent())
434         {
435           fRawReader->RewindEvents();
436           fEventId = -1;
437           throw (kEH + Form("Error going to next raw-event from event %d.", rawEv));
438         }
439         ++rawEv;
440       }
441       Warning(kEH, "Loaded raw-event %d with fallback method.\n", rawEv);
442     }
443   }
444
445   fEventId = event;
446   SetName(Form("Event %d", fEventId));
447   ElementChanged();
448
449   AfterNewEventLoaded();
450 }
451
452 void AliEveEventManager::NextEvent()
453 {
454   // Loads next event
455   // either in automatic (online) or
456   // manual mode
457   
458   if (fIsOnline) {
459     if (fAutoLoadTimer) fAutoLoadTimer->Stop();
460
461     DestroyElements();
462
463     gSystem->ExitLoop();
464   }
465   else {
466     if (fEventId < GetMaxEventId(kTRUE))
467       GotoEvent(fEventId + 1);
468     else
469       GotoEvent(0);
470     StartStopAutoLoadTimer();
471   }
472 }
473
474 void AliEveEventManager::PrevEvent()
475 {
476   // Loads previous event
477   // only in case of manual mode
478   if (!fIsOnline) {
479     GotoEvent(fEventId - 1);
480     StartStopAutoLoadTimer();
481   }
482 }
483
484 void AliEveEventManager::Close()
485 {
486   // Close the event data-files and delete ESD, ESDfriend, run-loader
487   // and raw-reader.
488
489   if (fESDTree) {
490     delete fESD;       fESD       = 0;
491     delete fESDfriend; fESDfriend = 0;
492
493     delete fESDTree;   fESDTree = 0;
494     delete fESDFile;   fESDFile = 0;
495   }
496
497   if (fRunLoader) {
498     delete fRunLoader; fRunLoader = 0;
499   }
500
501   if (fRawReader) {
502     delete fRawReader; fRawReader = 0;
503   }
504 }
505
506
507 /******************************************************************************/
508 // Static convenience functions, mainly used from macros.
509 /******************************************************************************/
510
511 AliRunLoader* AliEveEventManager::AssertRunLoader()
512 {
513   // Make sure AliRunLoader is initialized and return it.
514   // Throws exception in case run-loader is not available.
515   // Static utility for macros.
516
517   static const TEveException kEH("AliEveEventManager::AssertRunLoader ");
518
519   if (gAliEveEvent == 0)
520     throw (kEH + "ALICE event not ready.");
521   if (gAliEveEvent->fRunLoader == 0)
522     throw (kEH + "AliRunLoader not initialised.");
523   return gAliEveEvent->fRunLoader;
524 }
525
526 AliESDEvent* AliEveEventManager::AssertESD()
527 {
528   // Make sure AliESDEvent is initialized and return it.
529   // Throws exception in case ESD is not available.
530   // Static utility for macros.
531
532   static const TEveException kEH("AliEveEventManager::AssertESD ");
533
534   if (gAliEveEvent == 0)
535     throw (kEH + "ALICE event not ready.");
536   if (gAliEveEvent->fESD == 0)
537     throw (kEH + "AliESD not initialised.");
538   return gAliEveEvent->fESD;
539 }
540
541 AliESDfriend* AliEveEventManager::AssertESDfriend()
542 {
543   // Make sure AliESDfriend is initialized and return it.
544   // Throws exception in case ESDfriend-loader is not available.
545   // Static utility for macros.
546
547   static const TEveException kEH("AliEveEventManager::AssertESDfriend ");
548
549   if (gAliEveEvent == 0)
550     throw (kEH + "ALICE event not ready.");
551   if (gAliEveEvent->fESDfriend == 0)
552     throw (kEH + "AliESDfriend not initialised.");
553   return gAliEveEvent->fESDfriend;
554 }
555
556 AliRawReader* AliEveEventManager::AssertRawReader()
557 {
558   // Make sure raw-reader is initialized and return it.
559
560   static const TEveException kEH("AliEveEventManager::AssertRawReader ");
561
562   if (gAliEveEvent == 0)
563     throw (kEH + "ALICE event not ready.");
564   if (gAliEveEvent->fRawReader == 0)
565     throw (kEH + "RawReader not ready.");
566
567   return gAliEveEvent->fRawReader;
568 }
569
570 AliMagF* AliEveEventManager::AssertMagField()
571 {
572   // Make sure AliMagF is initialized and return it.
573   // Throws exception in case magnetic field is not available.
574   // Static utility for macros.
575
576   if (fgMagField == 0)
577   {
578     if (gAliEveEvent && gAliEveEvent->fRunLoader && gAliEveEvent->fRunLoader->GetAliRun())
579       fgMagField = gAliEveEvent->fRunLoader->GetAliRun()->Field();
580     else
581       fgMagField = new AliMagFMaps("Maps","Maps", 1, 1., 10., AliMagFMaps::k5kG);
582   }
583   return fgMagField;
584 }
585
586 TGeoManager* AliEveEventManager::AssertGeometry()
587 {
588   // Make sure AliGeomManager is initialized and returns the
589   // corresponding TGeoManger.
590   // gGeoManager is set to the return value.
591   // Throws exception if geometry can not be loaded or if it is not
592   // available and the TGeoManager is locked.
593   // Static utility for macros.
594
595   static const TEveException kEH("AliEveEventManager::AssertGeometry ");
596
597   if (AliGeomManager::GetGeometry() == 0)
598   {
599     if (TGeoManager::IsLocked())
600       throw (kEH + "geometry is not loaded but TGeoManager is locked.");
601
602     gGeoManager = 0;
603     AliGeomManager::LoadGeometry();
604     if ( ! AliGeomManager::GetGeometry())
605     {
606       throw (kEH + "can not load geometry.");
607     }
608     if ( ! AliGeomManager::ApplyAlignObjsFromCDB("ITS TPC TRD TOF PHOS HMPID EMCAL MUON FMD ZDC PMD T0 VZERO ACORDE"))
609     {
610       ::Warning(kEH, "mismatch of alignable volumes. Proceeding.");
611       // throw (kEH + "could not apply align objs.");
612     }
613     AliGeomManager::GetGeometry()->DefaultColors();
614   }
615
616   gGeoManager = AliGeomManager::GetGeometry();
617   return gGeoManager;
618 }
619
620 void AliEveEventManager::SetAutoLoad(Bool_t autoLoad)
621 {
622   // Set the automatic event loading mode
623   fAutoLoad = autoLoad;
624   StartStopAutoLoadTimer();
625 }
626
627 void AliEveEventManager::SetAutoLoadTime(Double_t time)
628 {
629   // Set the auto-load time in seconds
630   fAutoLoadTime = time;
631   StartStopAutoLoadTimer();
632 }
633
634 void AliEveEventManager::StartStopAutoLoadTimer()
635 {
636   // Create if needed and start
637   // the automatic event loading timer
638   if (fAutoLoad) {
639     if (!fAutoLoadTimer) {
640       fAutoLoadTimer = new TTimer;
641       fAutoLoadTimer->Connect("Timeout()","AliEveEventManager",this,"NextEvent()");
642     }
643     fAutoLoadTimer->Start((Long_t)fAutoLoadTime*1000,kTRUE);
644   }
645   else {
646     if (fAutoLoadTimer) fAutoLoadTimer->Stop();
647   }
648 }
649
650 const char* AliEveEventManager::GetEventInfo() const
651 {
652   // Dumps the event-header contents
653
654   static TString eventInfo;
655
656   if (!fRawReader) {
657     eventInfo.Form("No raw-data event info is available!\n");
658   }
659   else {
660     const UInt_t* attr = fRawReader->GetAttributes();
661     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",
662                    fRawReader->GetRunNumber(),fRawReader->GetType(),AliRawEventHeaderBase::GetTypeName(fRawReader->GetType()),
663                    fRawReader->GetPeriod(),fRawReader->GetOrbitID(),fRawReader->GetBCID(),
664                    fRawReader->GetClassMask(),
665                    *fRawReader->GetDetectorPattern(),AliDAQ::ListOfTriggeredDetectors(*fRawReader->GetDetectorPattern()),
666                    attr[0],attr[1],attr[2],
667                    fRawReader->GetTimestamp());
668   }
669   if (!fESD) {
670     eventInfo.Append(Form("\nNo ESD event info is available!\n"));
671   }
672   else {
673     TString acttrclasses = fESD->GetESDRun()->GetActiveTriggerClasses();
674     TString firedtrclasses = fESD->GetFiredTriggerClasses();
675     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",
676                           fESD->GetRunNumber(),
677                           acttrclasses.Data(),
678                           fESD->GetEventType(),AliRawEventHeaderBase::GetTypeName(fESD->GetEventType()),
679                           fESD->GetPeriodNumber(),fESD->GetOrbitNumber(),fESD->GetBunchCrossNumber(),
680                           fESD->GetTriggerMask(),firedtrclasses.Data(),
681                           fESD->GetEventNumberInFile(),
682                           fESD->GetTimeStamp()));
683   }
684
685   return eventInfo.Data();
686 }
687