1 /**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
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 **************************************************************************/
18 //_________________________________________________________________________
19 // A singleton. This class should be used in the analysis stage to get
20 // reconstructed objects: Digits, RecPoints, TrackSegments and RecParticles,
21 // instead of directly reading them from galice.root file. This container
22 // ensures, that one reads Digits, made of these particular digits, RecPoints,
23 // made of these particular RecPoints, TrackSegments and RecParticles.
24 // This becomes non trivial if there are several identical branches, produced with
25 // different set of parameters.
27 // An example of how to use (see also class AliPHOSAnalyser):
28 // AliPHOSGetter * gime = AliPHOSGetter::GetInstance("galice.root","test") ;
29 // for(Int_t irecp = 0; irecp < gime->NRecParticles() ; irecp++)
30 // AliPHOSRecParticle * part = gime->RecParticle(1) ;
32 // gime->Event(event) ; // reads new event from galice.root
34 //*-- Author: Yves Schutz (SUBATECH) & Dmitri Peressounko (RRC KI & SUBATECH)
35 //*-- Completely redesigned by Dmitri Peressounko March 2001
37 //*-- YS June 2001 : renamed the original AliPHOSIndexToObject and make
38 //*-- systematic usage of TFolders without changing the interface
39 //////////////////////////////////////////////////////////////////////////////
41 // --- ROOT system ---
46 #include <TParticle.h>
49 //#include <TCanvas.h>
52 // --- Standard library ---
54 // --- AliRoot header files ---
56 #include "AliHeader.h"
59 #include "AliPHOSBeamTestEvent.h"
60 #include "AliPHOSGetter.h"
61 #include "AliPHOSLoader.h"
62 #include "AliRunLoader.h"
64 #include "AliPHOSRawStream.h"
65 #include "AliRawReaderFile.h"
68 ClassImp(AliPHOSGetter)
70 AliPHOSGetter * AliPHOSGetter::fgObjGetter = 0 ;
71 AliPHOSLoader * AliPHOSGetter::fgPhosLoader = 0;
72 Int_t AliPHOSGetter::fgDebug = 0;
74 // TFile * AliPHOSGetter::fgFile = 0 ;
76 //____________________________________________________________________________
77 AliPHOSGetter::AliPHOSGetter(const char* headerFile, const char* version, Option_t * openingOption)
79 // ctor only called by Instance()
81 AliRunLoader* rl = AliRunLoader::GetRunLoader(version) ;
83 rl = AliRunLoader::Open(headerFile, version, openingOption);
85 Fatal("AliPHOSGetter", "Could not find the Run Loader for %s - %s",headerFile, version) ;
88 if (rl->GetAliRun() == 0x0) {
90 gAlice = rl->GetAliRun(); // should be removed
93 fgPhosLoader = dynamic_cast<AliPHOSLoader*>(rl->GetLoader("PHOSLoader"));
95 Error("AliPHOSGetter", "Could not find PHOSLoader") ;
97 fgPhosLoader->SetTitle(version);
99 // initialize data members
103 fLoadingStatus = "" ;
105 fESDFileName = rl->GetFileName() ; // this should be the galice.root file
106 fESDFileName.ReplaceAll("galice.root", "AliESDs.root") ;
110 fRawDigits = kFALSE ;
113 //____________________________________________________________________________
114 AliPHOSGetter::~AliPHOSGetter()
118 delete fgPhosLoader ;
126 fPrimaries->Delete() ;
137 //____________________________________________________________________________
138 void AliPHOSGetter::Reset()
140 // resets things in case the getter is called consecutively with different files
141 // the PHOS Loader is already deleted by the Run Loader
144 fPrimaries->Delete() ;
151 //____________________________________________________________________________
152 AliPHOSClusterizer * AliPHOSGetter::Clusterizer()
154 // Returns pointer to the Clusterizer task
155 AliPHOSClusterizer * rv ;
156 rv = dynamic_cast<AliPHOSClusterizer *>(PhosLoader()->Reconstructioner()) ;
159 rv = dynamic_cast<AliPHOSClusterizer*>(PhosLoader()->Reconstructioner()) ;
164 //____________________________________________________________________________
165 TObjArray * AliPHOSGetter::CpvRecPoints()
167 // asks the Loader to return the CPV RecPoints container
171 rv = PhosLoader()->CpvRecPoints() ;
173 PhosLoader()->MakeRecPointsArray() ;
174 rv = PhosLoader()->CpvRecPoints() ;
179 //____________________________________________________________________________
180 TClonesArray * AliPHOSGetter::Digits()
182 // asks the Loader to return the Digits container
184 TClonesArray * rv = 0 ;
185 rv = PhosLoader()->Digits() ;
188 PhosLoader()->MakeDigitsArray() ;
189 rv = PhosLoader()->Digits() ;
194 //____________________________________________________________________________
195 AliPHOSDigitizer * AliPHOSGetter::Digitizer()
197 // Returns pointer to the Digitizer task
198 AliPHOSDigitizer * rv ;
199 rv = dynamic_cast<AliPHOSDigitizer *>(PhosLoader()->Digitizer()) ;
202 rv = dynamic_cast<AliPHOSDigitizer *>(PhosLoader()->Digitizer()) ;
208 //____________________________________________________________________________
209 TObjArray * AliPHOSGetter::EmcRecPoints()
211 // asks the Loader to return the EMC RecPoints container
215 rv = PhosLoader()->EmcRecPoints() ;
217 PhosLoader()->MakeRecPointsArray() ;
218 rv = PhosLoader()->EmcRecPoints() ;
223 //____________________________________________________________________________
224 TClonesArray * AliPHOSGetter::TrackSegments()
226 // asks the Loader to return the TrackSegments container
228 TClonesArray * rv = 0 ;
230 rv = PhosLoader()->TrackSegments() ;
232 PhosLoader()->MakeTrackSegmentsArray() ;
233 rv = PhosLoader()->TrackSegments() ;
238 //____________________________________________________________________________
239 AliPHOSTrackSegmentMaker * AliPHOSGetter::TrackSegmentMaker()
241 // Returns pointer to the TrackSegmentMaker task
242 AliPHOSTrackSegmentMaker * rv ;
243 rv = dynamic_cast<AliPHOSTrackSegmentMaker *>(PhosLoader()->TrackSegmentMaker()) ;
246 rv = dynamic_cast<AliPHOSTrackSegmentMaker *>(PhosLoader()->TrackSegmentMaker()) ;
251 //____________________________________________________________________________
252 TClonesArray * AliPHOSGetter::RecParticles()
254 // asks the Loader to return the TrackSegments container
256 TClonesArray * rv = 0 ;
258 rv = PhosLoader()->RecParticles() ;
260 PhosLoader()->MakeRecParticlesArray() ;
261 rv = PhosLoader()->RecParticles() ;
265 //____________________________________________________________________________
266 void AliPHOSGetter::Event(Int_t event, const char* opt)
268 // Reads the content of all Tree's S, D and R
270 // if ( event >= MaxEvent() ) {
271 // Error("Event", "%d not found in TreeE !", event) ;
275 AliRunLoader * rl = AliRunLoader::GetRunLoader(PhosLoader()->GetTitle());
277 // // checks if we are dealing with test-beam data
278 // TBranch * btb = rl->TreeE()->GetBranch("AliPHOSBeamTestEvent") ;
281 // fBTE = new AliPHOSBeamTestEvent() ;
282 // btb->SetAddress(&fBTE) ;
283 // btb->GetEntry(event) ;
292 // Loads the type of object(s) requested
294 rl->GetEvent(event) ;
296 if(strstr(opt,"X") || (strcmp(opt,"")==0)){
300 if(strstr(opt,"H") ){
304 if(strstr(opt,"S") ){
308 if(strstr(opt,"D") ){
312 if(strstr(opt,"R") ){
316 if( strstr(opt,"T") ){
320 if( strstr(opt,"P") ){
324 if( strstr(opt,"E") ){
328 if( strstr(opt,"W") ){
335 //____________________________________________________________________________
336 Int_t AliPHOSGetter::EventNumber() const
338 // return the current event number
339 AliRunLoader * rl = AliRunLoader::GetRunLoader(PhosLoader()->GetTitle());
340 return static_cast<Int_t>(rl->GetEventNumber()) ;
343 //____________________________________________________________________________
344 TClonesArray * AliPHOSGetter::Hits()
346 // asks the loader to return the Hits container
348 TClonesArray * rv = 0 ;
350 rv = PhosLoader()->Hits() ;
352 PhosLoader()->LoadHits("read");
353 rv = PhosLoader()->Hits() ;
358 //____________________________________________________________________________
359 AliPHOSGetter * AliPHOSGetter::Instance(const char* alirunFileName, const char* version, Option_t * openingOption)
361 // Creates and returns the pointer of the unique instance
362 // Must be called only when the environment has changed
364 if(!fgObjGetter){ // first time the getter is called
365 fgObjGetter = new AliPHOSGetter(alirunFileName, version, openingOption) ;
367 else { // the getter has been called previously
368 AliRunLoader * rl = AliRunLoader::GetRunLoader(fgPhosLoader->GetTitle());
369 if ( rl->GetFileName() == alirunFileName ) {// the alirunFile has the same name
370 // check if the file is already open
371 TFile * galiceFile = dynamic_cast<TFile *>(gROOT->FindObject(rl->GetFileName()) ) ;
374 fgObjGetter = new AliPHOSGetter(alirunFileName, version, openingOption) ;
376 else { // the file is already open check the version name
377 TString currentVersionName = rl->GetEventFolder()->GetName() ;
378 TString newVersionName(version) ;
379 if (currentVersionName == newVersionName)
381 ::Warning( "Instance", "Files with version %s already open", currentVersionName.Data() ) ;
383 fgObjGetter = new AliPHOSGetter(alirunFileName, version, openingOption) ;
388 AliRunLoader * rl = AliRunLoader::GetRunLoader(fgPhosLoader->GetTitle()) ;
389 if ( strstr(version, AliConfig::GetDefaultEventFolderName()) ) // false in case of merging
391 fgObjGetter = new AliPHOSGetter(alirunFileName, version, openingOption) ;
395 ::Error("AliPHOSGetter::Instance", "Failed to create the PHOS Getter object") ;
403 //____________________________________________________________________________
404 AliPHOSGetter * AliPHOSGetter::Instance()
406 // Returns the pointer of the unique instance already defined
408 if(!fgObjGetter && fgDebug)
409 ::Warning("AliPHOSGetter::Instance", "Getter not initialized") ;
415 //____________________________________________________________________________
416 Int_t AliPHOSGetter::MaxEvent() const
418 // returns the number of events in the run (from TE)
420 AliRunLoader * rl = AliRunLoader::GetRunLoader(PhosLoader()->GetTitle());
421 return static_cast<Int_t>(rl->GetNumberOfEvents()) ;
424 //____________________________________________________________________________
425 TParticle * AliPHOSGetter::Primary(Int_t index) const
427 AliRunLoader * rl = AliRunLoader::GetRunLoader(PhosLoader()->GetTitle());
428 return rl->Stack()->Particle(index) ;
431 //____________________________________________________________________________
432 AliPHOS * AliPHOSGetter:: PHOS() const
434 // returns the PHOS object
435 AliPHOSLoader * loader = 0;
436 static AliPHOSLoader * oldloader = 0;
437 static AliPHOS * phos = 0;
439 loader = PhosLoader();
441 if ( loader != oldloader) {
442 phos = dynamic_cast<AliPHOS*>(loader->GetModulesFolder()->FindObject("PHOS")) ;
447 Warning("PHOS", "PHOS module not found in module folders: %s", PhosLoader()->GetModulesFolder()->GetName() ) ;
453 //____________________________________________________________________________
454 AliPHOSPID * AliPHOSGetter::PID()
456 // Returns pointer to the PID task
458 rv = dynamic_cast<AliPHOSPID *>(PhosLoader()->PIDTask()) ;
461 rv = dynamic_cast<AliPHOSPID *>(PhosLoader()->PIDTask()) ;
466 //____________________________________________________________________________
467 AliPHOSGeometry * AliPHOSGetter::PHOSGeometry() const
469 // Returns PHOS geometry
471 AliPHOSGeometry * rv = 0 ;
473 rv = PHOS()->GetGeometry() ;
477 //____________________________________________________________________________
478 TClonesArray * AliPHOSGetter::Primaries()
480 // creates the Primaries container if needed
483 Info("Primaries", "Creating a new TClonesArray for primaries") ;
484 fPrimaries = new TClonesArray("TParticle", 1000) ;
489 //____________________________________________________________________________
490 void AliPHOSGetter::Print()
492 // Print usefull information about the getter
494 AliRunLoader * rl = AliRunLoader::GetRunLoader(fgPhosLoader->GetTitle());
495 ::Info( "Print", "gAlice file is %s -- version name is %s", (rl->GetFileName()).Data(), rl->GetEventFolder()->GetName() ) ;
498 //____________________________________________________________________________
499 void AliPHOSGetter::ReadPrimaries()
501 // Read Primaries from Kinematics.root
503 AliRunLoader * rl = AliRunLoader::GetRunLoader(PhosLoader()->GetTitle());
505 // gets kine tree from the root file (Kinematics.root)
506 if ( ! rl->TreeK() ) { // load treeK the first time
507 rl->LoadKinematics() ;
510 fNPrimaries = (rl->GetHeader())->GetNtrack();
512 Info( "ReadTreeK", "Found %d particles in event # %d", fNPrimaries, EventNumber() ) ;
515 // first time creates the container
517 fPrimaries->Clear() ;
520 for (index = 0 ; index < fNPrimaries; index++) {
521 new ((*fPrimaries)[index]) TParticle(*(Primary(index)));
525 //____________________________________________________________________________
526 Bool_t AliPHOSGetter::OpenESDFile()
531 fESDFile = TFile::Open(fESDFileName) ;
535 else if (fESDFile->IsOpen()) {
537 fESDFile = TFile::Open(fESDFileName) ;
539 if (!fESDFile->IsOpen())
544 //____________________________________________________________________________
545 Int_t AliPHOSGetter::ReadRaw(Int_t event)
547 // reads the raw format data, converts it into digits format and store digits in Digits()
550 AliRawReaderFile rawReader(event) ;
551 AliPHOSRawStream in(&rawReader);
553 TClonesArray * digits = Digits() ;
557 while ( in.Next() ) { // PHOS entries loop
559 Int_t amp = in.GetSignal() ;
560 Double_t time = in.GetTime() ;
563 relId[0] = in.GetModule() ;
564 if ( relId[0] >= PHOS()->GetRawFormatLowGainOffset() ) {
565 relId[0] -= PHOS()->GetRawFormatLowGainOffset() ;
568 relId[2] = in.GetRow() ;
569 relId[3] = in.GetColumn() ;
570 PHOSGeometry()->RelToAbsNumbering(relId, id) ;
572 if (amp > 0 && id >=0 ) {
573 new((*digits)[idigit]) AliPHOSDigit( -1, id, amp, time) ;
577 } // PHOS entries loop
581 return digits->GetEntriesFast() ;
583 //____________________________________________________________________________
584 Int_t AliPHOSGetter::ReadTreeD()
588 PhosLoader()->CleanDigits() ;
589 PhosLoader()->LoadDigits("UPDATE") ;
590 PhosLoader()->LoadDigitizer("UPDATE") ;
591 return Digits()->GetEntries() ;
594 //____________________________________________________________________________
595 Int_t AliPHOSGetter::ReadTreeH()
598 PhosLoader()->CleanHits() ;
599 // gets TreeH from the root file (PHOS.Hit.root)
600 //if ( !IsLoaded("H") ) {
601 PhosLoader()->LoadHits("UPDATE") ;
604 return Hits()->GetEntries() ;
607 //____________________________________________________________________________
608 Int_t AliPHOSGetter::ReadTreeR()
610 // Read the RecPoints
612 PhosLoader()->CleanRecPoints() ;
613 // gets TreeR from the root file (PHOS.RecPoints.root)
614 //if ( !IsLoaded("R") ) {
615 PhosLoader()->LoadRecPoints("UPDATE") ;
616 PhosLoader()->LoadClusterizer("UPDATE") ;
620 return EmcRecPoints()->GetEntries() ;
623 //____________________________________________________________________________
624 Int_t AliPHOSGetter::ReadTreeT()
626 // Read the TrackSegments
628 PhosLoader()->CleanTracks() ;
629 // gets TreeT from the root file (PHOS.TrackSegments.root)
630 //if ( !IsLoaded("T") ) {
631 PhosLoader()->LoadTracks("UPDATE") ;
632 PhosLoader()->LoadTrackSegmentMaker("UPDATE") ;
636 return TrackSegments()->GetEntries() ;
638 //____________________________________________________________________________
639 Int_t AliPHOSGetter::ReadTreeP()
641 // Read the RecParticles
643 PhosLoader()->CleanRecParticles() ;
645 // gets TreeT from the root file (PHOS.TrackSegments.root)
646 // if ( !IsLoaded("P") ) {
647 PhosLoader()->LoadRecParticles("UPDATE") ;
648 PhosLoader()->LoadPID("UPDATE") ;
652 return RecParticles()->GetEntries() ;
654 //____________________________________________________________________________
655 Int_t AliPHOSGetter::ReadTreeS()
659 PhosLoader()->CleanSDigits() ;
660 // gets TreeS from the root file (PHOS.SDigits.root)
661 //if ( !IsLoaded("S") ) {
662 PhosLoader()->LoadSDigits("READ") ;
663 PhosLoader()->LoadSDigitizer("READ") ;
667 return SDigits()->GetEntries() ;
670 //____________________________________________________________________________
671 Int_t AliPHOSGetter::ReadTreeE(Int_t event)
675 // gets esdTree from the root file (AliESDs.root)
677 if ( !OpenESDFile() )
680 fESDTree = static_cast<TTree*>(fESDFile->Get("esdTree")) ;
684 Error("ReadTreeE", "no ESD tree found");
687 fESDTree->SetBranchAddress("ESD", &fESD);
688 fESDTree->GetEvent(event);
693 //____________________________________________________________________________
694 TClonesArray * AliPHOSGetter::SDigits()
696 // asks the Loader to return the Digits container
698 TClonesArray * rv = 0 ;
700 rv = PhosLoader()->SDigits() ;
702 PhosLoader()->MakeSDigitsArray() ;
703 rv = PhosLoader()->SDigits() ;
708 //____________________________________________________________________________
709 AliPHOSSDigitizer * AliPHOSGetter::SDigitizer()
711 // Returns pointer to the SDigitizer task
712 AliPHOSSDigitizer * rv ;
713 rv = dynamic_cast<AliPHOSSDigitizer *>(PhosLoader()->SDigitizer()) ;
716 rv = dynamic_cast<AliPHOSSDigitizer *>(PhosLoader()->SDigitizer()) ;
721 //____________________________________________________________________________
722 TParticle * AliPHOSGetter::Secondary(const TParticle* p, Int_t index) const
724 // Return first (index=1) or second (index=2) secondary particle of primary particle p
732 Int_t daughterIndex = p->GetDaughter(index-1) ;
733 AliRunLoader * rl = AliRunLoader::GetRunLoader(PhosLoader()->GetTitle());
734 return rl->GetAliRun()->GetMCApp()->Particle(daughterIndex) ;
740 //____________________________________________________________________________
741 void AliPHOSGetter::Track(Int_t itrack)
743 // Read the first entry of PHOS branch in hit tree gAlice->TreeH()
745 AliRunLoader * rl = AliRunLoader::GetRunLoader(PhosLoader()->GetTitle());
747 if( !TreeH() ) // load treeH the first time
750 // first time create the container
751 TClonesArray * hits = Hits() ;
755 TBranch * phosbranch = dynamic_cast<TBranch*>(TreeH()->GetBranch("PHOS")) ;
756 phosbranch->SetAddress(&hits) ;
757 phosbranch->GetEntry(itrack) ;
760 //____________________________________________________________________________
761 TTree * AliPHOSGetter::TreeD() const
763 // Returns pointer to the Digits Tree
765 rv = PhosLoader()->TreeD() ;
767 PhosLoader()->MakeTree("D");
768 rv = PhosLoader()->TreeD() ;
774 //____________________________________________________________________________
775 TTree * AliPHOSGetter::TreeH() const
777 // Returns pointer to the Hits Tree
779 rv = PhosLoader()->TreeH() ;
781 PhosLoader()->MakeTree("H");
782 rv = PhosLoader()->TreeH() ;
788 //____________________________________________________________________________
789 TTree * AliPHOSGetter::TreeR() const
791 // Returns pointer to the RecPoints Tree
793 rv = PhosLoader()->TreeR() ;
795 PhosLoader()->MakeTree("R");
796 rv = PhosLoader()->TreeR() ;
802 //____________________________________________________________________________
803 TTree * AliPHOSGetter::TreeT() const
805 // Returns pointer to the TrackSegments Tree
807 rv = PhosLoader()->TreeT() ;
809 PhosLoader()->MakeTree("T");
810 rv = PhosLoader()->TreeT() ;
815 //____________________________________________________________________________
816 TTree * AliPHOSGetter::TreeP() const
818 // Returns pointer to the RecParticles Tree
820 rv = PhosLoader()->TreeP() ;
822 PhosLoader()->MakeTree("P");
823 rv = PhosLoader()->TreeP() ;
829 //____________________________________________________________________________
830 TTree * AliPHOSGetter::TreeS() const
832 // Returns pointer to the SDigits Tree
834 rv = PhosLoader()->TreeS() ;
836 PhosLoader()->MakeTree("S");
837 rv = PhosLoader()->TreeS() ;
843 //____________________________________________________________________________
844 Bool_t AliPHOSGetter::VersionExists(TString & opt) const
846 // checks if the version with the present name already exists in the same directory
850 AliRunLoader * rl = AliRunLoader::GetRunLoader(PhosLoader()->GetTitle());
851 TString version( rl->GetEventFolder()->GetName() ) ;
855 if ( opt == "sdigits") {
856 // add the version name to the root file name
857 TString fileName( PhosLoader()->GetSDigitsFileName() ) ;
858 if (version != AliConfig::GetDefaultEventFolderName()) // only if not the default folder name
859 fileName = fileName.ReplaceAll(".root", "") + "_" + version + ".root" ;
860 if ( !(gSystem->AccessPathName(fileName)) ) {
861 Warning("VersionExists", "The file %s already exists", fileName.Data()) ;
864 PhosLoader()->SetSDigitsFileName(fileName) ;
867 if ( opt == "digits") {
868 // add the version name to the root file name
869 TString fileName( PhosLoader()->GetDigitsFileName() ) ;
870 if (version != AliConfig::GetDefaultEventFolderName()) // only if not the default folder name
871 fileName = fileName.ReplaceAll(".root", "") + "_" + version + ".root" ;
872 if ( !(gSystem->AccessPathName(fileName)) ) {
873 Warning("VersionExists", "The file %s already exists", fileName.Data()) ;
882 //____________________________________________________________________________
883 UShort_t AliPHOSGetter::EventPattern(void) const
885 // Return the pattern (trigger bit register) of the beam-test event
887 return fBTE->GetPattern() ;
891 //____________________________________________________________________________
892 Float_t AliPHOSGetter::BeamEnergy(void) const
894 // Return the beam energy of the beam-test event
896 return fBTE->GetBeamEnergy() ;