Detailed Description

Define and manage data analysis tasks.

A KVDataAnalysisTask contains all information required by the system in order to be able to set up and run a data analysis task for data of a given dataset. Data analysis tasks are defined by variables in the environment files *.kvrootrc as in the following examples:

+DataAnalysisTask:     Reconstruction
Reconstruction.DataAnalysisTask.Title:     Event reconstruction from raw data (raw->recon)
Reconstruction.DataAnalysisTask.Prereq:     raw
Reconstruction.DataAnalysisTask.Analyser:     RawDataReconstructor
Reconstruction.DataAnalysisTask.UserClass:     no
Reconstruction.DataAnalysisTask.StatusUpdateInterval:     5000
 
+Plugin.KVDataAnalyser:   RawDataReconstructor         KVRawDataReconstructor        KVMultiDetexp_events   "KVRawDataReconstructor()"

Each task has a name, a descriptive title, a prerequisite type of data on which the analysis can be performed ("raw"), and the name of a KVDataAnalyser plugin which will be used to pilot the analysis. For a given dataset, only analysis tasks whose prerequisite data type is available can be performed.

Each value can be 'tweaked' for specific datasets by prefixing with the name of the dataset, e.g.

SomeDataSet.Reconstruction.DataAnalysisTask.Analyser:  MySpecialReconstructor
 
+Plugin.KVDataAnalyser:   MySpecialReconstructor   ReconstructSomeDataSet   ReconstructSomeDataSet.cpp+   "ReconstructSomeDataSet()"

The following example defines an analysis task which requires the user to supply an analysis class, and defines that this class must be derived from the TSelector plugin class, KVReconEventSelector. The analysis will be piloted by the KVReconDataAnalyser class:

+DataAnalysisTask:     ReconAnalysis
ReconAnalysis.DataAnalysisTask.Title:     Analysis of reconstructed events (recon)
ReconAnalysis.DataAnalysisTask.Prereq:     recon
ReconAnalysis.DataAnalysisTask.UserClass:     yes
ReconAnalysis.DataAnalysisTask.StatusUpdateInterval:     5000
ReconAnalysis.DataAnalysisTask.Analyser:     ReconDataAnalyser
ReconAnalysis.DataAnalysisTask.UserClass.Base:     ReconEventSelector/TSelector
 
+Plugin.KVDataAnalyser:   ReconDataAnalyser         KVReconDataAnalyser     KVMultiDetexp_events "KVReconDataAnalyser()"
 
+Plugin.TSelector:    ReconEventSelector    KVReconEventSelector    KVMultiDetanalysis   "KVReconEventSelector()"

The following analysis task also requires the user to supply an analysis class ("...UserClass: yes"), but as the base class for the analysis class is itself derived from KVDataAnalyser it is the user's class which will be used to pilot the analysis ("...Analyser: UserClass"):

+DataAnalysisTask:     RawAnalysis
RawAnalysis.DataAnalysisTask.Title:     Analysis of raw data
RawAnalysis.DataAnalysisTask.Prereq:     raw
RawAnalysis.DataAnalysisTask.Analyser:     UserClass
RawAnalysis.DataAnalysisTask.UserClass:     yes
RawAnalysis.DataAnalysisTask.UserClass.Base:     RawDataAnalyser
RawAnalysis.DataAnalysisTask.StatusUpdateInterval:     20000
 
+Plugin.KVDataAnalyser:   RawDataAnalyser    KVRawDataAnalyser    KVMultiDetexp_events "KVRawDataAnalyser()"

Definition at line 83 of file KVDataAnalysisTask.h.

#include <KVDataAnalysisTask.h>

Inheritance diagram for KVDataAnalysisTask:

[legend]

Public Member Functions
	KVDataAnalysisTask ()
	Default ctor.

	KVDataAnalysisTask (const KVDataAnalysisTask &)
	Copy ctor.

virtual	~KVDataAnalysisTask ()

virtual Bool_t	CheckUserBaseClassIsLoaded ()

virtual void	Copy (TObject &) const

virtual const Char_t *	GetDataAnalyser () const

virtual const Char_t *	GetPrereq () const

virtual Long64_t	GetStatusUpdateInterval () const

virtual const Char_t *	GetUserBaseClass () const

virtual void	ls (Option_t *opt="") const
	Print analysis task information.

virtual void	Print (Option_t *opt="") const

virtual void	SetDataAnalyser (const Char_t *d)

void	SetExtraAClicIncludes (const KVString &list)

virtual void	SetPrereq (const Char_t *p)

virtual void	SetStatusUpdateInterval (Long64_t n)

virtual void	SetUserBaseClass (const Char_t *d)

virtual void	SetWithUserClass (Bool_t w=kTRUE)

virtual Bool_t	WithUserClass () const

Public Member Functions inherited from KVBase
	KVBase ()
	Default constructor.

	KVBase (const Char_t name, const Char_t title="")
	Ctor for object with given name and type.

	KVBase (const KVBase &)
	copy ctor

virtual	~KVBase ()

virtual void	Clear (Option_t *opt="")
	Clear object properties : name, type/title, number, label.

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

UInt_t	GetNumberOfObjects () const

virtual TObject *	GetObject () const

virtual const Char_t *	GetType () const

Bool_t	HasLabel () const

virtual Bool_t	IsCalled (const Char_t *name) const

Bool_t	IsLabelled (const Char_t *l) const

virtual Bool_t	IsType (const Char_t *typ) const

virtual void	List ()

KVBase &	operator= (const KVBase &)
	copy assignment operator

Double_t	ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()

void	Clear (Option_t *option="") override

TObject *	Clone (const char *newname="") const override

Int_t	Compare (const TObject *obj) const override

void	Copy (TObject &named) const override

virtual void	FillBuffer (char *&buffer)

const char *	GetName () const override

const char *	GetTitle () const override

ULong_t	Hash () const override

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override

TNamed &	operator= (const TNamed &rhs)

void	Print (Option_t *option="") const override

virtual void	SetName (const char *name)

virtual void	SetNameTitle (const char name, const char title)

virtual void	SetTitle (const char *title="")

virtual Int_t	Sizeof () const

void	Streamer (TBuffer &) override

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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	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=nullptr)

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)

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 char *	GetObjectInfo (Int_t px, Int_t py) const

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const

virtual Bool_t	HandleTimer (TTimer *timer)

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)

Bool_t	IsDestructed () const

virtual Bool_t	IsEqual (const TObject *obj) const

virtual Bool_t	IsFolder () const

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () 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 vp)

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, void vp)

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 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)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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=nullptr, Int_t option=0, Int_t bufsize=0)

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const

Private Attributes
KVString	fAnalyser
	name of KVDataAnalyser class used to perform analysis

KVString	fBaseClass
	base class for user analysis

Bool_t	fBaseIsPlugin
	true if base class for user analysis is in a plugin library

KVString	fExtraAClicIncludes
	to be added to AClic include paths before compilation

KVString	fPluginBase
	known base class extended by plugin library

KVString	fPluginURI
	uri of the plugin library containing user base class

KVString	fPrereq
	prerequisite data directory i.e. data on which analysis task is performed

Long64_t	fStatusUpdateInterval
	interval (number of events) after which batch job progress and status are updated

Bool_t	fUserClass
	true if analysis task requires user-supplied class (derived from fBaseClass)

Additional Inherited Members
Public Types inherited from KVBase
enum	EKaliVedaBits { kIsKaliVedaObject = BIT(23) }

Public Types inherited from TObject
enum	EDeprecatedStatusBits

enum	EStatusBits

Static Public Member Functions inherited from KVBase
static Bool_t	AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
	Comparison between two 64-bit floating-point values.

static void	BackupFileWithDate (const Char_t *path)

static void	CombineFiles (const Char_t file1, const Char_t file2, const Char_t *newfilename, Bool_t keep=kTRUE)

static void	Deprecated (const char method, const char advice)

static Bool_t	FindClassSourceFiles (const Char_t class_name, KVString &imp_file, KVString &dec_file, const Char_t dir_name=".")

static Bool_t	FindExecutable (TString &exec, const Char_t *path="$(PATH)")

static const Char_t *	FindFile (const Char_t *search, TString &wfil)

static const Char_t *	GetBINDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetDATABASEFilePath ()

static const Char_t *	GetDATADIRFilePath (const Char_t *namefile="")

static Bool_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Bool_t defval)

static const Char_t *	GetDataSetEnv (const Char_t dataset, const Char_t type, const Char_t *defval)

static Double_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Double_t defval)

static const Char_t *	GetETCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetExampleFilePath (const Char_t library, const Char_t namefile)
	Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.)

static const Char_t *	GetINCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetKVBuildDate ()
	Returns KaliVeda build date.

static const Char_t *	GetKVBuildDir ()
	Returns top-level directory used for build.

static const Char_t *	GetKVBuildTime ()
	Returns KaliVeda build time.

static const Char_t *	GetKVBuildType ()
	Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...)

static const Char_t *	GetKVBuildUser ()
	Returns username of person who performed build.

static const Char_t *	GetKVSourceDir ()
	Returns top-level directory of source tree used for build.

static const Char_t *	GetKVVersion ()
	Returns KaliVeda version string.

static const Char_t *	GetLIBDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetListOfPlugins (const Char_t *base)

static const Char_t *	GetListOfPluginURIs (const Char_t *base)

static const Char_t *	GetPluginURI (const Char_t base, const Char_t plugin)

static void	GetTempFileName (TString &base)

static const Char_t *	GetTEMPLATEDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetWORKDIRFilePath (const Char_t *namefile="")

static const Char_t *	gitBranch ()
	Returns git branch of sources.

static const Char_t *	gitCommit ()
	Returns last git commit of sources.

static void	InitEnvironment ()

static bool	is_gnuinstall ()

static Bool_t	IsThisAPlugin (const TString &uri, TString &base)

static TPluginHandler *	LoadPlugin (const Char_t base, const Char_t uri="0")

static Bool_t	OpenContextMenu (const char method, TObject obj, const char *alt_method_name="")

static void	OpenTempFile (TString &base, std::ofstream &fp)

static void	PrintSplashScreen ()
	Prints welcome message and infos on version etc.

static Bool_t	SearchAndOpenKVFile (const Char_t name, KVSQLite::database &dbfile, const Char_t kvsubdir="")

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ifstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ofstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchKVFile (const Char_t name, TString &fullpath, const Char_t kvsubdir="")

static const Char_t *	WorkingDirectory ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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 TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const

void	MakeZombie ()

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from TObject
	kOnlyPrepStep

Constructor & Destructor Documentation

◆ KVDataAnalysisTask() [1/2]

KVDataAnalysisTask::KVDataAnalysisTask ( )

Default ctor.

Definition at line 23 of file KVDataAnalysisTask.cpp.

◆ KVDataAnalysisTask() [2/2]

KVDataAnalysisTask::KVDataAnalysisTask ( const KVDataAnalysisTask & obj )

Copy ctor.

Definition at line 36 of file KVDataAnalysisTask.cpp.

◆ ~KVDataAnalysisTask()

KVDataAnalysisTask::~KVDataAnalysisTask ( )

virtual

Definition at line 77 of file KVDataAnalysisTask.cpp.

Member Function Documentation

◆ CheckUserBaseClassIsLoaded()

Bool_t KVDataAnalysisTask::CheckUserBaseClassIsLoaded ( )

virtual

This method checks that the base class for the user's analysis class is loaded. If this base class requires a plugin library to be loaded, it will be loaded. First we add any required extra ACliC include paths (taken from DataAnalysisTask.UserClass.ExtraACliCIncludes) If all is OK, returns kTRUE. Returns kFALSE if plugin cannot be loaded or class is simply unknown

Definition at line 196 of file KVDataAnalysisTask.cpp.

◆ Copy()

void KVDataAnalysisTask::Copy ( TObject & obj ) const

virtual

Copy this to obj Redefinition of KVBase::Copy

Reimplemented from KVBase.

Definition at line 53 of file KVDataAnalysisTask.cpp.

◆ GetDataAnalyser()

virtual const Char_t * KVDataAnalysisTask::GetDataAnalyser ( ) const

inlinevirtual

Definition at line 127 of file KVDataAnalysisTask.h.

◆ GetPrereq()

virtual const Char_t * KVDataAnalysisTask::GetPrereq ( ) const

inlinevirtual

Definition at line 112 of file KVDataAnalysisTask.h.

◆ GetStatusUpdateInterval()

virtual Long64_t KVDataAnalysisTask::GetStatusUpdateInterval ( ) const

inlinevirtual

Definition at line 148 of file KVDataAnalysisTask.h.

◆ GetUserBaseClass()

virtual const Char_t * KVDataAnalysisTask::GetUserBaseClass ( ) const

inlinevirtual

Definition at line 132 of file KVDataAnalysisTask.h.

◆ ls()

void KVDataAnalysisTask::ls ( Option_t * opt = "" ) const

virtual

Print analysis task information.

Reimplemented from TObject.

Definition at line 86 of file KVDataAnalysisTask.cpp.

◆ Print()

virtual void KVDataAnalysisTask::Print ( Option_t * opt = "" ) const

inlinevirtual

Reimplemented from KVBase.

Definition at line 118 of file KVDataAnalysisTask.h.

◆ SetDataAnalyser()

virtual void KVDataAnalysisTask::SetDataAnalyser ( const Char_t * d )

inlinevirtual

Definition at line 123 of file KVDataAnalysisTask.h.

◆ SetExtraAClicIncludes()

void KVDataAnalysisTask::SetExtraAClicIncludes ( const KVString & list )

inline

Definition at line 154 of file KVDataAnalysisTask.h.

◆ SetPrereq()

virtual void KVDataAnalysisTask::SetPrereq ( const Char_t * p )

inlinevirtual

Definition at line 108 of file KVDataAnalysisTask.h.

◆ SetStatusUpdateInterval()

virtual void KVDataAnalysisTask::SetStatusUpdateInterval ( Long64_t n )

inlinevirtual

Definition at line 144 of file KVDataAnalysisTask.h.

◆ SetUserBaseClass()

void KVDataAnalysisTask::SetUserBaseClass ( const Char_t * base_name )

virtual

Set the class from which user's analysis class must derive. This is normally read in from the following environment variable:

TaskName.DataAnalysisTask.UserClass.Base: [base_name]

If base_name is not the name of a known (i.e. currently contained in the ROOT dictionary class table) class, it is assumed to be the uri of a plugin class. By default, we assume that the plugin extends the KVDataAnalyser class, but this can be changed using the following syntax:

TaskName.DataAnalysisTask.UserClass.Base: [uri]/[base class]

Example 1: The user analysis class for task "RawAnalysis" must derive from class KVIVRawDataAnalyser which is defined in library libVAMOS.so (not loaded by default):

RawAnalysis.DataAnalysisTask.UserClass.Base: IVRawDataAnalyser +Plugin.KVDataAnalyser: IVRawDataAnalyser KVIVRawDataAnalyser VAMOS "KVIVRawDataAnalyser()"

Example 2: The user analysis class for task "ReconIdent" must derive from class KVIVReconIdent (itself derived from TSelector) which is defined in library libVAMOS.so (not loaded by default):

ReconIdent.DataAnalysisTask.UserClass.Base: IVReconIdent/TSelector +Plugin.TSelector: IVReconIdent KVIVReconIdent VAMOS "KVIVReconIdent()"

Definition at line 128 of file KVDataAnalysisTask.cpp.

◆ SetWithUserClass()

virtual void KVDataAnalysisTask::SetWithUserClass ( Bool_t w = kTRUE )

inlinevirtual

Definition at line 136 of file KVDataAnalysisTask.h.

◆ WithUserClass()

virtual Bool_t KVDataAnalysisTask::WithUserClass ( ) const

inlinevirtual

Definition at line 140 of file KVDataAnalysisTask.h.

Member Data Documentation

◆ fAnalyser

KVString KVDataAnalysisTask::fAnalyser

private

name of KVDataAnalyser class used to perform analysis

Definition at line 86 of file KVDataAnalysisTask.h.

◆ fBaseClass

KVString KVDataAnalysisTask::fBaseClass

private

base class for user analysis

Definition at line 87 of file KVDataAnalysisTask.h.

◆ fBaseIsPlugin

Bool_t KVDataAnalysisTask::fBaseIsPlugin

private

true if base class for user analysis is in a plugin library

Definition at line 90 of file KVDataAnalysisTask.h.

◆ fExtraAClicIncludes

KVString KVDataAnalysisTask::fExtraAClicIncludes

private

to be added to AClic include paths before compilation

Definition at line 93 of file KVDataAnalysisTask.h.

◆ fPluginBase

KVString KVDataAnalysisTask::fPluginBase

private

known base class extended by plugin library

Definition at line 92 of file KVDataAnalysisTask.h.

◆ fPluginURI

KVString KVDataAnalysisTask::fPluginURI

private

uri of the plugin library containing user base class

Definition at line 91 of file KVDataAnalysisTask.h.

◆ fPrereq

KVString KVDataAnalysisTask::fPrereq

private

prerequisite data directory i.e. data on which analysis task is performed

Definition at line 85 of file KVDataAnalysisTask.h.

◆ fStatusUpdateInterval

Long64_t KVDataAnalysisTask::fStatusUpdateInterval

private

interval (number of events) after which batch job progress and status are updated

Definition at line 94 of file KVDataAnalysisTask.h.

◆ fUserClass

Bool_t KVDataAnalysisTask::fUserClass

private

true if analysis task requires user-supplied class (derived from fBaseClass)

Definition at line 88 of file KVDataAnalysisTask.h.

Detailed Description

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVDataAnalysisTask() [1/2]

◆ KVDataAnalysisTask() [2/2]

◆ ~KVDataAnalysisTask()

Member Function Documentation

◆ CheckUserBaseClassIsLoaded()

◆ Copy()

◆ GetDataAnalyser()

◆ GetPrereq()

◆ GetStatusUpdateInterval()

◆ GetUserBaseClass()

◆ ls()

◆ Print()

◆ SetDataAnalyser()

◆ SetExtraAClicIncludes()

◆ SetPrereq()

◆ SetStatusUpdateInterval()

◆ SetUserBaseClass()

◆ SetWithUserClass()

◆ WithUserClass()

Member Data Documentation

◆ fAnalyser

◆ fBaseClass

◆ fBaseIsPlugin

◆ fExtraAClicIncludes

◆ fPluginBase

◆ fPluginURI

◆ fPrereq

◆ fStatusUpdateInterval

◆ fUserClass