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