[u/mrichter/AliRoot.git] / STEER / AliRunLoader.h

#ifndef ALIRUNLoader_H
#define ALIRUNLoader_H

//___________________________________________________________________
/////////////////////////////////////////////////////////////////////
//                                                                 //
//  class AliRunLoader                                             //
//                                                                 //
//  This class aims to be the only one interface for manging data  //
//  It stores Loaders for all modules which knows the filenames    //
//  of the data files to be stored.                                //
//  It aims to substitude AliRun in automatic managing of data     //
//  positioning thus there won't be necessity of loading gAlice    //
//  from file in order to get fast access to the data              //
//                                                                 //
//  Logical place to put the specific Loader to the given          //
//  detector is detector  itself (i.e ITSLoader in ITS).           //
//  But, to load detector object one need to load gAlice, and      //
//  by the way all other detectors with their geometrieces and     //
//  so on. So, if one need to open TPC clusters there is no        //
//  principal nedd to read everything.                             //
//                                                                 //
/////////////////////////////////////////////////////////////////////

#include <TNamed.h>

#include "AliConfig.h"
#include "AliLoader.h"
#include "AliDataLoader.h"
#include "AliLog.h"

class TFile;
class TString;
class TFolder;
class TObjArray;
class TTree;
class TTask;
class TParticle;

class AliRun;
class AliLoader;
class AliDetector;
class AliHeader;
class AliStack;
class AliRunDigitizer;


class AliRunLoader: public TNamed
{
  public:
    
    AliRunLoader();
    AliRunLoader(const char* topfoldername);
    AliRunLoader(TFolder* topfolder);
    AliRunLoader(const AliRunLoader &rl);
    AliRunLoader & operator = (const AliRunLoader &rl) 
      {rl.Copy(*this); return *this;}
    
    virtual ~AliRunLoader();
    
    static AliRunLoader* Open(const char* filename = "galice.root",
                              const char* eventfoldername = AliConfig::GetDefaultEventFolderName(),
	          Option_t* option = "READ");

    Int_t       GetEventNumber() const {return fCurrentEvent;}

    Int_t       GetEvent(Int_t evno);//sets the event number and reloads data in folders properly
    Int_t       GetNextEvent(){return GetEvent(fCurrentEvent+1);}//gets next event 
    Int_t       SetEventNumber(Int_t evno); //cleans folders and sets the root dirs in files (do not reload data)
    Int_t       SetNextEvent(){return SetEventNumber(fCurrentEvent+1);}
    
    Int_t       GetNumberOfEvents();
    
    const TObject* GetRunObject(const char* name) const;

    void        MakeTree(Option_t *option);
    void        MakeHeader();
    void        MakeStack();
    
    Int_t       LoadgAlice();
    Int_t       LoadHeader();
    Int_t       LoadKinematics(Option_t* option = "READ");
    Int_t       LoadTrackRefs(Option_t* option = "READ");
    
    void        UnloadHeader();
    void        UnloadKinematics();
    void        UnloadgAlice();
    void        UnloadTrackRefs();
    
    void        SetKineFileName(const TString& fname){fKineDataLoader->SetFileName(fname);}
    void        SetTrackRefsFileName(const TString& fname){fTrackRefsDataLoader->SetFileName(fname);}
    
    TTree*      TreeE() const; //returns the tree from folder; shortcut method
    AliHeader*  GetHeader() const;
    
    AliStack*   Stack() const {return fStack;}
    
    TTree*      TreeK() const; //returns the tree from folder; shortcut method
    TTree*      TreeTR() const; //returns the tree from folder; shortcut method    
    
    AliRun*     GetAliRun()const;
        
    Int_t       WriteGeometry(Option_t* opt="");
    Int_t       WriteHeader(Option_t* opt="");
    Int_t       WriteAliRun(Option_t* opt="");
    Int_t       WriteKinematics(Option_t* opt="");
    Int_t       WriteTrackRefs(Option_t* opt="");
    Int_t       WriteRunLoader(Option_t* opt="");
    
    Int_t       WriteHits(Option_t* opt=""); 
    Int_t       WriteSDigits(Option_t* opt="");
    Int_t       WriteDigits(Option_t* opt="");
    Int_t       WriteRecPoints(Option_t* opt="");
    Int_t       WriteTracks(Option_t* opt="");
    
    Int_t       LoadHits(Option_t* detectors = "all",Option_t* opt = "RAED");
    Int_t       LoadSDigits(Option_t* detectors = "all",Option_t* opt = "RAED");
    Int_t       LoadDigits(Option_t* detectors = "all",Option_t* opt = "RAED");
    Int_t       LoadRecPoints(Option_t* detectors = "all",Option_t* opt = "RAED");
    Int_t       LoadTracks(Option_t* detectors = "all",Option_t* opt = "RAED");
    Int_t       LoadRecParticles(Option_t* detectors = "all",Option_t* opt = "RAED");
    
    void        UnloadHits(Option_t* detectors = "all");
    void        UnloadSDigits(Option_t* detectors = "all");
    void        UnloadDigits(Option_t* detectors = "all");
    void        UnloadRecPoints(Option_t* detectors = "all");
    void        UnloadTracks(Option_t* detectors = "all");
    void        UnloadRecParticles(Option_t* detectors = "all");
    void        UnloadAll(Option_t* detectors = "all");    
    
    void        AddLoader(AliLoader* loader);
    void        AddLoader(AliDetector* det);
    AliLoader*  GetLoader(const char* detname) const;
    AliLoader*  GetLoader(AliDetector* det) const;
    Int_t       SetEventFolderName(const TString& name = AliConfig::GetDefaultEventFolderName());//sets top folder name for this run; of alread
    void        CleanFolders();//removes all abjects from folder structure
    void        CleanDetectors();
    void        CleanKinematics(){Clean(fgkKineContainerName);}
    void        CleanTrackRefs(){Clean(fgkTrackRefsContainerName);}
    
    void        RemoveEventFolder(); //remove folder structure from top folder 
    void        SetCompressionLevel(Int_t cl);
    void        SetKineComprLevel(Int_t cl);
    void        SetTrackRefsComprLevel(Int_t cl);

    TFolder*    GetEventFolder() const {return fEventFolder;}
    void        CdGAFile();

    void        MakeTrackRefsContainer();
    void        SetDirName(TString& dirname);
    Int_t       GetFileOffset() const;
    void        SetNumberOfEventsPerFile(Int_t nevpf){fNEventsPerFile = nevpf;}
    
    void        SetDigitsFileNameSuffix(const TString& suffix);//adds the suffix before ".root", 
                                                               //e.g. TPC.Digits.root -> TPC.DigitsMerged.root
                                                               //made on Jiri Chudoba demand
    TString     GetFileName() const;//returns name of galice file
    const TObjArray* GetArrayOfLoaders() const {return fLoaders;}
    void Cd(){fgRunLoader = this;}
    void Synchronize();
    
    AliLoader*    GetDetectorLoader(const char* detname);
    TTree*        GetTreeH(const char* detname, Bool_t maketree);
    TTree*        GetTreeS(const char* detname, Bool_t maketree);
    TTree*        GetTreeD(const char* detname, Bool_t maketree);
    TTree*        GetTreeR(const char* detname, Bool_t maketree);
    TTree*        GetTreeT(const char* detname, Bool_t maketree);
    TTree*        GetTreeP(const char* detname, Bool_t maketree);

  /******************************************/
  /*****   Public S T A T I C Stuff   *******/
  /******************************************/
    static AliRunLoader* GetRunLoader(const char* eventfoldername);
    static AliRunLoader* GetRunLoader(){return fgRunLoader;}
    static AliLoader*    GetDetectorLoader(const char* detname, const char* eventfoldername);
    static TTree*        GetTreeH(const char* detname, Bool_t maketree, const char* eventfoldername);
    static TTree*        GetTreeS(const char* detname, Bool_t maketree, const char* eventfoldername);
    static TTree*        GetTreeD(const char* detname, Bool_t maketree, const char* eventfoldername);
    static TTree*        GetTreeR(const char* detname, Bool_t maketree, const char* eventfoldername);
    static TTree*        GetTreeT(const char* detname, Bool_t maketree, const char* eventfoldername);
    static TTree*        GetTreeP(const char* detname, Bool_t maketree, const char* eventfoldername);

//    static AliRunDigitizer* GetRunDigitizer();
//  Tasks are supposed to be singletons, that is why following methods are static
    static TTask*           GetRunDigitizer();        //
    static TTask*           GetRunSDigitizer();       //
    static TTask*           GetRunReconstructioner(); //
    static TTask*           GetRunTracker();          //
    static TTask*           GetRunPIDTask();          // 
    static TTask*           GetRunQATask();           //

    static TString GetRunLoaderName () {return fgkRunLoaderName;}
    static TString GetHeaderContainerName () {return fgkHeaderContainerName;}
    static TString GetKineContainerName () {return fgkKineContainerName;}
    static TString GetTrackRefsContainerName () {return fgkTrackRefsContainerName;}
    static TString GetHeaderBranchName () {return fgkHeaderBranchName;}
    static TString GetKineBranchName () {return fgkKineBranchName;}
    static TString GetGAliceName () {return fgkGAliceName;}
     
protected:
    /**********************************************/
    /************    PROTECTED      ***************/
    /*********        D A T A          ************/
    /**********************************************/

    TObjArray     *fLoaders;          //  List of Detectors
    TFolder       *fEventFolder;      //!top folder for this run
    
    Int_t          fCurrentEvent;//!Number of current event
    
    TFile         *fGAFile;//!  pointer to main file with AliRun and Run Loader -> galice.root 
    AliHeader     *fHeader;//!  pointer to header
    AliStack      *fStack; //!  pointer to stack
    
    AliDataLoader *fKineDataLoader;// kinematics data loader
    AliDataLoader *fTrackRefsDataLoader;//track reference data loader
    
    Int_t          fNEventsPerFile;  //defines number of events stored per one file
    TString        fUnixDirName;    //! name of unix path to directory that contains event
    static const TString   fgkDefaultKineFileName;//default file name with kinamatics
    static const TString   fgkDefaultTrackRefsFileName;//default file name with kinamatics


    /*********************************************/
    /************    PROTECTED      **************/
    /*********     M E T H O D S       ***********/
    /*********************************************/

    void           SetGAliceFile(TFile* gafile);//sets the pointer to gAlice file
    Int_t          OpenKineFile(Option_t* opt);
    Int_t          OpenTrackRefsFile(Option_t* opt);

    Int_t          OpenDataFile(const TString& filename,TFile*& file,TDirectory*& dir,Option_t* opt,Int_t cl);
    void           SetUnixDir(const TString& udirname);
    const TString  SetFileOffset(const TString& fname);//adds the proper number before .root
    void           SetDetectorAddresses();
        
  private:
    void  GetListOfDetectors(const char * namelist,TObjArray& pointerarray) const;

    void  CleanHeader(){Clean(fgkHeaderContainerName);}
    void  Clean(const TString& name);
    
    Int_t SetEvent();
   
    static AliRunLoader* fgRunLoader; //pointer to the AliRunLoader instance

private:
    void Copy(TObject &arun) const;

    static const TString   fgkRunLoaderName;          //default name of the run loader
    static const TString   fgkHeaderContainerName;    //default name of the kinematics container (TREE) name - TreeE
    static const TString   fgkKineContainerName;      //default name of the kinematics container (TREE) name - TreeK
    static const TString   fgkTrackRefsContainerName; //default name of the track references container (TREE) name - TreeTR
    static const TString   fgkHeaderBranchName;       //default name of the branch containing the header
    static const TString   fgkKineBranchName;         //default name of the branch with kinematics
    static const TString   fgkGAliceName;             //default name for gAlice file    
    
    ClassDef(AliRunLoader,1)
};

#endif
Commit	Line	Data
88cb7938	1	#ifndef ALIRUNLoader_H
	2	#define ALIRUNLoader_H
	3
	4	//___________________________________________________________________
	5	/////////////////////////////////////////////////////////////////////
	6	// //
	7	// class AliRunLoader //
	8	// //
	9	// This class aims to be the only one interface for manging data //
	10	// It stores Loaders for all modules which knows the filenames //
	11	// of the data files to be stored. //
	12	// It aims to substitude AliRun in automatic managing of data //
	13	// positioning thus there won't be necessity of loading gAlice //
	14	// from file in order to get fast access to the data //
	15	// //
	16	// Logical place to put the specific Loader to the given //
	17	// detector is detector itself (i.e ITSLoader in ITS). //
	18	// But, to load detector object one need to load gAlice, and //
	19	// by the way all other detectors with their geometrieces and //
	20	// so on. So, if one need to open TPC clusters there is no //
	21	// principal nedd to read everything. //
	22	// //
	23	/////////////////////////////////////////////////////////////////////
	24
	25	#include <TNamed.h>
024a7e64	26
88cb7938	27	#include "AliConfig.h"
	28	#include "AliLoader.h"
	29	#include "AliDataLoader.h"
4951e003	30	#include "AliLog.h"
88cb7938	31
024a7e64	32	class TFile;
88cb7938	33	class TString;
	34	class TFolder;
	35	class TObjArray;
	36	class TTree;
	37	class TTask;
	38	class TParticle;
	39
	40	class AliRun;
	41	class AliLoader;
	42	class AliDetector;
	43	class AliHeader;
	44	class AliStack;
	45	class AliRunDigitizer;
	46
	47
	48	class AliRunLoader: public TNamed
	49	{
	50	public:
	51
	52	AliRunLoader();
	53	AliRunLoader(const char* topfoldername);
	54	AliRunLoader(TFolder* topfolder);
024a7e64	55	AliRunLoader(const AliRunLoader &rl);
	56	AliRunLoader & operator = (const AliRunLoader &rl)
	57	{rl.Copy(this); return this;}
88cb7938	58
	59	virtual ~AliRunLoader();
	60
	61	static AliRunLoader* Open(const char* filename = "galice.root",
e191bb57	62	const char* eventfoldername = AliConfig::GetDefaultEventFolderName(),
88cb7938	63	Option_t* option = "READ");
	64
	65	Int_t GetEventNumber() const {return fCurrentEvent;}
	66
	67	Int_t GetEvent(Int_t evno);//sets the event number and reloads data in folders properly
	68	Int_t GetNextEvent(){return GetEvent(fCurrentEvent+1);}//gets next event
	69	Int_t SetEventNumber(Int_t evno); //cleans folders and sets the root dirs in files (do not reload data)
	70	Int_t SetNextEvent(){return SetEventNumber(fCurrentEvent+1);}
	71
	72	Int_t GetNumberOfEvents();
	73
2c8628dd	74	const TObject* GetRunObject(const char* name) const;
2c8628dd	75
88cb7938	76	void MakeTree(Option_t *option);
	77	void MakeHeader();
	78	void MakeStack();
	79
	80	Int_t LoadgAlice();
	81	Int_t LoadHeader();
	82	Int_t LoadKinematics(Option_t* option = "READ");
	83	Int_t LoadTrackRefs(Option_t* option = "READ");
	84
	85	void UnloadHeader();
	86	void UnloadKinematics();
	87	void UnloadgAlice();
	88	void UnloadTrackRefs();
	89
	90	void SetKineFileName(const TString& fname){fKineDataLoader->SetFileName(fname);}
	91	void SetTrackRefsFileName(const TString& fname){fTrackRefsDataLoader->SetFileName(fname);}
	92
	93	TTree* TreeE() const; //returns the tree from folder; shortcut method
	94	AliHeader* GetHeader() const;
	95
	96	AliStack* Stack() const {return fStack;}
	97
	98	TTree* TreeK() const; //returns the tree from folder; shortcut method
	99	TTree* TreeTR() const; //returns the tree from folder; shortcut method
	100
	101	AliRun* GetAliRun()const;
	102
	103	Int_t WriteGeometry(Option_t* opt="");
	104	Int_t WriteHeader(Option_t* opt="");
	105	Int_t WriteAliRun(Option_t* opt="");
	106	Int_t WriteKinematics(Option_t* opt="");
	107	Int_t WriteTrackRefs(Option_t* opt="");
	108	Int_t WriteRunLoader(Option_t* opt="");
	109
	110	Int_t WriteHits(Option_t* opt="");
	111	Int_t WriteSDigits(Option_t* opt="");
	112	Int_t WriteDigits(Option_t* opt="");
	113	Int_t WriteRecPoints(Option_t* opt="");
	114	Int_t WriteTracks(Option_t* opt="");
	115
	116	Int_t LoadHits(Option_t* detectors = "all",Option_t* opt = "RAED");
	117	Int_t LoadSDigits(Option_t* detectors = "all",Option_t* opt = "RAED");
	118	Int_t LoadDigits(Option_t* detectors = "all",Option_t* opt = "RAED");
	119	Int_t LoadRecPoints(Option_t* detectors = "all",Option_t* opt = "RAED");
	120	Int_t LoadTracks(Option_t* detectors = "all",Option_t* opt = "RAED");
1bb20a37	121	Int_t LoadRecParticles(Option_t* detectors = "all",Option_t* opt = "RAED");
88cb7938	122
1bb20a37	123	void UnloadHits(Option_t* detectors = "all");
	124	void UnloadSDigits(Option_t* detectors = "all");
	125	void UnloadDigits(Option_t* detectors = "all");
	126	void UnloadRecPoints(Option_t* detectors = "all");
	127	void UnloadTracks(Option_t* detectors = "all");
	128	void UnloadRecParticles(Option_t* detectors = "all");
	129	void UnloadAll(Option_t* detectors = "all");
88cb7938	130
	131	void AddLoader(AliLoader* loader);
	132	void AddLoader(AliDetector* det);
	133	AliLoader* GetLoader(const char* detname) const;
	134	AliLoader* GetLoader(AliDetector* det) const;
e191bb57	135	Int_t SetEventFolderName(const TString& name = AliConfig::GetDefaultEventFolderName());//sets top folder name for this run; of alread
88cb7938	136	void CleanFolders();//removes all abjects from folder structure
	137	void CleanDetectors();
	138	void CleanKinematics(){Clean(fgkKineContainerName);}
	139	void CleanTrackRefs(){Clean(fgkTrackRefsContainerName);}
	140
	141	void RemoveEventFolder(); //remove folder structure from top folder
	142	void SetCompressionLevel(Int_t cl);
	143	void SetKineComprLevel(Int_t cl);
	144	void SetTrackRefsComprLevel(Int_t cl);
	145
	146	TFolder* GetEventFolder() const {return fEventFolder;}
	147	void CdGAFile();
	148
	149	void MakeTrackRefsContainer();
	150	void SetDirName(TString& dirname);
	151	Int_t GetFileOffset() const;
	152	void SetNumberOfEventsPerFile(Int_t nevpf){fNEventsPerFile = nevpf;}
	153
	154	void SetDigitsFileNameSuffix(const TString& suffix);//adds the suffix before ".root",
	155	//e.g. TPC.Digits.root -> TPC.DigitsMerged.root
	156	//made on Jiri Chudoba demand
	157	TString GetFileName() const;//returns name of galice file
	158	const TObjArray* GetArrayOfLoaders() const {return fLoaders;}
024a7e64	159	void Cd(){fgRunLoader = this;}
f0f6f856	160	void Synchronize();
f0f6f856	161
1bb20a37	162	AliLoader* GetDetectorLoader(const char* detname);
	163	TTree* GetTreeH(const char* detname, Bool_t maketree);
	164	TTree* GetTreeS(const char* detname, Bool_t maketree);
	165	TTree* GetTreeD(const char* detname, Bool_t maketree);
	166	TTree* GetTreeR(const char* detname, Bool_t maketree);
	167	TTree* GetTreeT(const char* detname, Bool_t maketree);
	168	TTree* GetTreeP(const char* detname, Bool_t maketree);
d0d4a6b3	169
	170	/******************************************/
	171	/*** Public S T A T I C Stuff *****/
	172	/******************************************/
	173	static AliRunLoader* GetRunLoader(const char* eventfoldername);
	174	static AliRunLoader* GetRunLoader(){return fgRunLoader;}
	175	static AliLoader* GetDetectorLoader(const char* detname, const char* eventfoldername);
	176	static TTree* GetTreeH(const char* detname, Bool_t maketree, const char* eventfoldername);
	177	static TTree* GetTreeS(const char* detname, Bool_t maketree, const char* eventfoldername);
	178	static TTree* GetTreeD(const char* detname, Bool_t maketree, const char* eventfoldername);
	179	static TTree* GetTreeR(const char* detname, Bool_t maketree, const char* eventfoldername);
	180	static TTree* GetTreeT(const char* detname, Bool_t maketree, const char* eventfoldername);
	181	static TTree* GetTreeP(const char* detname, Bool_t maketree, const char* eventfoldername);
	182
	183	// static AliRunDigitizer* GetRunDigitizer();
	184	// Tasks are supposed to be singletons, that is why following methods are static
	185	static TTask* GetRunDigitizer(); //
	186	static TTask* GetRunSDigitizer(); //
	187	static TTask* GetRunReconstructioner(); //
	188	static TTask* GetRunTracker(); //
	189	static TTask* GetRunPIDTask(); //
	190	static TTask* GetRunQATask(); //
024a7e64	191
	192	static TString GetRunLoaderName () {return fgkRunLoaderName;}
	193	static TString GetHeaderContainerName () {return fgkHeaderContainerName;}
	194	static TString GetKineContainerName () {return fgkKineContainerName;}
	195	static TString GetTrackRefsContainerName () {return fgkTrackRefsContainerName;}
	196	static TString GetHeaderBranchName () {return fgkHeaderBranchName;}
	197	static TString GetKineBranchName () {return fgkKineBranchName;}
	198	static TString GetGAliceName () {return fgkGAliceName;}
d0d4a6b3	199
024a7e64	200	protected:
88cb7938	201	/**********************************************/
	202	/********** PROTECTED *************/
	203	/******* D A T A **********/
	204	/**********************************************/
	205
	206	TObjArray *fLoaders; // List of Detectors
	207	TFolder *fEventFolder; //!top folder for this run
	208
	209	Int_t fCurrentEvent;//!Number of current event
	210
	211	TFile *fGAFile;//! pointer to main file with AliRun and Run Loader -> galice.root
	212	AliHeader *fHeader;//! pointer to header
	213	AliStack *fStack; //! pointer to stack
	214
	215	AliDataLoader *fKineDataLoader;// kinematics data loader
	216	AliDataLoader *fTrackRefsDataLoader;//track reference data loader
	217
	218	Int_t fNEventsPerFile; //defines number of events stored per one file
	219	TString fUnixDirName; //! name of unix path to directory that contains event
	220	static const TString fgkDefaultKineFileName;//default file name with kinamatics
	221	static const TString fgkDefaultTrackRefsFileName;//default file name with kinamatics
	222
	223
	224	/*********************************************/
	225	/********** PROTECTED ************/
	226	/******* M E T H O D S *********/
	227	/*********************************************/
	228
	229	void SetGAliceFile(TFile* gafile);//sets the pointer to gAlice file
	230	Int_t OpenKineFile(Option_t* opt);
	231	Int_t OpenTrackRefsFile(Option_t* opt);
	232
	233	Int_t OpenDataFile(const TString& filename,TFile& file,TDirectory& dir,Option_t* opt,Int_t cl);
	234	void SetUnixDir(const TString& udirname);
	235	const TString SetFileOffset(const TString& fname);//adds the proper number before .root
	236	void SetDetectorAddresses();
	237
	238	private:
	239	void GetListOfDetectors(const char * namelist,TObjArray& pointerarray) const;
	240
	241	void CleanHeader(){Clean(fgkHeaderContainerName);}
	242	void Clean(const TString& name);
	243
	244	Int_t SetEvent();
	245
d0d4a6b3	246	static AliRunLoader* fgRunLoader; //pointer to the AliRunLoader instance
88cb7938	247
024a7e64	248	private:
	249	void Copy(TObject &arun) const;
	250
	251	static const TString fgkRunLoaderName; //default name of the run loader
	252	static const TString fgkHeaderContainerName; //default name of the kinematics container (TREE) name - TreeE
	253	static const TString fgkKineContainerName; //default name of the kinematics container (TREE) name - TreeK
	254	static const TString fgkTrackRefsContainerName; //default name of the track references container (TREE) name - TreeTR
	255	static const TString fgkHeaderBranchName; //default name of the branch containing the header
	256	static const TString fgkKineBranchName; //default name of the branch with kinematics
	257	static const TString fgkGAliceName; //default name for gAlice file
88cb7938	258
	259	ClassDef(AliRunLoader,1)
	260	};
	261
	262	#endif