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 
61 class KVDataAnalyser : public TObject {
62 
63 public:
64  struct UserClass
65  {
66  KVString name; // the name of the class
67  KVString imp_file; // the name of the implementation file
68  KVString dec_file; // the name of the header file
69  KVString dir_name="$(PWD)"; // the name of the directory containing the files
70 
71  /* N.B.: TSystem::ExpandPathName does not expand ".", this is why we use "$(PWD)" */
72 
73  KVString get_full_path(const KVString&, const KVString& = "") const;
74  KVString full_path_imp(const KVString&other_dir="") const
75  {
76  return get_full_path(imp_file,other_dir);
77  }
78  KVString full_path_dec(const KVString&other_dir="") const
79  {
80  return get_full_path(dec_file,other_dir);
81  }
82  Bool_t with_files() const { return !imp_file.IsNull() && !dec_file.IsNull(); }
83  void reset() { name = imp_file = dec_file = ""; dir_name = "$(PWD)"; }
84  };
85 
86 private:
92 
96 
103 
105 
106  std::unique_ptr<TEnv> fBatchEnv;
109 
113 
115 
116 protected:
118  void ScanWorkingDirectory(TList**);
120 
121  virtual Bool_t CheckIfUserClassIsValid(const KVString& alternative_base_class = "");
122  TObject* GetInstanceOfUserClass(const KVString& alternative_base_class = "");
123 
124  const Char_t* GetACliCMode();
125 
126  void OpenBatchInfoFile(const TString& filename)
127  {
131 
132  if (!fBatchEnv || filename != fBatchEnv->GetRcName()) {
133  fBatchEnv.reset(new TEnv(filename));
134  }
135  }
137  {
138  return fBatchEnv.get();
139  }
141  {
142  return kTRUE;
143  }
144  virtual void PostRunReset();
145  virtual Bool_t NeedToChooseWhatToDo() const
146  {
147  return !GetAnalysisTask();
148  }
150  {
151  AbstractMethod("NeedToChooseWhatToAnalyse");
152  return kTRUE;
153  }
154  virtual void ChooseWhatToAnalyse();
155  virtual void ChooseWhatToDo();
157 
158  virtual void set_up_analyser_for_task(KVDataAnalyser* the_analyser);
159 
160 public:
161  enum EProofMode {
164  Proof
165  };
166 private:
168 public:
170  {
171  fProofMode = e;
172  }
174  {
175  return fProofMode;
176  }
177 
178  static void SetAbortProcessingLoop(Bool_t now = kTRUE)
179  {
181  fCleanAbort = now;
182  }
184  {
185  return fCleanAbort;
186  }
187 
188  KVDataAnalyser();
189  virtual ~ KVDataAnalyser();
190 
191  void SetUserClass(const UserClass& kvs, Bool_t check = kTRUE);
193  {
194  return fUserClass.name;
195  }
196  const UserClass& GetUserClass() const
197  {
198  return fUserClass;
199  }
201  {
202  return fUserClassIsOK;
203  }
204 
206  {
207  return 0;
208  }
209 
210  virtual void Run();
211  virtual void RunMenus();
212  void ChooseUserClass();
213  void ChooseRunningMode();
214  virtual void SubmitTask();
215  virtual Bool_t CheckTaskVariables();
217 
218  void SetBatchMode(Bool_t on = kTRUE)
219  {
220  fBatch = on;
221  }
223  {
224  return fBatch;
225  }
226  void SetBatchName(const Char_t* batchname)
227  {
228  fBatchName = batchname;
229  }
231  {
232  return fBatchName.Data();
233  }
235  {
236  fBatchSystem = bs;
238  if (bs) fBatchSystem->cd();
239  }
240  virtual const KVBatchSystem* GetBatchSystem()
241  {
242  return fBatchSystem;
243  }
245 
246  const Char_t* GetLaunchDirectory() const;
248  const Char_t* GetBatchStatusFileName() const;
249  void UpdateBatchStatusFile(Int_t totev, Int_t evread, TString disk) const;
250  void DeleteBatchStatusFile() const;
252  {
253  return 0;
254  }
255  virtual Bool_t CheckStatusUpdateInterval(Long64_t nevents) const;
256  void SetStatusUpdateInterval(double t)
257  {
259  }
261  {
262  return fStatusUpdateInterval;
263  }
264 
265  void DoStatusUpdate(Long64_t nevents) const;
266 
268  {
269  return fTask;
270  }
271  const KVString& GetDataType() const
272  {
273  return fDataType;
274  }
275  const KVString& GetUserIncludes() const
276  {
277  return fIncludes;
278  }
279  const KVString& GetUserLibraries() const
280  {
281  return fLibraries;
282  }
283  virtual void SetFileList(TList*)
284  {
285  AbstractMethod("SetFileList(TList*)");
286  }
287  virtual void SetAuxFileList(TList*)
288  {
289  AbstractMethod("SetAuxFileList(TList*)");
290  }
291 
293  {
294  nbEventToRead = nb;
295  }
296 
298  {
299  return nbEventToRead;
300  }
301 
302  void ChooseNbEventToRead();
304  void SetDataType(const Char_t* name)
305  {
306  fDataType = name;
307  }
308 
309  void SetUserIncludes(const Char_t* incDirs = 0);
310  void SetUserLibraries(const Char_t* libs = 0);
311 
312  virtual void Reset();
313 
315  {
316  fParent = da;
317  }
319  {
320  return fParent;
321  }
322 
323  static KVDataAnalyser* GetAnalyser(const Char_t* plugin);
324  virtual Bool_t ReadBatchEnvFile(const TString&);
325  virtual void WriteBatchEnvFile(const TString&, Bool_t sav = kTRUE);
326 
327  virtual TString ExpandAutoBatchName(const Char_t* format) const;
328 
329  /* methods which can be used to customise analysis class behaviour.
330  they can be called from the analysis class using the global
331  pointer to the current data analyser, gDataAnalyser */
332  virtual void preInitAnalysis() {}
333  virtual void postInitAnalysis() {}
334  virtual void preInitRun() {}
335  virtual void postInitRun() {}
336  virtual void preAnalysis() {}
337  virtual void postAnalysis() {}
338  virtual void preEndRun() {}
339  virtual void postEndRun() {}
340  virtual void preEndAnalysis() {}
341  virtual void postEndAnalysis() {}
342 
343  void WriteBatchInfo(TTree*);
344 
345  virtual void RegisterUserClass(TObject*) {}
346 
347  void SetUserClassOptions(const Char_t* o = "")
348  {
349  fUserClassOptions = o;
350  }
352  {
353  return fUserClassOptions;
354  }
355 
356  static void RunAnalyser(const Char_t* plugin = "");
357 
359 
360  virtual void AddJobDescriptionList(TList*);
361 
362  void SetMenus(Bool_t on = kTRUE)
363  {
364  fMenus = on;
365  }
366  Bool_t IsMenus() const
367  {
368  return fMenus;
369  }
370  void SetQuit(Bool_t yes = kTRUE)
371  {
372  fQuit = yes;
373  }
374  Bool_t IsQuit() const
375  {
376  return fQuit;
377  }
378  void SetSubmit(Bool_t yes = kTRUE)
379  {
380  fSubmit = yes;
381  }
382  Bool_t IsSubmit() const
383  {
384  return fSubmit;
385  }
387  {
388  AbstractMethod("GetRootDirectoryOfDataToAnalyse");
389  return "";
390  }
391  virtual const Char_t* GetRecognisedAutoBatchNameKeywords() const;
393  {
395  }
399  virtual const KV2Body* GetKinematics() const
400  {
401  return nullptr;
402  }
403  virtual KVDBSystem* GetAnalysedSystem() const
404  {
405  return nullptr;
406  }
407  virtual KVDBRun* GetAnalysedRun() const
408  {
409  return nullptr;
410  }
411  virtual void SetTriggerConditionsForRun(int) {}
412 
413  virtual void SetAnalysedTree(TTree*) {}
414  virtual TTree* GetAnalysedTree() const
415  {
420 
421  return nullptr;
422  }
423 
424  ClassDef(KVDataAnalyser, 0) //For submitting & performing data analysis tasks
425 };
426 
428 R__EXTERN KVDataAnalyser* gDataAnalyser;
429 
430 #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