KaliVeda
1.12/06
Heavy-Ion Analysis Toolkit
|
Pilots user analysis of experimental data.
Created by KVClassFactory on Tue Feb 14 12:32:06 2017 Author: John Frankland,,,
Definition at line 16 of file KVDataSetAnalyser.h.
Public Member Functions | |
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 |
KVDBRun * | GetAnalysedRun () const |
KVDBSystem * | GetAnalysedSystem () const |
const KVDataSet * | GetDataSet () const |
const KVNumberList & | GetFullRunList () const |
const KV2Body * | GetKinematics () const |
Return pointer to kinematics of analysed system if defined. More... | |
Int_t | GetNumberOfFilesToAnalyse () const |
const Char_t * | GetRecognisedAutoBatchNameKeywords () const |
KVString | GetRootDirectoryOfDataToAnalyse () const |
Returns path to data to be analysed. More... | |
const KVNumberList & | GetRunList () const |
Int_t | GetRunNumberFromFileName (const Char_t *) |
Get the run number from the filename. More... | |
const KVDBSystem * | GetSystem () 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 | Reset () |
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... | |
virtual void | SetTree (TTree *) |
TString | SystemBatchName () const |
void | WriteBatchEnvFile (const Char_t *jobname, Bool_t save=kTRUE) |
Public Member Functions inherited from KVDataAnalyser | |
KVDataAnalyser () | |
Default constructor. More... | |
virtual | ~ KVDataAnalyser () |
Bool_t | BatchMode () const |
virtual Bool_t | CheckStatusUpdateInterval (Long64_t nevents) const |
virtual Bool_t | CheckTaskVariables () |
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 () |
KVDataAnalysisTask * | GetAnalysisTask () const |
const Char_t * | GetBatchName () |
const Char_t * | GetBatchStatusFileName () const |
Returns full path to file used to store status of running batch jobs. More... | |
virtual const KVBatchSystem * | GetBatchSystem () |
const KVString & | GetDataType () const |
const Char_t * | GetLaunchDirectory () const |
Long64_t | GetNbEventToRead (void) const |
KVDataAnalyser * | GetParent () const |
EProofMode | GetProofMode () const |
Double_t | GetStatusUpdateInterval () const |
virtual Long64_t | GetTotalEntriesToRead () const |
const Char_t * | GetUserClass () |
const KVString & | GetUserClassDec () const |
const KVString & | GetUserClassImp () const |
const KVString & | GetUserClassOptions () const |
const KVString & | GetUserIncludes () const |
const KVString & | GetUserLibraries () 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 | preAnalysis () |
virtual void | preEndAnalysis () |
virtual void | preEndRun () |
virtual void | preInitAnalysis () |
virtual void | preInitRun () |
virtual void | RegisterUserClass (TObject *) |
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) |
virtual void | SetTriggerConditionsForRun (int) |
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) |
virtual void | SubmitTask () |
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 TObject * | Clone (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 TObject * | DrawClone (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 TObject * | FindObject (const char *name) const |
virtual TObject * | FindObject (const TObject *obj) const |
virtual Option_t * | GetDrawOption () const |
virtual const char * | GetIconName () const |
virtual const char * | GetName () const |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
virtual Option_t * | GetOption () 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) |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *vp) |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, void *vp) |
TObject & | operator= (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 | fChoozDataSet |
set to kTRUE when user wants to choose a dataset More... | |
Bool_t | fChoozRuns |
set to kTRUE when user wants to choose runs More... | |
Bool_t | fChoozSystem |
set to kTRUE when user wants to choose a system More... | |
Bool_t | fChoozTask |
set to kTRUE when user wants to choose analysis task More... | |
KVDataSet * | fDataSet |
dataset chosen by user More... | |
KVNumberList | fFullRunList |
list of all runs for the analysis task More... | |
KVDBRun * | fRun |
currently analysed run More... | |
KVNumberList | fRunList |
list of runs to analyse More... | |
KVDBSystem * | fSystem |
system chosen by user More... | |
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 KVDataAnalyser * | GetAnalyser (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 Attributes inherited from KVDataAnalyser | |
TList * | fWorkDirInit |
list of files in working directory before task runs More... | |
Protected Attributes inherited from TObject | |
kOnlyPrepStep | |
#include <KVDataSetAnalyser.h>
KVDataSetAnalyser::KVDataSetAnalyser | ( | ) |
Default constructor.
Definition at line 22 of file KVDataSetAnalyser.cpp.
|
virtual |
Destructor.
Definition at line 40 of file KVDataSetAnalyser.cpp.
Definition at line 38 of file KVDataSetAnalyser.h.
Retrieve a KVNameValueList called "JobDescriptionList" from the TList created with KVDataAnalyser::AddJobDescriptionList(l). The parameters in the list describe the properties of the current job. The TList pointer could be, for example, the address of the TSelector::fInput list used by PROOF.
Reimplemented from KVDataAnalyser.
Definition at line 880 of file KVDataSetAnalyser.cpp.
|
protectedvirtual |
Reimplemented from KVDataAnalyser.
Definition at line 124 of file KVDataSetAnalyser.cpp.
|
virtual |
Print list of all possible data analysis tasks for the chosen data set and invite the user to choose one of them. If only one task available, it is automatically selected not possible in batch mode
Reimplemented in KVDataTransfer.
Definition at line 257 of file KVDataSetAnalyser.cpp.
void KVDataSetAnalyser::ChooseDataSet | ( | ) |
Print list of available datasets and get user to choose one A pointer to the chosen dataset can be retrieved with GetDataSet() not possible in batch mode
Definition at line 156 of file KVDataSetAnalyser.cpp.
void KVDataSetAnalyser::ChooseDataType | ( | ) |
Print list of available types of data for the chosen dataset and get user to choose one. not possible in batch mode
Definition at line 214 of file KVDataSetAnalyser.cpp.
void KVDataSetAnalyser::ChooseRuns | ( | KVDBSystem * | system = nullptr , |
const Char_t * | data_type = "" |
||
) |
Print out list of available runs for chosen dataset, task/data type and system and invite user to choose from among them If 'data_type' is not given, we assume that ChooseAnalysisTask was previously called and we use the prerequisite data type for the chosen task (fTask->GetPrereq()). If 'system' is not given, we assume ChooseSystem was previously called and use the internally-stored value of that choice (fSystem). not possible in batch mode
Definition at line 429 of file KVDataSetAnalyser.cpp.
Print out list of all available systems for the given data type of the chosen dataset and invite the user to choose one. Return pointer to chosen system. If 'data_type' is not given, we assume that ChooseAnalysisTask was previously called and we use the prerequisite data type for the chosen task (fTask->GetPrereq()). The available system list is deduced from the 'availableruns' file corresponding to the chosen dataset repository subdirectory and the chosen data type (="raw", "recon", "ident", "root"). not possible in batch mode
Definition at line 320 of file KVDataSetAnalyser.cpp.
|
protectedvirtual |
TO IMPLEMENT ?
Reimplemented from KVDataAnalyser.
Definition at line 92 of file KVDataSetAnalyser.cpp.
|
protectedvirtual |
TO IMPLEMENT ?
Reimplemented from KVDataAnalyser.
Definition at line 108 of file KVDataSetAnalyser.cpp.
|
inline |
Definition at line 105 of file KVDataSetAnalyser.h.
Replace any 'special' symbols in "format" with their current values
$System : name of system to be analysed
Reimplemented from KVDataAnalyser.
Definition at line 822 of file KVDataSetAnalyser.cpp.
|
inlinevirtual |
Reimplemented from KVDataAnalyser.
Definition at line 154 of file KVDataSetAnalyser.h.
|
inlinevirtual |
Reimplemented from KVDataAnalyser.
Definition at line 150 of file KVDataSetAnalyser.h.
|
inline |
Definition at line 86 of file KVDataSetAnalyser.h.
|
inline |
Definition at line 82 of file KVDataSetAnalyser.h.
|
virtual |
Return pointer to kinematics of analysed system if defined.
Reimplemented from KVDataAnalyser.
Definition at line 849 of file KVDataSetAnalyser.cpp.
|
inlinevirtual |
Reimplemented from KVDataAnalyser.
Definition at line 78 of file KVDataSetAnalyser.h.
|
virtual |
Reimplemented from KVDataAnalyser.
Definition at line 837 of file KVDataSetAnalyser.cpp.
|
virtual |
Returns path to data to be analysed.
Reimplemented from KVDataAnalyser.
Definition at line 900 of file KVDataSetAnalyser.cpp.
|
inline |
Definition at line 74 of file KVDataSetAnalyser.h.
Get the run number from the filename.
Definition at line 862 of file KVDataSetAnalyser.cpp.
|
inline |
Definition at line 70 of file KVDataSetAnalyser.h.
|
inline |
Definition at line 114 of file KVDataSetAnalyser.h.
|
inline |
Definition at line 138 of file KVDataSetAnalyser.h.
|
inline |
Definition at line 130 of file KVDataSetAnalyser.h.
|
inline |
Definition at line 122 of file KVDataSetAnalyser.h.
|
inlineprotectedvirtual |
Reimplemented from KVDataAnalyser.
Definition at line 49 of file KVDataSetAnalyser.h.
|
inlineprotectedvirtual |
Reimplemented from KVDataAnalyser.
Definition at line 45 of file KVDataSetAnalyser.h.
|
protectedvirtual |
Called at end of Run() after execution of analysis task.
Reimplemented from KVDataAnalyser.
Definition at line 81 of file KVDataSetAnalyser.cpp.
|
protectedvirtual |
Called just before SubmitTask() in Run() Checks if remote repository is connected if necessary
Reimplemented from KVDataAnalyser.
Definition at line 68 of file KVDataSetAnalyser.cpp.
|
protectedvirtual |
Prints list of available runs for selected dataset, data type/analysis task, and system Returns list containing all run numbers
Reimplemented in KVINDRAReconDataAnalyser, KVINDRAGeneDataAnalyser, and KVINDRADstToRootTransfert.
Definition at line 595 of file KVDataSetAnalyser.cpp.
Read the batch env file "filename" and initialise the analysis task using the informations in the file Returns kTRUE if all goes well
Reimplemented from KVDataAnalyser.
Definition at line 724 of file KVDataSetAnalyser.cpp.
Reimplemented from KVDataAnalyser.
Reimplemented in KVReconDataAnalyser.
Definition at line 50 of file KVDataSetAnalyser.cpp.
Set dataset to be analysed. If 'name' is not the name of a valid and available dataset in the currently active data repository, gDataRepository, an error message is printed.
Reimplemented in KVDataTransfer.
Definition at line 572 of file KVDataSetAnalyser.cpp.
Set dataset to be used for analysis. If the chosen dataset is not available, an error message is printed Only available datasets can be analysed Moreover, only datasets in the currently active data repository, gDataRepository, can be analysed. This is also checked. allow user to reset dataset pointer to 0
Reimplemented in KVDataTransfer.
Definition at line 534 of file KVDataSetAnalyser.cpp.
|
protectedvirtual |
Reimplemented from KVDataAnalyser.
Definition at line 786 of file KVDataSetAnalyser.cpp.
Definition at line 110 of file KVDataSetAnalyser.h.
Definition at line 134 of file KVDataSetAnalyser.h.
Definition at line 126 of file KVDataSetAnalyser.h.
Definition at line 118 of file KVDataSetAnalyser.h.
Definition at line 30 of file KVDataSetAnalyser.h.
Definition at line 94 of file KVDataSetAnalyser.h.
Definition at line 90 of file KVDataSetAnalyser.h.
|
inline |
Definition at line 100 of file KVDataSetAnalyser.h.
void KVDataSetAnalyser::SetRuns | ( | const KVNumberList & | nl, |
Bool_t | check = kTRUE |
||
) |
Sets the run list If check=kTRUE (default), we check that the runs are available, and if they belong to different systems we print a warning message
Definition at line 640 of file KVDataSetAnalyser.cpp.
void KVDataSetAnalyser::SetSystem | ( | KVDBSystem * | syst | ) |
Set the System used in the analysis.
Definition at line 625 of file KVDataSetAnalyser.cpp.
Reimplemented in KVReconDataAnalyser, and KVINDRAReconDataAnalyser.
Definition at line 158 of file KVDataSetAnalyser.h.
TString KVDataSetAnalyser::SystemBatchName | ( | ) | const |
Private method used by ExpandAutoBatchName to build name for current system to be used in batch job name Also used by KVDataAnalysisLauncher::SystemBatchName for batch job names and for writing resources in .KVDataAnalysisGUIrc file
Definition at line 803 of file KVDataSetAnalyser.cpp.
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 KVDataAnalyser.
Reimplemented in KVOnlineReconDataAnalyser, and KVReconDataAnalyser.
Definition at line 700 of file KVDataSetAnalyser.cpp.
|
private |
set to kTRUE when user wants to choose a dataset
Definition at line 24 of file KVDataSetAnalyser.h.
|
private |
set to kTRUE when user wants to choose runs
Definition at line 27 of file KVDataSetAnalyser.h.
|
private |
set to kTRUE when user wants to choose a system
Definition at line 26 of file KVDataSetAnalyser.h.
|
private |
set to kTRUE when user wants to choose analysis task
Definition at line 25 of file KVDataSetAnalyser.h.
|
private |
dataset chosen by user
Definition at line 22 of file KVDataSetAnalyser.h.
|
private |
list of all runs for the analysis task
Definition at line 21 of file KVDataSetAnalyser.h.
|
private |
currently analysed run
Definition at line 19 of file KVDataSetAnalyser.h.
|
private |
list of runs to analyse
Definition at line 20 of file KVDataSetAnalyser.h.
|
private |
system chosen by user
Definition at line 18 of file KVDataSetAnalyser.h.