Detailed Description

Manager class which sets up and runs data analysis tasks.

This is a base class for running data analysis tasks, specified by

the dataset (experiment) to analyse (KVDataSet);
the type of analysis task to perform (KVDataAnalysisTask);
the data files to analyse (using KVDataRepository and KVDataRepositoryManager);
whether to use a batch system to execute the analysis (KVBatchSystem and KVBatchSystemManager).

The role of this base class is to set up the environment necessary for the execution of a given data analysis task, including:

building the KVMultiDetArray (or KVExpSetUp) describing the experimental setup corresponding to the data;
retrieving and opening the data files requested for analysis;
looping over all events in each of the requested files and calling the user's analysis;
in case of remote batch systems: copying back the results of the analysis to the launch directory.

The actual analysis will be performed either by an implementation of a child class of KVDataAnalyser, or by an implementation derived from a different base class (for example, KVEventSelector for analysis of KVEvent objects in TTree branches) but in all cases the analysis is driven by a class derived from KVDataAnalyser:

KVRawDataAnalyser both implements and drives analysis of raw data;
KVReconRawDataAnalyser both implements and drives analysis of raw data which is reconstructed 'on the fly';
KVRawDataReconstructor implements and drives generation of new reconstructed data files;
KVReconDataAnalyser drives analysis of reconstructed data; user analysis implemented in a class derived from KVReconEventSelector;
KVSimDirAnalyser drives analysis of simulated events; user analysis implemented in a class derived from KVEventSelector
KVSimDirFilterAnalyser drives analysis of reconstructed filtered simulated events; user analysis implemented in a class derived from KVReconEventSelector;

Definition at line 57 of file KVDataAnalyser.h.

#include <KVDataAnalyser.h>

Inheritance diagram for KVDataAnalyser:

[legend]

Classes
struct	UserClass

Public Types
enum	EProofMode { None , Lite , Proof }

Public Types inherited from TObject
enum	EDeprecatedStatusBits

enum	EStatusBits

Public Member Functions
	KVDataAnalyser ()
	Default constructor. More...

virtual	~KVDataAnalyser ()
	Default destructor. More...

virtual void	AddJobDescriptionList (TList *)

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

virtual TString	ExpandAutoBatchName (const Char_t *format) const

virtual KVDBRun *	GetAnalysedRun () const

virtual KVDBSystem *	GetAnalysedSystem () const

virtual TTree *	GetAnalysedTree () const

virtual TString	GetAnalyserClassNameForBatchJob ()

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

virtual const KV2Body *	GetKinematics () const

const Char_t *	GetLaunchDirectory () const

Long64_t	GetNbEventToRead (void) const

virtual Int_t	GetNumberOfFilesToAnalyse () const

KVDataAnalyser *	GetParent () const

TString	GetPathToFileInLaunchDirectory (const TString &) const

EProofMode	GetProofMode () const

virtual const Char_t *	GetRecognisedAutoBatchNameKeywords () const

virtual KVString	GetRootDirectoryOfDataToAnalyse () const

Double_t	GetStatusUpdateInterval () const

virtual Long64_t	GetTotalEntriesToRead () const

const UserClass &	GetUserClass () const

KVString	GetUserClassName ()

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 Bool_t	ReadBatchEnvFile (const TString &)

virtual void	RegisterUserClass (TObject *)

virtual void	Reset ()

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

virtual void	SetAnalysedTree (TTree *)

void	SetAnalysisTask (KVDataAnalysisTask *at)

virtual void	SetAuxFileList (const KVUnownedList &)

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 (const KVUnownedList &)

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 UserClass &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 ()

virtual void	WriteBatchEnvFile (const TString &, Bool_t sav=kTRUE)

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=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 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 TClass *	IsA () const

Bool_t	IsDestructed () const

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 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 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	Streamer (TBuffer &)

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

Static Public Member Functions
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 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)

Additional Inherited Members
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 TObject
	kOnlyPrepStep

Member Enumeration Documentation

◆ EProofMode

enum KVDataAnalyser::EProofMode

Enumerator
None
Lite
Proof

Definition at line 167 of file KVDataAnalyser.h.

Constructor & Destructor Documentation

◆ KVDataAnalyser()

KVDataAnalyser::KVDataAnalyser ( )

Default constructor.

Definition at line 36 of file KVDataAnalyser.cpp.

◆ ~KVDataAnalyser()

KVDataAnalyser::~KVDataAnalyser ( )

virtual

Default destructor.

Definition at line 64 of file KVDataAnalyser.cpp.

Member Function Documentation

◆ AbortProcessingLoop()

static Bool_t KVDataAnalyser::AbortProcessingLoop ( )

inlinestatic

Definition at line 189 of file KVDataAnalyser.h.

◆ AddJobDescriptionList()

void KVDataAnalyser::AddJobDescriptionList ( TList * l )

virtual

Create a KVNameValueList called "JobDescriptionList" and add it to the TList. 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 in KVDataSetAnalyser.

Definition at line 1299 of file KVDataAnalyser.cpp.

◆ BatchMode()

Bool_t KVDataAnalyser::BatchMode ( ) const

inline

Definition at line 228 of file KVDataAnalyser.h.

◆ CheckStatusUpdateInterval()

Bool_t KVDataAnalyser::CheckStatusUpdateInterval ( Long64_t nevents ) const

virtual

Returns kTRUE if the number of events coincides with the interval set for status updates for the current data analysis task

Definition at line 1060 of file KVDataAnalyser.cpp.

◆ CheckTaskVariables()

Bool_t KVDataAnalyser::CheckTaskVariables ( void )

virtual

Checks the task variables In batch mode, we first set the task variables by reading the batch env file associated with the name set for the batch job

Reimplemented in KVINDRAReconDataAnalyser, KVReconDataAnalyser, and KVOnlineReconDataAnalyser.

Definition at line 200 of file KVDataAnalyser.cpp.

◆ ChooseNbEventToRead()

void KVDataAnalyser::ChooseNbEventToRead ( )

Ask user to set number of events to read.

Definition at line 360 of file KVDataAnalyser.cpp.

◆ ChooseRunningMode()

void KVDataAnalyser::ChooseRunningMode ( )

Ask user to choose between immediate or batch execution If the choice is batch, we ask to choose a batch system and whether or not to use the "multijobs" mode

Definition at line 1094 of file KVDataAnalyser.cpp.

◆ ChooseUserClass()

void KVDataAnalyser::ChooseUserClass ( )

Choose the user's analysis class.

Definition at line 412 of file KVDataAnalyser.cpp.

◆ DeleteBatchStatusFile()

void KVDataAnalyser::DeleteBatchStatusFile ( ) const

Delete batch status file (and backup - '.bak') for batch job.

Definition at line 1043 of file KVDataAnalyser.cpp.

◆ DoStatusUpdate()

void KVDataAnalyser::DoStatusUpdate ( Long64_t nevents ) const

Print infos on events treated, disk usage, memory usage.

Definition at line 1072 of file KVDataAnalyser.cpp.

◆ DoUserClassFilesExist()

Bool_t KVDataAnalyser::DoUserClassFilesExist ( )

Check if files containing user's class can be located. The names of the implementation and header files are stored in fUserClassImp and fUserClassDec.

Definition at line 430 of file KVDataAnalyser.cpp.

◆ ExpandAutoBatchName()

TString KVDataAnalyser::ExpandAutoBatchName ( const Char_t * format ) const

virtual

Replace any 'special' symbols in "format" with their current values

$Date : current date and time $User : name of user $UserClass : name of user's analysis class

Reimplemented in KVSimDirAnalyser, and KVDataSetAnalyser.

Definition at line 931 of file KVDataAnalyser.cpp.

◆ GetAnalysedRun()

virtual KVDBRun* KVDataAnalyser::GetAnalysedRun ( ) const

inlinevirtual

Reimplemented in KVSimDirFilterAnalyser, and KVDataSetAnalyser.

Definition at line 414 of file KVDataAnalyser.h.

◆ GetAnalysedSystem()

virtual KVDBSystem* KVDataAnalyser::GetAnalysedSystem ( ) const

inlinevirtual

Reimplemented in KVSimDirFilterAnalyser, and KVDataSetAnalyser.

Definition at line 410 of file KVDataAnalyser.h.

◆ GetAnalysedTree()

virtual TTree* KVDataAnalyser::GetAnalysedTree ( ) const

inlinevirtual

If data being analysed is contained in a ROOT TTree, return its address

Note: what is actually returned is the address of a TChain. Use GetTree()->GetTree() to access the currently analysed TTree.

Reimplemented in KVINDRAReconDataAnalyser, KVReconDataAnalyser, and KVSimDirAnalyser.

Definition at line 421 of file KVDataAnalyser.h.

◆ GetAnalyser()

KVDataAnalyser * KVDataAnalyser::GetAnalyser ( const Char_t * plugin )

static

Creates an instance of a class derived from KVDataAnalyser defined as a plugin check and load plugin library

Definition at line 391 of file KVDataAnalyser.cpp.

◆ GetAnalyserClassNameForBatchJob()

virtual TString KVDataAnalyser::GetAnalyserClassNameForBatchJob ( )

inlinevirtual

Reimplemented in KVSimDirAnalyser, and KVDataSetAnalyser.

Definition at line 430 of file KVDataAnalyser.h.

◆ GetAnalysisTask()

KVDataAnalysisTask* KVDataAnalyser::GetAnalysisTask ( ) const

inline

Definition at line 273 of file KVDataAnalyser.h.

◆ GetBatchName()

const Char_t* KVDataAnalyser::GetBatchName ( )

inline

Definition at line 236 of file KVDataAnalyser.h.

◆ GetBatchStatusFileName()

const Char_t * KVDataAnalyser::GetBatchStatusFileName ( ) const

Returns full path to file used to store status of running batch jobs.

Definition at line 1002 of file KVDataAnalyser.cpp.

◆ GetBatchSystem()

virtual const KVBatchSystem* KVDataAnalyser::GetBatchSystem ( )

inlinevirtual

Definition at line 246 of file KVDataAnalyser.h.

◆ GetDataType()

const KVString& KVDataAnalyser::GetDataType ( ) const

inline

Definition at line 277 of file KVDataAnalyser.h.

◆ GetKinematics()

virtual const KV2Body* KVDataAnalyser::GetKinematics ( ) const

inlinevirtual

Returns: pointer to KV2Body object describing kinematics of reaction being analysed

Reimplemented in KVSimDirFilterAnalyser, and KVDataSetAnalyser.

Examples: ExampleFilteredSimDataAnalysis.cpp.

Definition at line 406 of file KVDataAnalyser.h.

◆ GetLaunchDirectory()

const Char_t * KVDataAnalyser::GetLaunchDirectory ( ) const

Returns full path to job submission directory for batch jobs. Returns current working directory for non-batch jobs.

Definition at line 966 of file KVDataAnalyser.cpp.

◆ GetNbEventToRead()

Long64_t KVDataAnalyser::GetNbEventToRead ( void ) const

inline

Definition at line 304 of file KVDataAnalyser.h.

◆ GetNumberOfFilesToAnalyse()

virtual Int_t KVDataAnalyser::GetNumberOfFilesToAnalyse ( ) const

inlinevirtual

Reimplemented in KVSimDirAnalyser, and KVDataSetAnalyser.

Definition at line 211 of file KVDataAnalyser.h.

◆ GetParent()

KVDataAnalyser* KVDataAnalyser::GetParent ( ) const

inline

Definition at line 325 of file KVDataAnalyser.h.

◆ GetPathToFileInLaunchDirectory()

TString KVDataAnalyser::GetPathToFileInLaunchDirectory ( const TString & f ) const

Use this method to get the full path to a file in the directory where the job was launched.

When not using a batch system, this will just be the current working directory.

If the job is actually running elsewhere, use this method to access a file in the launch directory.

Definition at line 984 of file KVDataAnalyser.cpp.

◆ GetProofMode()

EProofMode KVDataAnalyser::GetProofMode ( ) const

inline

Definition at line 179 of file KVDataAnalyser.h.

◆ GetRecognisedAutoBatchNameKeywords()

const Char_t * KVDataAnalyser::GetRecognisedAutoBatchNameKeywords ( ) const

virtual

Reimplemented in KVDataSetAnalyser.

Definition at line 954 of file KVDataAnalyser.cpp.

◆ GetRootDirectoryOfDataToAnalyse()

virtual KVString KVDataAnalyser::GetRootDirectoryOfDataToAnalyse ( ) const

inlinevirtual

Reimplemented in KVSimDirAnalyser, and KVDataSetAnalyser.

Definition at line 393 of file KVDataAnalyser.h.

◆ GetStatusUpdateInterval()

Double_t KVDataAnalyser::GetStatusUpdateInterval ( ) const

inline

Definition at line 266 of file KVDataAnalyser.h.

◆ GetTotalEntriesToRead()

virtual Long64_t KVDataAnalyser::GetTotalEntriesToRead ( ) const

inlinevirtual

Reimplemented in KVINDRAReconDataAnalyser, KVReconDataAnalyser, and KVRawDataAnalyser.

Definition at line 257 of file KVDataAnalyser.h.

◆ GetUserClass()

const UserClass& KVDataAnalyser::GetUserClass ( ) const

inline

Definition at line 202 of file KVDataAnalyser.h.

◆ GetUserClassName()

KVString KVDataAnalyser::GetUserClassName ( )

inline

Definition at line 198 of file KVDataAnalyser.h.

◆ GetUserClassOptions()

const KVString& KVDataAnalyser::GetUserClassOptions ( ) const

inline

Definition at line 358 of file KVDataAnalyser.h.

◆ GetUserIncludes()

const KVString& KVDataAnalyser::GetUserIncludes ( ) const

inline

Definition at line 281 of file KVDataAnalyser.h.

◆ GetUserLibraries()

const KVString& KVDataAnalyser::GetUserLibraries ( ) const

inline

Definition at line 285 of file KVDataAnalyser.h.

◆ IsMenus()

Bool_t KVDataAnalyser::IsMenus ( ) const

inline

Definition at line 373 of file KVDataAnalyser.h.

◆ IsQuit()

Bool_t KVDataAnalyser::IsQuit ( ) const

inline

Definition at line 381 of file KVDataAnalyser.h.

◆ IsRunningBatchAnalysis()

Bool_t KVDataAnalyser::IsRunningBatchAnalysis ( )

static

Static method KVDataAnalyser::IsRunningBatchAnalysis() Returns kTRUE if an analysis task is being performed in batch mode Returns kFALSE if no analysis task is in interactive mode, or no analysis task running

Definition at line 1281 of file KVDataAnalyser.cpp.

◆ IsSubmit()

Bool_t KVDataAnalyser::IsSubmit ( ) const

inline

Definition at line 389 of file KVDataAnalyser.h.

◆ IsUserClassValid()

Bool_t KVDataAnalyser::IsUserClassValid ( ) const

inline

Definition at line 206 of file KVDataAnalyser.h.

◆ postAnalysis()

virtual void KVDataAnalyser::postAnalysis ( )

inlinevirtual

Reimplemented in KVReconRawDataAnalyser.

Definition at line 344 of file KVDataAnalyser.h.

◆ postEndAnalysis()

virtual void KVDataAnalyser::postEndAnalysis ( )

inlinevirtual

Definition at line 348 of file KVDataAnalyser.h.

◆ postEndRun()

virtual void KVDataAnalyser::postEndRun ( )

inlinevirtual

Reimplemented in KVReconRawDataAnalyser.

Definition at line 346 of file KVDataAnalyser.h.

◆ postInitAnalysis()

virtual void KVDataAnalyser::postInitAnalysis ( )

inlinevirtual

Definition at line 340 of file KVDataAnalyser.h.

◆ postInitRun()

virtual void KVDataAnalyser::postInitRun ( )

inlinevirtual

Definition at line 342 of file KVDataAnalyser.h.

◆ preAnalysis()

virtual void KVDataAnalyser::preAnalysis ( )

inlinevirtual

Reimplemented in KVINDRAReconDataAnalyser, KVSimDirFilterAnalyser, KVReconRawDataAnalyser, KVReconDataAnalyser, and KVOnlineReconDataAnalyser.

Definition at line 343 of file KVDataAnalyser.h.

◆ preEndAnalysis()

virtual void KVDataAnalyser::preEndAnalysis ( )

inlinevirtual

Definition at line 347 of file KVDataAnalyser.h.

◆ preEndRun()

virtual void KVDataAnalyser::preEndRun ( )

inlinevirtual

Definition at line 345 of file KVDataAnalyser.h.

◆ preInitAnalysis()

virtual void KVDataAnalyser::preInitAnalysis ( )

inlinevirtual

Reimplemented in KVINDRAReconDataAnalyser, KVFAZIAReconDataAnalyser, KVFAZIARawDataAnalyser, KVSimDirFilterAnalyser, KVReconRawDataAnalyser, and KVOnlineReconDataAnalyser.

Definition at line 339 of file KVDataAnalyser.h.

◆ preInitRun()

virtual void KVDataAnalyser::preInitRun ( )

inlinevirtual

Reimplemented in KVINDRAReconDataAnalyser, KVFAZIAReconDataAnalyser, KVFAZIARawDataAnalyser, KVSimDirFilterAnalyser, KVReconRawDataAnalyser, KVReconDataAnalyser, and KVOnlineReconDataAnalyser.

Definition at line 341 of file KVDataAnalyser.h.

◆ ReadBatchEnvFile()

Bool_t KVDataAnalyser::ReadBatchEnvFile ( const TString & filename )

virtual

Read the batch env file "filename" and initialise the analysis task using the informations in the file Returns kTRUE if all goes well

Reimplemented in KVDataSetAnalyser, and KVSimDirAnalyser.

Definition at line 741 of file KVDataAnalyser.cpp.

◆ RegisterUserClass()

virtual void KVDataAnalyser::RegisterUserClass ( TObject * )

inlinevirtual

Reimplemented in KVINDRAReconDataAnalyser, KVReconDataAnalyser, KVFAZIAReconDataAnalyser, KVSimDirFilterAnalyser, and KVOnlineReconDataAnalyser.

Definition at line 352 of file KVDataAnalyser.h.

◆ Reset()

void KVDataAnalyser::Reset ( void )

virtual

Reimplemented in KVINDRAReconDataAnalyser, KVReconDataAnalyser, and KVDataSetAnalyser.

Definition at line 76 of file KVDataAnalyser.cpp.

◆ Run()

void KVDataAnalyser::Run ( )

virtual

Check all task variables, then run analyser.

Reimplemented in KVDataTransfer.

Definition at line 101 of file KVDataAnalyser.cpp.

◆ RunAnalyser()

void KVDataAnalyser::RunAnalyser ( const Char_t * uri = "" )

static

Set up and run data analysis task. This allows to choose a dataset and a data analysis task and then execute the task or submit a batch job. The behaviour of the data analyser object (base class KVDataAnalyser) can be modified by choosing a plugin class corresponding to one of the plugins defined in $KVROOT/KVFiles/.kvrootrc.

Definition at line 1250 of file KVDataAnalyser.cpp.

◆ RunMenus()

void KVDataAnalyser::RunMenus ( )

virtual

Run data analyser in menu-driven mode.

Definition at line 171 of file KVDataAnalyser.cpp.

◆ RunningInLaunchDirectory()

Bool_t KVDataAnalyser::RunningInLaunchDirectory ( )

Returns kTRUE if current working directory is same as launch directory for batch job When not in batch mode, always returns kTRUE.

Definition at line 843 of file KVDataAnalyser.cpp.

◆ SetAbortProcessingLoop()

static void KVDataAnalyser::SetAbortProcessingLoop ( Bool_t now = kTRUE )

inlinestatic

Set flag to force a clean abort of the processing loop

Definition at line 184 of file KVDataAnalyser.h.

◆ SetAnalysedTree()

virtual void KVDataAnalyser::SetAnalysedTree ( TTree * )

inlinevirtual

Reimplemented in KVINDRAReconDataAnalyser, and KVReconDataAnalyser.

Definition at line 420 of file KVDataAnalyser.h.

◆ SetAnalysisTask()

void KVDataAnalyser::SetAnalysisTask ( KVDataAnalysisTask * at )

Set analysis task and data type For ways of obtaining pointers to data analysis tasks for any given dataset, see method KVDataSet::GetAnalysisTask(const Char_t* keywords) const.

Definition at line 260 of file KVDataAnalyser.cpp.

◆ SetAuxFileList()

virtual void KVDataAnalyser::SetAuxFileList ( const KVUnownedList & )

inlinevirtual

Reimplemented in KVSimDirAnalyser.

Definition at line 293 of file KVDataAnalyser.h.

◆ SetBatchMode()

void KVDataAnalyser::SetBatchMode ( Bool_t on = kTRUE )

inline

Definition at line 224 of file KVDataAnalyser.h.

◆ SetBatchName()

void KVDataAnalyser::SetBatchName ( const Char_t * batchname )

inline

Definition at line 232 of file KVDataAnalyser.h.

◆ SetBatchSystem()

void KVDataAnalyser::SetBatchSystem ( KVBatchSystem * bs )

inline

Definition at line 240 of file KVDataAnalyser.h.

◆ SetDataType()

void KVDataAnalyser::SetDataType ( const Char_t * name )

inline

Definition at line 311 of file KVDataAnalyser.h.

◆ SetFileList()

virtual void KVDataAnalyser::SetFileList ( const KVUnownedList & )

inlinevirtual

Reimplemented in KVSimDirAnalyser.

Definition at line 289 of file KVDataAnalyser.h.

◆ SetMenus()

void KVDataAnalyser::SetMenus ( Bool_t on = kTRUE )

inline

Definition at line 369 of file KVDataAnalyser.h.

◆ SetNbEventToRead()

void KVDataAnalyser::SetNbEventToRead ( Long64_t nb = 0 )

inline

Definition at line 298 of file KVDataAnalyser.h.

◆ SetParent()

void KVDataAnalyser::SetParent ( KVDataAnalyser * da )

inline

Definition at line 321 of file KVDataAnalyser.h.

◆ SetProofMode()

void KVDataAnalyser::SetProofMode ( EProofMode e )

inline

Definition at line 175 of file KVDataAnalyser.h.

◆ SetQuit()

void KVDataAnalyser::SetQuit ( Bool_t yes = kTRUE )

inline

Definition at line 377 of file KVDataAnalyser.h.

◆ SetStatusUpdateInterval()

void KVDataAnalyser::SetStatusUpdateInterval ( double t )

inline

Definition at line 262 of file KVDataAnalyser.h.

◆ SetSubmit()

void KVDataAnalyser::SetSubmit ( Bool_t yes = kTRUE )

inline

Definition at line 385 of file KVDataAnalyser.h.

◆ SetTriggerConditionsForRun()

virtual void KVDataAnalyser::SetTriggerConditionsForRun ( int )

inlinevirtual

Reimplemented in KVINDRAReconDataAnalyser, KVReconDataAnalyser, and KVSimDirFilterAnalyser.

Definition at line 418 of file KVDataAnalyser.h.

◆ SetUserClass()

void KVDataAnalyser::SetUserClass	(	const UserClass &	kvs,
		Bool_t	check = `kTRUE`
	)

Set name of user analysis class. If check=kTRUE (default), we check the validity of the class if check=kFALSE we do not check and assume that the class is valid

Definition at line 662 of file KVDataAnalyser.cpp.

◆ SetUserClassOptions()

void KVDataAnalyser::SetUserClassOptions ( const Char_t * o = "" )

inline

Definition at line 354 of file KVDataAnalyser.h.

◆ SetUserIncludes()

void KVDataAnalyser::SetUserIncludes ( const Char_t * incDirs = 0 )

Add to the includes paths the user's includes paths the includes paths have to be separated by a white space

Definition at line 279 of file KVDataAnalyser.cpp.

◆ SetUserLibraries()

void KVDataAnalyser::SetUserLibraries ( const Char_t * libs = 0 )

Load the user's libraries the libraries have to be separated by a white space

Definition at line 316 of file KVDataAnalyser.cpp.

◆ SubmitTask()

void KVDataAnalyser::SubmitTask ( )

virtual

In interactive mode, the data analysis task is performed by instanciating and initialising the KVDataAnalyser child class specified by the task, and then calling its Run() method.

In batch mode, the job is submitted to the chosen batch system.

Reimplemented in KVINDRAReconDataAnalyser, KVINDRAGeneDataAnalyser, KVINDRADSTReader, KVFAZIAReconDataAnalyser, KVFAZIARawDataAnalyser, KVReconDataAnalyser, KVRawDataAnalyser, KVOnlineReconDataAnalyser, KVSimDirAnalyser, and KVINDRADstToRootTransfert.

Definition at line 875 of file KVDataAnalyser.cpp.

◆ UpdateBatchStatusFile()

void KVDataAnalyser::UpdateBatchStatusFile	(	Int_t	totev,
		Int_t	evread,
		TString	disk
	)		const

Update infos in batch status file.

Definition at line 1022 of file KVDataAnalyser.cpp.

◆ UseBaseClassSubmitTask()

void KVDataAnalyser::UseBaseClassSubmitTask ( )

inline

Definition at line 399 of file KVDataAnalyser.h.

◆ WriteBatchEnvFile()

void KVDataAnalyser::WriteBatchEnvFile	(	const TString &	jobname,
		Bool_t	save = `kTRUE`
	)

virtual

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 in KVDataSetAnalyser, KVOnlineReconDataAnalyser, KVINDRAReconDataAnalyser, and KVSimDirAnalyser.

Definition at line 686 of file KVDataAnalyser.cpp.

◆ WriteBatchInfo()

void KVDataAnalyser::WriteBatchInfo ( TTree * tt )

Store lots of useful information about the current version of KaliVeda, ROOT, etc. etc. in a TEnv object which will be added to the TTree's list of user infos (TTree::GetUserInfo).

Definition at line 1191 of file KVDataAnalyser.cpp.

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ EProofMode

Constructor & Destructor Documentation

◆ KVDataAnalyser()

◆ ~KVDataAnalyser()

Member Function Documentation

◆ AbortProcessingLoop()

◆ AddJobDescriptionList()

◆ BatchMode()

◆ CheckStatusUpdateInterval()

◆ CheckTaskVariables()

◆ ChooseNbEventToRead()

◆ ChooseRunningMode()

◆ ChooseUserClass()

◆ DeleteBatchStatusFile()

◆ DoStatusUpdate()

◆ DoUserClassFilesExist()

◆ ExpandAutoBatchName()

◆ GetAnalysedRun()

◆ GetAnalysedSystem()

◆ GetAnalysedTree()

◆ GetAnalyser()

◆ GetAnalyserClassNameForBatchJob()

◆ GetAnalysisTask()

◆ GetBatchName()

◆ GetBatchStatusFileName()

◆ GetBatchSystem()

◆ GetDataType()

◆ GetKinematics()

◆ GetLaunchDirectory()

◆ GetNbEventToRead()

◆ GetNumberOfFilesToAnalyse()

◆ GetParent()

◆ GetPathToFileInLaunchDirectory()

◆ GetProofMode()

◆ GetRecognisedAutoBatchNameKeywords()

◆ GetRootDirectoryOfDataToAnalyse()

◆ GetStatusUpdateInterval()

◆ GetTotalEntriesToRead()

◆ GetUserClass()

◆ GetUserClassName()

◆ GetUserClassOptions()

◆ GetUserIncludes()

◆ GetUserLibraries()

◆ IsMenus()

◆ IsQuit()

◆ IsRunningBatchAnalysis()

◆ IsSubmit()

◆ IsUserClassValid()

◆ postAnalysis()

◆ postEndAnalysis()

◆ postEndRun()

◆ postInitAnalysis()

◆ postInitRun()

◆ preAnalysis()

◆ preEndAnalysis()

◆ preEndRun()

◆ preInitAnalysis()

◆ preInitRun()

◆ ReadBatchEnvFile()

◆ RegisterUserClass()

◆ Reset()

◆ Run()

◆ RunAnalyser()

◆ RunMenus()

◆ RunningInLaunchDirectory()

◆ SetAbortProcessingLoop()

◆ SetAnalysedTree()

◆ SetAnalysisTask()

◆ SetAuxFileList()

◆ SetBatchMode()

◆ SetBatchName()

◆ SetBatchSystem()

◆ SetDataType()