KaliVeda
Toolkit for HIC analysis
KVDataAnalyser.h
1 /*
2 $Id: KVDataAnalyser.h,v 1.18 2009/04/01 09:28:34 franklan Exp $
3 $Revision: 1.18 $
4 $Date: 2009/04/01 09:28:34 $
5 $Author: franklan $
6 */
7 
8 #ifndef __KVDATAANALYSER_H
9 #define __KVDATAANALYSER_H
10 
11 #include "TObject.h"
12 #include "TTree.h"
13 #include "KVList.h"
14 #include "KVBatchSystem.h"
15 #include "KVString.h"
16 #include "KVNumberList.h"
17 #include "TEnv.h"
18 #include "KV2Body.h"
19 #include "KVDBSystem.h"
20 #include "KVDBRun.h"
21 class KVDataAnalysisTask;
22 
57 class KVDataAnalyser : public TObject {
58 
59 public:
60  struct UserClass {
61  KVString name; // the name of the class
62  KVString imp_file; // the name of the implementation file
63  KVString dec_file; // the name of the header file
64  KVString dir_name = "$(PWD)"; // the name of the directory containing the files
65 
66  /* N.B.: TSystem::ExpandPathName does not expand ".", this is why we use "$(PWD)" */
67 
68  KVString get_full_path(const KVString&, const KVString& = "") const;
69  KVString full_path_imp(const KVString& other_dir = "") const
70  {
71  return get_full_path(imp_file, other_dir);
72  }
73  KVString full_path_dec(const KVString& other_dir = "") const
74  {
75  return get_full_path(dec_file, other_dir);
76  }
78  {
79  return !imp_file.IsNull() && !dec_file.IsNull();
80  }
81  void reset()
82  {
83  name = imp_file = dec_file = "";
84  dir_name = "$(PWD)";
85  }
86  };
87 
88 private:
94 
98 
105 
107 
108  std::unique_ptr<TEnv> fBatchEnv;
111 
115 
117 
118 protected:
120  void ScanWorkingDirectory(TList**);
122 
123  virtual Bool_t CheckIfUserClassIsValid(const KVString& alternative_base_class = "");
124  TObject* GetInstanceOfUserClass(const KVString& alternative_base_class = "");
125 
126  const Char_t* GetACliCMode();
127 
128  void OpenBatchInfoFile(const TString& filename)
129  {
133 
134  if (!fBatchEnv || filename != fBatchEnv->GetRcName()) {
135  fBatchEnv.reset(new TEnv(filename));
136  }
137  }
139  {
140  return fBatchEnv.get();
141  }
143  {
144  return kTRUE;
145  }
146  virtual void PostRunReset();
147  virtual Bool_t NeedToChooseWhatToDo() const
148  {
149  return !GetAnalysisTask();
150  }
152  {
153  AbstractMethod("NeedToChooseWhatToAnalyse");
154  return kTRUE;
155  }
156  virtual void ChooseWhatToAnalyse();
157  virtual void ChooseWhatToDo();
159 
160  virtual void set_up_analyser_for_task(KVDataAnalyser* the_analyser);
161 
162 public:
163  enum EProofMode {
166  Proof
167  };
168 private:
170 public:
172  {
173  fProofMode = e;
174  }
176  {
177  return fProofMode;
178  }
179 
180  static void SetAbortProcessingLoop(Bool_t now = kTRUE)
181  {
183  fCleanAbort = now;
184  }
186  {
187  return fCleanAbort;
188  }
189 
190  KVDataAnalyser();
191  virtual ~ KVDataAnalyser();
192 
193  void SetUserClass(const UserClass& kvs, Bool_t check = kTRUE);
195  {
196  return fUserClass.name;
197  }
198  const UserClass& GetUserClass() const
199  {
200  return fUserClass;
201  }
203  {
204  return fUserClassIsOK;
205  }
206 
208  {
209  return 0;
210  }
211 
212  virtual void Run();
213  virtual void RunMenus();
214  void ChooseUserClass();
215  void ChooseRunningMode();
216  virtual void SubmitTask();
217  virtual Bool_t CheckTaskVariables();
219 
220  void SetBatchMode(Bool_t on = kTRUE)
221  {
222  fBatch = on;
223  }
225  {
226  return fBatch;
227  }
228  void SetBatchName(const Char_t* batchname)
229  {
230  fBatchName = batchname;
231  }
233  {
234  return fBatchName.Data();
235  }
237  {
238  fBatchSystem = bs;
240  if (bs) fBatchSystem->cd();
241  }
242  virtual const KVBatchSystem* GetBatchSystem()
243  {
244  return fBatchSystem;
245  }
247 
248  const Char_t* GetLaunchDirectory() const;
250  const Char_t* GetBatchStatusFileName() const;
251  void UpdateBatchStatusFile(Int_t totev, Int_t evread, TString disk) const;
252  void DeleteBatchStatusFile() const;
254  {
255  return 0;
256  }
257  virtual Bool_t CheckStatusUpdateInterval(Long64_t nevents) const;
258  void SetStatusUpdateInterval(double t)
259  {
261  }
263  {
264  return fStatusUpdateInterval;
265  }
266 
267  void DoStatusUpdate(Long64_t nevents) const;
268 
270  {
271  return fTask;
272  }
273  const KVString& GetDataType() const
274  {
275  return fDataType;
276  }
277  const KVString& GetUserIncludes() const
278  {
279  return fIncludes;
280  }
281  const KVString& GetUserLibraries() const
282  {
283  return fLibraries;
284  }
285  virtual void SetFileList(TList*)
286  {
287  AbstractMethod("SetFileList(TList*)");
288  }
289  virtual void SetAuxFileList(TList*)
290  {
291  AbstractMethod("SetAuxFileList(TList*)");
292  }
293 
295  {
296  nbEventToRead = nb;
297  }
298 
300  {
301  return nbEventToRead;
302  }
303 
304  void ChooseNbEventToRead();
306  void SetDataType(const Char_t* name)
307  {
308  fDataType = name;
309  }
310 
311  void SetUserIncludes(const Char_t* incDirs = 0);
312  void SetUserLibraries(const Char_t* libs = 0);
313 
314  virtual void Reset();
315 
317  {
318  fParent = da;
319  }
321  {
322  return fParent;
323  }
324 
325  static KVDataAnalyser* GetAnalyser(const Char_t* plugin);
326  virtual Bool_t ReadBatchEnvFile(const TString&);
327  virtual void WriteBatchEnvFile(const TString&, Bool_t sav = kTRUE);
328 
329  virtual TString ExpandAutoBatchName(const Char_t* format) const;
330 
331  /* methods which can be used to customise analysis class behaviour.
332  they can be called from the analysis class using the global
333  pointer to the current data analyser, gDataAnalyser */
334  virtual void preInitAnalysis() {}
335  virtual void postInitAnalysis() {}
336  virtual void preInitRun() {}
337  virtual void postInitRun() {}
338  virtual void preAnalysis() {}
339  virtual void postAnalysis() {}
340  virtual void preEndRun() {}
341  virtual void postEndRun() {}
342  virtual void preEndAnalysis() {}
343  virtual void postEndAnalysis() {}
344 
345  void WriteBatchInfo(TTree*);
346 
347  virtual void RegisterUserClass(TObject*) {}
348 
349  void SetUserClassOptions(const Char_t* o = "")
350  {
351  fUserClassOptions = o;
352  }
354  {
355  return fUserClassOptions;
356  }
357 
358  static void RunAnalyser(const Char_t* plugin = "");
359 
361 
362  virtual void AddJobDescriptionList(TList*);
363 
364  void SetMenus(Bool_t on = kTRUE)
365  {
366  fMenus = on;
367  }
368  Bool_t IsMenus() const
369  {
370  return fMenus;
371  }
372  void SetQuit(Bool_t yes = kTRUE)
373  {
374  fQuit = yes;
375  }
376  Bool_t IsQuit() const
377  {
378  return fQuit;
379  }
380  void SetSubmit(Bool_t yes = kTRUE)
381  {
382  fSubmit = yes;
383  }
384  Bool_t IsSubmit() const
385  {
386  return fSubmit;
387  }
389  {
390  AbstractMethod("GetRootDirectoryOfDataToAnalyse");
391  return "";
392  }
393  virtual const Char_t* GetRecognisedAutoBatchNameKeywords() const;
395  {
397  }
401  virtual const KV2Body* GetKinematics() const
402  {
403  return nullptr;
404  }
405  virtual KVDBSystem* GetAnalysedSystem() const
406  {
407  return nullptr;
408  }
409  virtual KVDBRun* GetAnalysedRun() const
410  {
411  return nullptr;
412  }
413  virtual void SetTriggerConditionsForRun(int) {}
414 
415  virtual void SetAnalysedTree(TTree*) {}
416  virtual TTree* GetAnalysedTree() const
417  {
422 
423  return nullptr;
424  }
425 
426  ClassDef(KVDataAnalyser, 0) //For submitting & performing data analysis tasks
427 };
428 
430 R__EXTERN KVDataAnalyser* gDataAnalyser;
431 
432 #endif
int Int_t
#define R__EXTERN
#define e(i)
bool Bool_t
char Char_t
double Double_t
constexpr Bool_t kTRUE
#define ClassDef(name, id)
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char filename
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void on
char name[80]
Relativistic binary kinematics calculator.
Definition: KV2Body.h:166
Base class for interface to a batch job management system.
Definition: KVBatchSystem.h:78
void cd()
Make this the default batch system.
Description of an experimental run in database ,,.
Definition: KVDBRun.h:40
Database class used to store information on different colliding systems studied during an experiment....
Definition: KVDBSystem.h:52
Manager class which sets up and runs data analysis tasks.
virtual void SetTriggerConditionsForRun(int)
virtual void SetAnalysedTree(TTree *)
const Char_t * GetACliCMode()
virtual void postEndRun()
virtual TTree * GetAnalysedTree() const
Bool_t IsMenus() const
Double_t GetStatusUpdateInterval() const
virtual KVDBRun * GetAnalysedRun() const
const UserClass & GetUserClass() const
UserClass fUserClass
user's analysis class
void UseBaseClassSubmitTask()
void DoStatusUpdate(Long64_t nevents) const
Print infos on events treated, disk usage, memory usage.
virtual TString ExpandAutoBatchName(const Char_t *format) const
void SetParent(KVDataAnalyser *da)
const KVString & GetUserLibraries() const
Bool_t fUseBaseClassSubmitTask
Long64_t nbEventToRead
virtual void PostRunReset()
virtual void Run()
Check all task variables, then run analyser.
Bool_t fSubmit
set to kTRUE when user wants to submit task
virtual void Reset()
virtual void SetAuxFileList(TList *)
std::unique_ptr< TEnv > fBatchEnv
batch environment file
virtual void AddJobDescriptionList(TList *)
KVDataAnalyser * fParent
holds address of parent analyser which created this one
virtual void WriteBatchEnvFile(const TString &, Bool_t sav=kTRUE)
void SetBatchSystem(KVBatchSystem *bs)
void ChooseNbEventToRead()
Ask user to set number of events to read.
virtual void preInitAnalysis()
void SetUserClassOptions(const Char_t *o="")
Bool_t RunningInLaunchDirectory()
virtual const KVBatchSystem * GetBatchSystem()
KVString fLibraries
user's libraries
virtual void postAnalysis()
void SetBatchMode(Bool_t on=kTRUE)
virtual ~ KVDataAnalyser()
const KVString & GetDataType() const
void SetUserLibraries(const Char_t *libs=0)
static void SetAbortProcessingLoop(Bool_t now=kTRUE)
KVString fUserClassOptions
options to be passed to user analysis class
virtual Bool_t CheckIfUserClassIsValid(const KVString &alternative_base_class="")
KVDataAnalyser * GetParent() const
virtual Bool_t NeedToChooseWhatToAnalyse() const
Bool_t fBatch
set to kTRUE when used in a non-interactive environment
void SetBatchName(const Char_t *batchname)
TString GetPathToFileInLaunchDirectory(const TString &) const
KVString GetUserClassName()
void WriteBatchInfo(TTree *)
virtual const KV2Body * GetKinematics() const
virtual void RunMenus()
Run data analyser in menu-driven mode.
virtual Bool_t CheckTaskVariables()
void SetSubmit(Bool_t yes=kTRUE)
Bool_t DoUserClassFilesExist()
const Char_t * GetBatchName()
const Char_t * GetLaunchDirectory() const
EProofMode fProofMode
void SetAnalysisTask(KVDataAnalysisTask *at)
KVString fBatchName
name of batch job when used in a non-interactive environment
void SetProofMode(EProofMode e)
const KVString & GetUserIncludes() const
Bool_t fUserClassIsOK
set once user class has been validated
virtual const Char_t * GetRecognisedAutoBatchNameKeywords() const
virtual void set_up_analyser_for_task(KVDataAnalyser *the_analyser)
virtual Bool_t NeedToChooseWhatToDo() const
virtual Bool_t CheckStatusUpdateInterval(Long64_t nevents) const
virtual Bool_t CheckWhatToAnalyseAndHow()
void SetQuit(Bool_t yes=kTRUE)
virtual void SubmitTask()
void SetUserClass(const UserClass &kvs, Bool_t check=kTRUE)
const Char_t * GetBatchStatusFileName() const
Returns full path to file used to store status of running batch jobs.
virtual void preAnalysis()
virtual void SetFileList(TList *)
virtual void ChooseWhatToAnalyse()
TO IMPLEMENT ?
TList * fWorkDirInit
list of files in working directory before task runs
virtual Long64_t GetTotalEntriesToRead() const
KVDataAnalyser()
Default constructor.
virtual Int_t GetNumberOfFilesToAnalyse() const
static Bool_t fCleanAbort
flag to force abort of processing
const KVString & GetUserClassOptions() const
virtual Bool_t PreSubmitCheck()
static KVDataAnalyser * GetAnalyser(const Char_t *plugin)
KVString fIncludes
user's include directories
Bool_t fQuit
set to kTRUE when user wants to quit
EProofMode GetProofMode() const
static Bool_t IsRunningBatchAnalysis()
void SetDataType(const Char_t *name)
virtual KVString GetRootDirectoryOfDataToAnalyse() const
Bool_t fMenus
set to kTRUE in menu-driven mode
virtual void preEndRun()
virtual void postInitRun()
KVString fUserClassAlternativeBaseClass
alternative base class for user's analysis class
static void RunAnalyser(const Char_t *plugin="")
void ScanWorkingDirectory(TList **)
void ChooseUserClass()
Choose the user's analysis class.
TList * fWorkDirEnd
list of files in working directory after task runs
static Bool_t AbortProcessingLoop()
Long64_t GetNbEventToRead(void) const
virtual void postEndAnalysis()
virtual void preEndAnalysis()
void SetMenus(Bool_t on=kTRUE)
void CopyAnalysisResultsToLaunchDirectory()
virtual Bool_t ReadBatchEnvFile(const TString &)
void DeleteBatchStatusFile() const
Delete batch status file (and backup - '.bak') for batch job.
void SetStatusUpdateInterval(double t)
virtual void preInitRun()
virtual void RegisterUserClass(TObject *)
void SetUserIncludes(const Char_t *incDirs=0)
virtual void ChooseWhatToDo()
TO IMPLEMENT ?
Bool_t IsUserClassValid() const
KVDataAnalysisTask * GetAnalysisTask() const
Bool_t BatchMode() const
virtual void postInitAnalysis()
void OpenBatchInfoFile(const TString &filename)
virtual KVDBSystem * GetAnalysedSystem() const
Bool_t IsSubmit() const
void UpdateBatchStatusFile(Int_t totev, Int_t evread, TString disk) const
Update infos in batch status file.
KVBatchSystem * fBatchSystem
batch system to use for submission of job
TEnv * GetBatchInfoFile() const
Bool_t IsQuit() const
Bool_t fChoseRunMode
set to kTRUE once running mode has been set/chosen
TObject * GetInstanceOfUserClass(const KVString &alternative_base_class="")
KVString fDataType
datatype chosen by user
KVDataAnalysisTask * fTask
task chosen by user
Double_t fStatusUpdateInterval
void SetNbEventToRead(Long64_t nb=0)
Define and manage data analysis tasks.
Extension of ROOT TString class which allows backwards compatibility with ROOT v3....
Definition: KVString.h:73
void AbstractMethod(const char *method) const
const char * Data() const
Bool_t IsNull() const
long long Long64_t
KVString full_path_dec(const KVString &other_dir="") const
KVString get_full_path(const KVString &, const KVString &="") const
KVString full_path_imp(const KVString &other_dir="") const