PHOS/AliPHOSGetter.h

   1 #ifndef ALIPHOSGETTER_H
   2 #define ALIPHOSGETTER_H
   3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   4  * See cxx source for full Copyright notice                               */
   5
   6 /* $Id$ */
   7
   8 //_________________________________________________________________________
   9 //  A singleton that returns various objects
  10 //  Should be used on the analysis stage to avoid confusing between different
  11 //  branches of reconstruction tree: e.g. reading RecPoints and TS made from
  12 //  another set of RecPoints.
  13 //
  14 //  The objects are retrived from folders.
  15 //*-- Author: Yves Schutz (SUBATECH) & Dmitri Peressounko (RRC KI & SUBATECH)
  16 //
  17
  18
  19 // --- ROOT system ---
  20 #include "TClonesArray.h"
  21 #include "TFolder.h"
  22 #include "TTree.h"
  23 class TString ;
  24 class TParticle ;
  25 class TTask ;
  26
  27 // --- Standard library ---
  28 #include <stdlib.h>
  29 #include <iostream.h>
  30
  31 // --- AliRoot header files ---
  32
  33 #include "AliRun.h"
  34 #include "AliPHOS.h"
  35 #include "AliPHOSHit.h"
  36 #include "AliPHOSDigit.h"
  37 #include "AliPHOSEmcRecPoint.h"
  38 #include "AliPHOSCpvRecPoint.h"
  39 #include "AliPHOSTrackSegment.h"
  40 #include "AliPHOSRecParticle.h"
  41 class AliPHOSGeometry ;
  42 class AliPHOSDigitizer ;
  43 class AliPHOSSDigitizer ;
  44 class AliPHOSClusterizer ;
  45 class AliPHOSTrackSegmentMaker ;
  46 class AliPHOSPID ;
  47
  48 class AliPHOSGetter : public TObject {
  49
  50  public:
  51
  52   AliPHOSGetter(){    // ctor: this is a singleton, the ctor should never be called but cint needs it as public
  53     cerr << "ERROR: AliPHOGetter is a singleton default ctor not callable" << endl ;
  54     abort() ;
  55   }
  56   AliPHOSGetter(const AliPHOSGetter & obj) {
  57     // cpy ctor requested by Coding Convention
  58     // but not yet needed
  59     abort() ;
  60   }
  61
  62   virtual ~AliPHOSGetter() ;
  63
  64   const Bool_t HasFailed() const { return fFailed ; }
  65   Bool_t PostPrimaries(void ) const ;
  66   Bool_t PostHits(void ) const ;
  67   Bool_t PostSDigits(      const char * name,  const char * file = 0) const ;
  68   Bool_t PostDigits(       const char * name ) const ;
  69   Bool_t PostRecPoints(    const char * name ) const ;
  70   Bool_t PostTrackSegments(const char * name) const ;
  71   Bool_t PostRecParticles( const char * name) const ;
  72
  73   Bool_t PostClusterizer( const char * name) const ;
  74   Bool_t PostClusterizer(AliPHOSClusterizer * clu) const ;
  75   Bool_t PostSDigitizer (AliPHOSSDigitizer * sdigitizer) const ;
  76   Bool_t PostSDigitizer ( const char * name, const char * file ) const ;
  77   Bool_t PostDigitizer (AliPHOSDigitizer * digitizer) const ;
  78   Bool_t PostDigitizer  ( const char * name) const ;
  79   Bool_t PostTrackSegmentMaker(AliPHOSTrackSegmentMaker * tsm) const ;
  80   Bool_t PostTrackSegmentMaker(const char * name ) const ;
  81   Bool_t PostPID  (AliPHOSPID * pid) const ;
  82   Bool_t PostPID  (const char * name ) const ;
  83   Bool_t PostQA   (void) const ;
  84
  85
  86   void   Event(const Int_t event, const char * opt = "HSDRP") ;
  87   void   Track(Int_t itrack) ;
  88
  89   //Method to be used when digitizing under AliRunDigitizer, who opens all files etc.
  90   void   ReadTreeS(TTree * treeS,Int_t input) ;
  91
  92   Int_t  EventNumber()       { return (Int_t) gAlice->GetEvNumber() ; }
  93   Int_t  MaxEvent()          { return (Int_t) gAlice->TreeE()->GetEntries() ; }
  94   static AliPHOSGetter * GetInstance(const char* headerFile,
  95                                      const char* branchTitle = "Default" ) ;
  96   static AliPHOSGetter *   GetInstance() ;
  97
  98   const AliPHOS *         PHOS()  ;
  99   const  AliPHOSGeometry * PHOSGeometry() ;
 100    // Alarms
 101   TFolder * Alarms() const { return (TFolder*)(ReturnO("Alarms", 0)) ; }
 102   TObjArray *  Alarms(const char * name ) const { return (TObjArray*)(ReturnO("Alarms", name)) ; }
 103
 104   // QA Tasks
 105   TTask * QATasks(const char * name = 0) const { return (TTask*)(ReturnT("QATasks", name)) ; }
 106
 107   // Primaries
 108   TClonesArray *  Primaries(void) const { return (TClonesArray*)(ReturnO("Primaries")) ; }
 109   // Hits
 110   const TClonesArray *  Hits(void) { return static_cast<const TClonesArray*>(ReturnO("Hits")) ; }
 111   const AliPHOSHit * Hit(Int_t index)  { return static_cast<const AliPHOSHit*>(Hits()->At(index) );}
 112
 113   // SDigits
 114   TClonesArray *  SDigits(const char * name = 0, const char * file=0) {
 115     return static_cast<TClonesArray*>(ReturnO("SDigits", name, file)) ;
 116   }
 117   const AliPHOSDigit *  SDigit(Int_t index) { return static_cast<const AliPHOSDigit*>(SDigits()->At(index)) ;}
 118
 119   AliPHOSSDigitizer *  SDigitizer(const char * name =0) const {
 120     return ((AliPHOSSDigitizer*)(ReturnT("SDigitizer", name))) ;
 121   }
 122
 123   // Digits
 124   TClonesArray *  Digits(const char * name = 0)const  {
 125     return static_cast<TClonesArray*>(ReturnO("Digits", name)) ;
 126   }
 127   const AliPHOSDigit *  Digit(Int_t index) { return static_cast<const AliPHOSDigit *>(Digits()->At(index)) ;}
 128   AliPHOSDigitizer *  Digitizer(const char * name =0) const {
 129     return (AliPHOSDigitizer*)(ReturnT("Digitizer", name)) ;
 130   }
 131
 132   // RecPoints
 133   TObjArray * EmcRecPoints(const char * name = 0) {
 134     return static_cast<TObjArray*>(ReturnO("EmcRecPoints", name)) ;
 135   }
 136   TObjArray * CpvRecPoints(const char * name = 0) {
 137     return static_cast<TObjArray*>(ReturnO("CpvRecPoints", name)) ;
 138   }
 139   const AliPHOSEmcRecPoint * EmcRecPoint(Int_t index) {
 140     return static_cast<const AliPHOSEmcRecPoint *>(EmcRecPoints()->At(index)) ;
 141   }
 142   const AliPHOSCpvRecPoint * CpvRecPoint(Int_t index) {
 143     return static_cast<const AliPHOSCpvRecPoint *>(CpvRecPoints()->At(index)) ;
 144   }
 145
 146   AliPHOSClusterizer * Clusterizer (const char * name =0) const {
 147     return (AliPHOSClusterizer*)(ReturnT("Clusterizer", name)) ;
 148   }
 149
 150   // TrackSegments
 151   TClonesArray * TrackSegments(const char * name = 0) {
 152     return static_cast<TClonesArray*>(ReturnO("TrackSegments", name)) ;
 153   }
 154   const AliPHOSTrackSegment * TrackSegment(Int_t index) {
 155     return static_cast<const AliPHOSTrackSegment*>(TrackSegments()->At(index)) ;
 156   }
 157   AliPHOSTrackSegmentMaker * TrackSegmentMaker (const char * name =0) const {
 158     return (AliPHOSTrackSegmentMaker*)(ReturnT("TrackSegmentMaker", name)) ;
 159   }
 160
 161   // RecParticles
 162   TClonesArray * RecParticles(const char * name = 0) {
 163     return static_cast<TClonesArray*>(ReturnO("RecParticles", name)) ;
 164   }
 165   const AliPHOSRecParticle * RecParticle(Int_t index) {
 166     return static_cast<const AliPHOSRecParticle*>(RecParticles()->At(index)) ;
 167   }
 168   AliPHOSPID * PID(const char * name =0) const {
 169     return (AliPHOSPID*)(ReturnT("PID", name)) ;
 170   }
 171
 172   // Primaries
 173   const TParticle *           Primary(Int_t index) const ;
 174   const Int_t                 NPrimaries()const { return fNPrimaries; }
 175   const TParticle *           Secondary(TParticle * p, Int_t index=1) const ;
 176
 177   void  SetDebug(Int_t level) {fDebug = level;} // Set debug level
 178
 179   AliPHOSGetter & operator = (const AliPHOSGetter & ) {
 180     // assignement operator requested by coding convention, but not needed
 181     abort() ;
 182     return *this ;
 183   }
 184
 185   TFolder * SDigitsFolder() { return dynamic_cast<TFolder*>(fSDigitsFolder->FindObject("PHOS")) ; }
 186
 187   void SetRecParticlesTitle(const TString title) { fRecParticlesTitle = title ; }
 188
 189 private:
 190
 191   AliPHOSGetter(const char* headerFile, const char* branchTitle ="Default") ;
 192   void CreateWhiteBoard() const ;
 193   TObject * ReturnO(TString what, TString name=0, TString file=0) const ;
 194   const TTask * ReturnT(TString what,TString name=0) const ;
 195   void DefineBranchTitles(char* branch, char* branchTitle) ;
 196   Int_t ReadTreeD() ;
 197   Int_t ReadTreeH() ;
 198   Int_t ReadTreeR(Bool_t any=kFALSE) ;
 199   Int_t ReadTreeS(Int_t event) ;
 200   void ReadTreeQA() ;
 201   void ReadPrimaries() ;
 202
 203   TObject** PrimariesRef(void) const ;
 204   TObject** HitsRef(void) const ;
 205   TObject** SDigitsRef(const char * name, const char * file = 0 ) const;
 206   TObject** DigitsRef (const char * name)   const ;
 207   TObject** EmcRecPointsRef (const char * name) const ;
 208   TObject** CpvRecPointsRef (const char * name) const ;
 209   TObject** TrackSegmentsRef(const char * name)   const ;
 210   TObject** RecParticlesRef (const char * name)   const ;
 211   TObject** AlarmsRef (void)   const ;
 212
 213   TObject** SDigitizerRef (const char * name) const ;
 214   TObject** DigitizerRef  (const char * name) const ;
 215   TObject** ClusterizerRef(const char * name) const ;
 216   TObject** TSMakerRef    (const char * name) const ;
 217   TObject** PIDRef        (const char * name) const ;
 218
 219  private:
 220
 221   static TFile *        fFile;               //!
 222   TString        fHeaderFile ;        //! File in which gAlice lives
 223   TString        fBranchTitle ;       //!
 224   TString        fTrackSegmentsTitle ;//!
 225   TString        fRecPointsTitle ;    //!
 226   TString        fRecParticlesTitle ; //!
 227   TString        fDigitsTitle ;       //! TDirectory tempo(gDirectory) ;
 228
 229   TString        fSDigitsTitle ;      //!
 230
 231   Bool_t         fFailed ;            //! set if file not opend or galice not found
 232   Int_t          fDebug ;             // Debug level
 233
 234   Int_t          fNPrimaries ;        //! # of primaries
 235
 236   TObjArray *    fPrimaries ;         //! list of lists of primaries-for the case of mixing
 237
 238   TFolder *      fModuleFolder ;      //!Folder that contains the modules
 239   TFolder *      fPrimariesFolder ;   //!Folder that contains the Primary Particles
 240   TFolder *      fHitsFolder ;        //!Folder that contains the Hits
 241   TFolder *      fSDigitsFolder ;     //!Folder that contains the SDigits
 242   TFolder *      fDigitsFolder ;      //!Folder that contains the Digits
 243   TFolder *      fRecoFolder ;        //!Folder that contains the reconstructed objects (RecPoints, TrackSegments, RecParticles)
 244   TFolder *      fQAFolder ;          //!Folder that contains the QA objects
 245   TFolder *      fTasksFolder ;       //!Folder that contains the Tasks (sdigitizer, digitizer, reconstructioner)
 246
 247   static AliPHOSGetter * fgObjGetter; // pointer to the unique instance of the singleton
 248
 249   ClassDef(AliPHOSGetter,1)  // Algorithm class that provides methods to retrieve objects from a list knowing the index
 250
 251 };
 252
 253 #endif // AliPHOSGETTER_H