Detailed Description

Pilots user analysis of experimental data.

Created by KVClassFactory on Tue Feb 14 12:32:06 2017 Author: John Frankland,,,

Definition at line 17 of file KVDataSetAnalyser.h.

#include <KVDataSetAnalyser.h>

Inheritance diagram for KVDataSetAnalyser:

[legend]

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

virtual	~KVDataSetAnalyser ()
	Destructor. More...

void	AddJobDescriptionList (TList *) override

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 override

KVDBRun *	GetAnalysedRun () const override

KVDBRunFile *	GetAnalysedRunFile () const override

KVDBSystem *	GetAnalysedSystem () const override

TString	GetAnalyserClassNameForBatchJob () override

const KVDataSet *	GetDataSet () const

const run_index_list &	GetFullRunList () const

const KV2Body *	GetKinematics () const override

Int_t	GetNumberOfFilesToAnalyse () const override

const Char_t *	GetRecognisedAutoBatchNameKeywords () const override

KVString	GetRootDirectoryOfDataToAnalyse () const override
	Returns path to data to be analysed. More...

const run_index_list &	GetRunList () const

const KVDBSystem *	GetSystem () const

Bool_t	IsChooseDataSet () const

Bool_t	IsChooseRuns () const

Bool_t	IsChooseSystem () const

Bool_t	IsChooseTask () const

Bool_t	ReadBatchEnvFile (const TString &filename) override

void	Reset () override

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 run_index_list &nl)

void	SetRuns (const run_index_list &nl, Bool_t check=kTRUE)

void	SetSystem (KVDBSystem *syst)
	Set the System used in the analysis. More...

TString	SystemBatchName () const

void	WriteBatchEnvFile (const TString &jobname, Bool_t save=kTRUE) override

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

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

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 TTree *	GetAnalysedTree () const

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

TString	GetPathToFileInLaunchDirectory (const TString &) const

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

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

void	WriteBatchInfo (TTree *)

Additional Inherited Members
Public Types inherited from KVDataAnalyser
enum	EProofMode { None , Lite , Proof }

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)

Constructor & Destructor Documentation

◆ KVDataSetAnalyser()

KVDataSetAnalyser::KVDataSetAnalyser ( )

Default constructor.

Definition at line 22 of file KVDataSetAnalyser.cpp.

◆ ~KVDataSetAnalyser()

KVDataSetAnalyser::~KVDataSetAnalyser ( )

virtual

Destructor.

Definition at line 40 of file KVDataSetAnalyser.cpp.

Member Function Documentation

◆ AddJobDescriptionList()

void KVDataSetAnalyser::AddJobDescriptionList ( TList * l )

overridevirtual

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 849 of file KVDataSetAnalyser.cpp.

◆ ChooseAnalysisTask()

void KVDataSetAnalyser::ChooseAnalysisTask ( )

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

Enter 'c1', 'c2', etc. to generate a new user analysis class for task '1', '2', etc. not possible in batch mode

Definition at line 246 of file KVDataSetAnalyser.cpp.

◆ ChooseDataSet()

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 142 of file KVDataSetAnalyser.cpp.

◆ ChooseDataType()

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 200 of file KVDataSetAnalyser.cpp.

◆ ChooseRuns()

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 431 of file KVDataSetAnalyser.cpp.

◆ ChooseSystem()

void KVDataSetAnalyser::ChooseSystem ( const Char_t * data_type = "" )

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.

◆ ClearRunList()

void KVDataSetAnalyser::ClearRunList ( )

inline

Definition at line 110 of file KVDataSetAnalyser.h.

◆ ExpandAutoBatchName()

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

overridevirtual

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

$System : name of system to be analysed

Reimplemented from KVDataAnalyser.

Definition at line 805 of file KVDataSetAnalyser.cpp.

◆ GetAnalysedRun()

KVDBRun* KVDataSetAnalyser::GetAnalysedRun ( ) const

inlineoverridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 158 of file KVDataSetAnalyser.h.

◆ GetAnalysedRunFile()

KVDBRunFile* KVDataSetAnalyser::GetAnalysedRunFile ( ) const

inlineoverridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 162 of file KVDataSetAnalyser.h.

◆ GetAnalysedSystem()

KVDBSystem* KVDataSetAnalyser::GetAnalysedSystem ( ) const

inlineoverridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 154 of file KVDataSetAnalyser.h.

◆ GetAnalyserClassNameForBatchJob()

TString KVDataSetAnalyser::GetAnalyserClassNameForBatchJob ( )

inlineoverridevirtual

value used to set KVANALYSER shell variable used for setting up & running batch jobs

Returns: name of KVDataAnalyser plugin to use. For all analysers derived from KVDataSetAnalyser, it is "DataSetAnalyser"

Reimplemented from KVDataAnalyser.

Definition at line 166 of file KVDataSetAnalyser.h.

◆ GetDataSet()

const KVDataSet* KVDataSetAnalyser::GetDataSet ( ) const

inline

Definition at line 91 of file KVDataSetAnalyser.h.

◆ GetFullRunList()

const run_index_list& KVDataSetAnalyser::GetFullRunList ( ) const

inline

Definition at line 87 of file KVDataSetAnalyser.h.

◆ GetKinematics()

const KV2Body * KVDataSetAnalyser::GetKinematics ( ) const

overridevirtual

Returns: pointer to KV2Body object describing kinematics of analysed system if defined

Reimplemented from KVDataAnalyser.

Definition at line 832 of file KVDataSetAnalyser.cpp.

◆ GetNumberOfFilesToAnalyse()

Int_t KVDataSetAnalyser::GetNumberOfFilesToAnalyse ( ) const

inlineoverridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 83 of file KVDataSetAnalyser.h.

◆ GetRecognisedAutoBatchNameKeywords()

const Char_t * KVDataSetAnalyser::GetRecognisedAutoBatchNameKeywords ( ) const

overridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 820 of file KVDataSetAnalyser.cpp.

◆ GetRootDirectoryOfDataToAnalyse()

KVString KVDataSetAnalyser::GetRootDirectoryOfDataToAnalyse ( ) const

overridevirtual

Returns path to data to be analysed.

Reimplemented from KVDataAnalyser.

Definition at line 869 of file KVDataSetAnalyser.cpp.

◆ GetRunList()

const run_index_list& KVDataSetAnalyser::GetRunList ( ) const

inline

Definition at line 79 of file KVDataSetAnalyser.h.

◆ GetSystem()

const KVDBSystem* KVDataSetAnalyser::GetSystem ( ) const

inline

Definition at line 75 of file KVDataSetAnalyser.h.

◆ IsChooseDataSet()

Bool_t KVDataSetAnalyser::IsChooseDataSet ( ) const

inline

Definition at line 118 of file KVDataSetAnalyser.h.

◆ IsChooseRuns()

Bool_t KVDataSetAnalyser::IsChooseRuns ( ) const

inline

Definition at line 142 of file KVDataSetAnalyser.h.

◆ IsChooseSystem()

Bool_t KVDataSetAnalyser::IsChooseSystem ( ) const

inline

Definition at line 134 of file KVDataSetAnalyser.h.

◆ IsChooseTask()

Bool_t KVDataSetAnalyser::IsChooseTask ( ) const

inline

Definition at line 126 of file KVDataSetAnalyser.h.

◆ ReadBatchEnvFile()

Bool_t KVDataSetAnalyser::ReadBatchEnvFile ( const TString & filename )

overridevirtual

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 702 of file KVDataSetAnalyser.cpp.

◆ Reset()

void KVDataSetAnalyser::Reset ( )

overridevirtual

Reimplemented from KVDataAnalyser.

Reimplemented in KVINDRAReconDataAnalyser, and KVReconDataAnalyser.

Definition at line 50 of file KVDataSetAnalyser.cpp.

◆ SetChooseDataSet()

void KVDataSetAnalyser::SetChooseDataSet ( Bool_t yes = kTRUE )

inline

Definition at line 114 of file KVDataSetAnalyser.h.

◆ SetChooseRuns()

void KVDataSetAnalyser::SetChooseRuns ( Bool_t yes = kTRUE )

inline

Definition at line 138 of file KVDataSetAnalyser.h.

◆ SetChooseSystem()

void KVDataSetAnalyser::SetChooseSystem ( Bool_t yes = kTRUE )

inline

Definition at line 130 of file KVDataSetAnalyser.h.

◆ SetChooseTask()

void KVDataSetAnalyser::SetChooseTask ( Bool_t yes = kTRUE )

inline

Definition at line 122 of file KVDataSetAnalyser.h.

◆ SetDataSet() [1/2]

void KVDataSetAnalyser::SetDataSet ( const Char_t * name )

inline

Definition at line 99 of file KVDataSetAnalyser.h.

◆ SetDataSet() [2/2]

void KVDataSetAnalyser::SetDataSet ( KVDataSet * ds )

inline

Definition at line 95 of file KVDataSetAnalyser.h.

◆ SetFullRunList()

void KVDataSetAnalyser::SetFullRunList ( const run_index_list & nl )

inline

Definition at line 105 of file KVDataSetAnalyser.h.

◆ SetRuns()

void KVDataSetAnalyser::SetRuns	(	const run_index_list &	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 633 of file KVDataSetAnalyser.cpp.

◆ SetSystem()

void KVDataSetAnalyser::SetSystem ( KVDBSystem * syst )

Set the System used in the analysis.

Definition at line 618 of file KVDataSetAnalyser.cpp.

◆ SystemBatchName()

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 786 of file KVDataSetAnalyser.cpp.

◆ WriteBatchEnvFile()

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

overridevirtual

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 KVINDRAReconDataAnalyser.

Definition at line 678 of file KVDataSetAnalyser.cpp.

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVDataSetAnalyser()

◆ ~KVDataSetAnalyser()

Member Function Documentation

◆ AddJobDescriptionList()

◆ ChooseAnalysisTask()

◆ ChooseDataSet()

◆ ChooseDataType()

◆ ChooseRuns()

◆ ChooseSystem()

◆ ClearRunList()

◆ ExpandAutoBatchName()

◆ GetAnalysedRun()

◆ GetAnalysedRunFile()

◆ GetAnalysedSystem()

◆ GetAnalyserClassNameForBatchJob()

◆ GetDataSet()

◆ GetFullRunList()

◆ GetKinematics()

◆ GetNumberOfFilesToAnalyse()

◆ GetRecognisedAutoBatchNameKeywords()

◆ GetRootDirectoryOfDataToAnalyse()

◆ GetRunList()

◆ GetSystem()

◆ IsChooseDataSet()

◆ IsChooseRuns()

◆ IsChooseSystem()

◆ IsChooseTask()

◆ ReadBatchEnvFile()

◆ Reset()

◆ SetChooseDataSet()

◆ SetChooseRuns()

◆ SetChooseSystem()

◆ SetChooseTask()

◆ SetDataSet() [1/2]

◆ SetDataSet() [2/2]

◆ SetFullRunList()

◆ SetRuns()

◆ SetSystem()

◆ SystemBatchName()

◆ WriteBatchEnvFile()