KaliVeda  1.13/01
Heavy-Ion Analysis Toolkit
List of all members | Public Member Functions | Private Attributes | List of all members
KVOnlineReconDataAnalyser Class Reference

Online analysis of reconstructed data.

Created by KVClassFactory on Mon Apr 1 10:16:46 2019 Author: eindra

Definition at line 16 of file KVOnlineReconDataAnalyser.h.

Public Member Functions

 KVOnlineReconDataAnalyser ()
 Default constructor. More...
 
virtual ~KVOnlineReconDataAnalyser ()
 Destructor. More...
 
Bool_t CheckStatusUpdateInterval (Int_t) const
 
Bool_t CheckTaskVariables ()
 Checks the task variables. More...
 
void preAnalysis ()
 Set minimum (trigger) multiplicity for array. More...
 
void preInitAnalysis ()
 
void preInitRun ()
 
void RegisterUserClass (TObject *)
 
void SubmitTask ()
 
void WriteBatchEnvFile (const Char_t *, Bool_t)
 
- Public Member Functions inherited from KVReconDataAnalyser
 KVReconDataAnalyser ()
 
virtual ~ KVReconDataAnalyser ()
 
TTreeGetAnalysedTree () const
 
Int_t GetDataReleaseNumber () const
 
KVString GetDataSeries () const
 
KVString GetDataVersion () const
 
TEnvGetReconDataTreeInfos () const
 
Long64_t GetTotalEntriesToRead () const
 
void preAnalysis ()
 Set minimum (trigger) multiplicity for array. More...
 
void preInitAnalysis ()
 
void preInitRun ()
 
void PrintTreeInfos ()
 Print informations on currently analysed TTree. More...
 
virtual void Reset ()
 Reset task variables. More...
 
void SetAnalysedTree (TTree *t)
 
virtual void SetTriggerConditionsForRun (int)
 
- Public Member Functions inherited from KVDataSetAnalyser
 KVDataSetAnalyser ()
 Default constructor. More...
 
virtual ~KVDataSetAnalyser ()
 Destructor. More...
 
virtual void AddJobDescriptionList (TList *)
 
virtual void ChooseAnalysisTask ()
 
void ChooseDataSet ()
 
void ChooseDataType ()
 
void ChooseRuns (KVDBSystem *system=nullptr, const Char_t *data_type="")
 
void ChooseSystem (const Char_t *data_type="")
 
void ClearRunList ()
 
TString ExpandAutoBatchName (const Char_t *format) const
 
KVDBRunGetAnalysedRun () const
 
KVDBSystemGetAnalysedSystem () const
 
const KVDataSetGetDataSet () const
 
const KVNumberListGetFullRunList () const
 
const KV2BodyGetKinematics () const
 Return pointer to kinematics of analysed system if defined. More...
 
Int_t GetNumberOfFilesToAnalyse () const
 
const Char_tGetRecognisedAutoBatchNameKeywords () const
 
KVString GetRootDirectoryOfDataToAnalyse () const
 Returns path to data to be analysed. More...
 
const KVNumberListGetRunList () const
 
Int_t GetRunNumberFromFileName (const Char_t *)
 Get the run number from the filename. More...
 
const KVDBSystemGetSystem () const
 
Bool_t IsChooseDataSet () const
 
Bool_t IsChooseRuns () const
 
Bool_t IsChooseSystem () const
 
Bool_t IsChooseTask () const
 
Bool_t ReadBatchEnvFile (const Char_t *filename)
 
void SetChooseDataSet (Bool_t yes=kTRUE)
 
void SetChooseRuns (Bool_t yes=kTRUE)
 
void SetChooseSystem (Bool_t yes=kTRUE)
 
void SetChooseTask (Bool_t yes=kTRUE)
 
void SetDataSet (const Char_t *name)
 
void SetDataSet (KVDataSet *ds)
 
void SetFullRunList (const KVNumberList &nl)
 
void SetRuns (const KVNumberList &nl, Bool_t check=kTRUE)
 
void SetSystem (KVDBSystem *syst)
 Set the System used in the analysis. More...
 
TString SystemBatchName () const
 
- Public Member Functions inherited from KVDataAnalyser
 KVDataAnalyser ()
 Default constructor. More...
 
virtual ~ KVDataAnalyser ()
 
Bool_t BatchMode () const
 
virtual Bool_t CheckStatusUpdateInterval (Long64_t nevents) const
 
void ChooseNbEventToRead ()
 Ask user to set number of events to read. More...
 
void ChooseRunningMode ()
 
void ChooseUserClass ()
 Choose the user's analysis class. More...
 
void DeleteBatchStatusFile () const
 Delete batch status file (and backup - '.bak') for batch job. More...
 
void DoStatusUpdate (Long64_t nevents) const
 Print infos on events treated, disk usage, memory usage. More...
 
Bool_t DoUserClassFilesExist ()
 
KVDataAnalysisTaskGetAnalysisTask () const
 
const Char_tGetBatchName ()
 
const Char_tGetBatchStatusFileName () const
 Returns full path to file used to store status of running batch jobs. More...
 
virtual const KVBatchSystemGetBatchSystem ()
 
const KVStringGetDataType () const
 
const Char_tGetLaunchDirectory () const
 
Long64_t GetNbEventToRead (void) const
 
KVDataAnalyserGetParent () const
 
TString GetPathToFileInLaunchDirectory (const TString &) const
 
EProofMode GetProofMode () const
 
Double_t GetStatusUpdateInterval () const
 
const Char_tGetUserClass ()
 
const KVStringGetUserClassDec () const
 
const KVStringGetUserClassImp () const
 
const KVStringGetUserClassOptions () const
 
const KVStringGetUserIncludes () const
 
const KVStringGetUserLibraries () const
 
Bool_t IsMenus () const
 
Bool_t IsQuit () const
 
Bool_t IsSubmit () const
 
Bool_t IsUserClassValid () const
 
virtual void postAnalysis ()
 
virtual void postEndAnalysis ()
 
virtual void postEndRun ()
 
virtual void postInitAnalysis ()
 
virtual void postInitRun ()
 
virtual void preEndAnalysis ()
 
virtual void preEndRun ()
 
virtual void Run ()
 Check all task variables, then run analyser. More...
 
virtual void RunMenus ()
 Run data analyser in menu-driven mode. More...
 
Bool_t RunningInLaunchDirectory ()
 
void SetAnalysisTask (KVDataAnalysisTask *at)
 
virtual void SetAuxFileList (TList *)
 
void SetBatchMode (Bool_t on=kTRUE)
 
void SetBatchName (const Char_t *batchname)
 
void SetBatchSystem (KVBatchSystem *bs)
 
void SetDataType (const Char_t *name)
 
virtual void SetFileList (TList *)
 
void SetMenus (Bool_t on=kTRUE)
 
void SetNbEventToRead (Long64_t nb=0)
 
void SetParent (KVDataAnalyser *da)
 
void SetProofMode (EProofMode e)
 
void SetQuit (Bool_t yes=kTRUE)
 
void SetStatusUpdateInterval (double t)
 
void SetSubmit (Bool_t yes=kTRUE)
 
void SetUserClass (const Char_t *kvs, Bool_t check=kTRUE)
 
void SetUserClassOptions (const Char_t *o="")
 
void SetUserIncludes (const Char_t *incDirs=0)
 
void SetUserLibraries (const Char_t *libs=0)
 
void UpdateBatchStatusFile (Int_t totev, Int_t evread, TString disk) const
 Update infos in batch status file. More...
 
void UseBaseClassSubmitTask ()
 
void WriteBatchInfo (TTree *)
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 
virtual ~TObject ()
 
void AbstractMethod (const char *method) const
 
virtual void AppendPad (Option_t *option="")
 
virtual void Browse (TBrowser *b)
 
ULong_t CheckedHash ()
 
virtual const char * ClassName () const
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 
virtual Int_t Compare (const TObject *obj) const
 
virtual void Copy (TObject &object) const
 
virtual void Delete (Option_t *option="")
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 
virtual void Draw (Option_t *option="")
 
virtual void DrawClass () const
 
virtual TObjectDrawClone (Option_t *option="") const
 
virtual void Dump () const
 
virtual void Error (const char *method, const char *msgfmt,...) const
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 
virtual TObjectFindObject (const char *name) const
 
virtual TObjectFindObject (const TObject *obj) const
 
virtual Option_tGetDrawOption () const
 
virtual const char * GetIconName () const
 
virtual const char * GetName () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 
virtual UInt_t GetUniqueID () const
 
virtual Bool_t HandleTimer (TTimer *timer)
 
virtual ULong_t Hash () const
 
Bool_t HasInconsistentHash () const
 
virtual void Info (const char *method, const char *msgfmt,...) const
 
virtual Bool_t InheritsFrom (const char *classname) const
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 
virtual void Inspect () const
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 
virtual Bool_t IsFolder () const
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 
void MayNotUse (const char *method) const
 
virtual Bool_t Notify ()
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 
void operator delete (void *ptr)
 
void operator delete[] (void *ptr)
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 
virtual void Paint (Option_t *option="")
 
virtual void Pop ()
 
virtual void Print (Option_t *option="") const
 
virtual Int_t Read (const char *name)
 
virtual void RecursiveRemove (TObject *obj)
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 
virtual void SetDrawOption (Option_t *option="")
 
virtual void SetUniqueID (UInt_t uid)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 

Private Attributes

Bool_t fUpdate
 

Additional Inherited Members

- Public Types inherited from KVDataAnalyser
enum  EProofMode { None , Lite , Proof }
 
- Public Types inherited from TObject
enum  EDeprecatedStatusBits
 
enum  EStatusBits
 
- Static Public Member Functions inherited from KVDataAnalyser
static Bool_t AbortProcessingLoop ()
 
static KVDataAnalyserGetAnalyser (const Char_t *plugin)
 
static Bool_t IsRunningBatchAnalysis ()
 
static void RunAnalyser (const Char_t *plugin="")
 
static void SetAbortProcessingLoop (Bool_t now=kTRUE)
 
- Static Public Member Functions inherited from TObject
static Longptr_t GetDtorOnly ()
 
static Bool_t GetObjectStat ()
 
static void SetDtorOnly (void *obj)
 
static void SetObjectStat (Bool_t stat)
 
- Public Attributes inherited from TObject
 kBitMask
 
 kCanDelete
 
 kCannotPick
 
 kHasUUID
 
 kInconsistent
 
 kInvalidObject
 
 kIsOnHeap
 
 kIsReferenced
 
 kMustCleanup
 
 kNoContextMenu
 
 kNotDeleted
 
 kObjInCanvas
 
 kOverwrite
 
 kSingleKey
 
 kWriteDelete
 
 kZombie
 
- Protected Member Functions inherited from KVDataSetAnalyser
void _set_dataset_pointer (KVDataSet *ds)
 
Bool_t CheckWhatToAnalyseAndHow ()
 
void ChooseWhatToAnalyse ()
 TO IMPLEMENT ? More...
 
void ChooseWhatToDo ()
 TO IMPLEMENT ? More...
 
Bool_t NeedToChooseWhatToAnalyse () const
 
Bool_t NeedToChooseWhatToDo () const
 
virtual void PostRunReset ()
 Called at end of Run() after execution of analysis task. More...
 
virtual Bool_t PreSubmitCheck ()
 
virtual KVNumberList PrintAvailableRuns (KVString &datatype)
 
virtual void set_dataset_name (const Char_t *name)
 
virtual void set_dataset_pointer (KVDataSet *ds)
 
virtual void set_up_analyser_for_task (KVDataAnalyser *the_analyser)
 
void SetCurrentRun (KVDBRun *r)
 
- Protected Member Functions inherited from KVDataAnalyser
virtual Bool_t CheckIfUserClassIsValid (const KVString &alternative_base_class="")
 
void CopyAnalysisResultsToLaunchDirectory ()
 
const Char_tGetACliCMode ()
 
TEnvGetBatchInfoFile () const
 
TObjectGetInstanceOfUserClass (const KVString &alternative_base_class="")
 
void ScanWorkingDirectory (TList **)
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 
void MakeZombie ()
 
- Protected Attributes inherited from KVReconDataAnalyser
Long64_t Entry
 
Int_t fDataReleaseNum
 KV release number used to write analysed data. More...
 
KVString fDataSeries
 KV series used to write analysed data. More...
 
KVString fDataVersion
 KV version used to write analysed data. More...
 
KVDataPatchList fRustines
 patches to be applied to correct data before analysis More...
 
KVReconEventSelectorfSelector
 the data analysis class More...
 
TTreetheChain
 chain of TTrees to be analysed More...
 
Long64_t TotalEntriesToRead
 
- Protected Attributes inherited from KVDataAnalyser
TListfWorkDirInit
 list of files in working directory before task runs More...
 
- Protected Attributes inherited from TObject
 kOnlyPrepStep
 

#include <KVOnlineReconDataAnalyser.h>

Inheritance diagram for KVOnlineReconDataAnalyser:
Inheritance graph
[legend]

Constructor & Destructor Documentation

◆ KVOnlineReconDataAnalyser()

KVOnlineReconDataAnalyser::KVOnlineReconDataAnalyser ( )

Default constructor.

Definition at line 22 of file KVOnlineReconDataAnalyser.cpp.

◆ ~KVOnlineReconDataAnalyser()

KVOnlineReconDataAnalyser::~KVOnlineReconDataAnalyser ( )
virtual

Destructor.

Definition at line 35 of file KVOnlineReconDataAnalyser.cpp.

Member Function Documentation

◆ CheckStatusUpdateInterval()

Bool_t KVOnlineReconDataAnalyser::CheckStatusUpdateInterval ( Int_t  ) const

This method returns true every fStatusUpdateInterval seconds, according to the check performed in SubmitTask You can change this value in your analysis class by calling

gDataAnalyser->SetStatusUpdateInterval(...);

with the required value in seconds before the processing loop starts

Definition at line 167 of file KVOnlineReconDataAnalyser.cpp.

◆ CheckTaskVariables()

Bool_t KVOnlineReconDataAnalyser::CheckTaskVariables ( void  )
inlinevirtual

Checks the task variables.

for now, don't check anything to be added: check user analysis class compiles, is valid, etc.

Reimplemented from KVReconDataAnalyser.

Definition at line 22 of file KVOnlineReconDataAnalyser.h.

◆ preAnalysis()

void KVOnlineReconDataAnalyser::preAnalysis ( )
virtual

Set minimum (trigger) multiplicity for array.

Reimplemented from KVDataAnalyser.

Definition at line 150 of file KVOnlineReconDataAnalyser.cpp.

◆ preInitAnalysis()

void KVOnlineReconDataAnalyser::preInitAnalysis ( )
virtual

Reimplemented from KVDataAnalyser.

Definition at line 140 of file KVOnlineReconDataAnalyser.cpp.

◆ preInitRun()

void KVOnlineReconDataAnalyser::preInitRun ( )
inlinevirtual

Reimplemented from KVDataAnalyser.

Definition at line 32 of file KVOnlineReconDataAnalyser.h.

◆ RegisterUserClass()

void KVOnlineReconDataAnalyser::RegisterUserClass ( TObject )
inlinevirtual

Reimplemented from KVReconDataAnalyser.

Definition at line 28 of file KVOnlineReconDataAnalyser.h.

◆ SubmitTask()

void KVOnlineReconDataAnalyser::SubmitTask ( )
virtual

Run the online analysis make the chosen dataset the active dataset ( = gDataSet; note this also opens database and positions gDataBase & gExpDB).

Reimplemented from KVReconDataAnalyser.

Definition at line 48 of file KVOnlineReconDataAnalyser.cpp.

◆ WriteBatchEnvFile()

void KVOnlineReconDataAnalyser::WriteBatchEnvFile ( const Char_t jobname,
Bool_t  save 
)
inlinevirtual

Save (in the TEnv fBatchEnv) all necessary information on analysis task which can be used to execute it later (i.e. when batch processing system executes the job). If save=kTRUE (default), write the information in a file whose name is given by ".jobname" where 'jobname' is the name of the job as given to the batch system.

Reimplemented from KVReconDataAnalyser.

Definition at line 29 of file KVOnlineReconDataAnalyser.h.

Member Data Documentation

◆ fUpdate

Bool_t KVOnlineReconDataAnalyser::fUpdate
mutableprivate

Definition at line 17 of file KVOnlineReconDataAnalyser.h.


The documentation for this class was generated from the following files: