Class piloting analyses of simulated data.

Created by KVClassFactory on Tue Feb 14 11:13:53 2017 Author: John Frankland,,,

Definition at line 18 of file KVSimDirAnalyser.h.

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

virtual	~KVSimDirAnalyser ()
	Destructor. More...

TString	ExpandAutoBatchName (const Char_t *format) const
	Replace any special symbols in auto-format jobname with current values. More...

TTree *	GetAnalysedTree () const

TList *	GetFileList () const

Int_t	GetNumberOfFilesToAnalyse () const

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

Bool_t	IsCopyFilesToWorkDir () const

Bool_t	ReadBatchEnvFile (const Char_t *)

void	SetAuxFileList (TList *l)

void	SetCopyFilesToWorkDir (Bool_t on=kTRUE)

void	SetDataSetForFilter (const TString &f)

void	SetFileList (TList *l)

void	SetSystemForFilter (const TString &f)

void	SubmitTask ()
	Set up and run the analysis. More...

void	WriteBatchEnvFile (const Char_t *, Bool_t sav=kTRUE)

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

virtual	~ KVDataAnalyser ()

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 KVDBRun *	GetAnalysedRun () const

virtual KVDBSystem *	GetAnalysedSystem () 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

virtual const KV2Body *	GetKinematics () const

const Char_t *	GetLaunchDirectory () const

Long64_t	GetNbEventToRead (void) const

KVDataAnalyser *	GetParent () const

TString	GetPathToFileInLaunchDirectory (const TString &) const

EProofMode	GetProofMode () const

virtual const Char_t *	GetRecognisedAutoBatchNameKeywords () 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	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)

void	SetBatchMode (Bool_t on=kTRUE)

void	SetBatchName (const Char_t *batchname)

void	SetBatchSystem (KVBatchSystem *bs)

void	SetDataType (const Char_t *name)

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)

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

Static Public Member Functions
static void	Make (const Char_t *kvsname="MySimulatedAnalysis")
	Generate a new simulated analysis selector class. More...

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)

Protected Member Functions
void	BuildChain ()

void	GetInfosForJobNameFromFiles ()

virtual Bool_t	NeedToChooseWhatToAnalyse () const

Protected Member Functions inherited from KVDataAnalyser
virtual Bool_t	CheckIfUserClassIsValid (const KVString &alternative_base_class="")

virtual Bool_t	CheckWhatToAnalyseAndHow ()

virtual void	ChooseWhatToAnalyse ()
	TO IMPLEMENT ? More...

virtual void	ChooseWhatToDo ()
	TO IMPLEMENT ? More...

void	CopyAnalysisResultsToLaunchDirectory ()

const Char_t *	GetACliCMode ()

TEnv *	GetBatchInfoFile () const

TObject *	GetInstanceOfUserClass (const KVString &alternative_base_class="")

virtual Bool_t	NeedToChooseWhatToDo () const

virtual void	PostRunReset ()

virtual Bool_t	PreSubmitCheck ()

void	ScanWorkingDirectory (TList **)

virtual void	set_up_analyser_for_task (KVDataAnalyser *the_analyser)

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const

void	MakeZombie ()

Private Member Functions
void	DeleteAuxFilesListIfOurs ()

void	DeleteSimFilesListIfOurs ()

Private Attributes
TChain *	fAnalysisChain
	TChain for analysis. More...

Bool_t	fCopyFilesToWorkDir
	if true, files to be analysed are copied to working directory first More...

TString	fFilterDataSet
	name of dataset to be used for filtering the simulation More...

TString	fFilterSystem
	name of system to be used for filtering the simulation More...

TList *	fListOfAuxFiles
	[optional] list of original simulated data to be used during filtered data analysis More...

TList *	fListOfSimFiles
	list of files/trees to analyse More...

TString	fModel
	name of model used for simulation More...

KVSimDir *	fSimDir
	used for batch analysis More...

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

Public Types inherited from TObject
enum	EDeprecatedStatusBits

enum	EStatusBits

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 <KVSimDirAnalyser.h>

Inheritance diagram for KVSimDirAnalyser:

[legend]

Constructor & Destructor Documentation

◆ KVSimDirAnalyser()

KVSimDirAnalyser::KVSimDirAnalyser ( )

Default constructor.

Definition at line 18 of file KVSimDirAnalyser.cpp.

◆ ~KVSimDirAnalyser()

KVSimDirAnalyser::~KVSimDirAnalyser ( )

virtual

Destructor.

Definition at line 50 of file KVSimDirAnalyser.cpp.

Member Function Documentation

◆ BuildChain()

void KVSimDirAnalyser::BuildChain ( )

protected

Build a TChain with all files/trees to be analysed

If fCopyFilesToWorkDir==true, files are first copied to working directory

Definition at line 249 of file KVSimDirAnalyser.cpp.

◆ DeleteAuxFilesListIfOurs()

void KVSimDirAnalyser::DeleteAuxFilesListIfOurs ( )

private

Definition at line 39 of file KVSimDirAnalyser.cpp.

◆ DeleteSimFilesListIfOurs()

void KVSimDirAnalyser::DeleteSimFilesListIfOurs ( )

private

Definition at line 29 of file KVSimDirAnalyser.cpp.

◆ ExpandAutoBatchName()

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

virtual

Replace any special symbols in auto-format jobname with current values.

Reimplemented from KVDataAnalyser.

Definition at line 326 of file KVSimDirAnalyser.cpp.

◆ GetAnalysedTree()

TTree* KVSimDirAnalyser::GetAnalysedTree ( ) const

inlinevirtual

Reimplemented from KVDataAnalyser.

Definition at line 89 of file KVSimDirAnalyser.h.

◆ GetFileList()

TList* KVSimDirAnalyser::GetFileList ( ) const

inline

Definition at line 55 of file KVSimDirAnalyser.h.

◆ GetInfosForJobNameFromFiles()

void KVSimDirAnalyser::GetInfosForJobNameFromFiles ( )

protected

Use first file in list to analyse to obtain information for generating automatic batch job names (name of model, eventually info on simulated reaction, etc.)

Definition at line 286 of file KVSimDirAnalyser.cpp.

◆ GetNumberOfFilesToAnalyse()

Int_t KVSimDirAnalyser::GetNumberOfFilesToAnalyse ( ) const

inlinevirtual

Reimplemented from KVDataAnalyser.

Definition at line 59 of file KVSimDirAnalyser.h.

◆ GetRootDirectoryOfDataToAnalyse()

KVString KVSimDirAnalyser::GetRootDirectoryOfDataToAnalyse ( ) const

virtual

Returns path to data to be analysed.

Reimplemented from KVDataAnalyser.

Definition at line 134 of file KVSimDirAnalyser.cpp.

◆ IsCopyFilesToWorkDir()

Bool_t KVSimDirAnalyser::IsCopyFilesToWorkDir ( ) const

inline

Definition at line 76 of file KVSimDirAnalyser.h.

◆ Make()

void KVSimDirAnalyser::Make ( const Char_t * kvsname = "MySimulatedAnalysis" )

static

Generate a new simulated analysis selector class.

Definition at line 304 of file KVSimDirAnalyser.cpp.

◆ NeedToChooseWhatToAnalyse()

virtual Bool_t KVSimDirAnalyser::NeedToChooseWhatToAnalyse ( ) const

inlineprotectedvirtual

Reimplemented from KVDataAnalyser.

Definition at line 36 of file KVSimDirAnalyser.h.

◆ ReadBatchEnvFile()

Bool_t KVSimDirAnalyser::ReadBatchEnvFile ( const Char_t * 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 from KVDataAnalyser.

Definition at line 190 of file KVSimDirAnalyser.cpp.

◆ SetAuxFileList()

void KVSimDirAnalyser::SetAuxFileList ( TList * l )

inlinevirtual

Reimplemented from KVDataAnalyser.

Definition at line 51 of file KVSimDirAnalyser.h.

◆ SetCopyFilesToWorkDir()

void KVSimDirAnalyser::SetCopyFilesToWorkDir ( Bool_t on = kTRUE )

inline

Definition at line 72 of file KVSimDirAnalyser.h.

◆ SetDataSetForFilter()

void KVSimDirAnalyser::SetDataSetForFilter ( const TString & f )

inline

Definition at line 81 of file KVSimDirAnalyser.h.

◆ SetFileList()

void KVSimDirAnalyser::SetFileList ( TList * l )

inlinevirtual

Reimplemented from KVDataAnalyser.

Definition at line 46 of file KVSimDirAnalyser.h.

◆ SetSystemForFilter()

void KVSimDirAnalyser::SetSystemForFilter ( const TString & f )

inline

Definition at line 85 of file KVSimDirAnalyser.h.

◆ SubmitTask()

void KVSimDirAnalyser::SubmitTask ( )

virtual

Set up and run the analysis.

Reimplemented from KVDataAnalyser.

Definition at line 63 of file KVSimDirAnalyser.cpp.

◆ WriteBatchEnvFile()

void KVSimDirAnalyser::WriteBatchEnvFile	(	const Char_t *	jobname,
		Bool_t	sav = `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 from KVDataAnalyser.

Definition at line 152 of file KVSimDirAnalyser.cpp.

Member Data Documentation

◆ fAnalysisChain

TChain* KVSimDirAnalyser::fAnalysisChain

private

TChain for analysis.

Definition at line 22 of file KVSimDirAnalyser.h.

◆ fCopyFilesToWorkDir

Bool_t KVSimDirAnalyser::fCopyFilesToWorkDir

private

if true, files to be analysed are copied to working directory first

Definition at line 24 of file KVSimDirAnalyser.h.

◆ fFilterDataSet

TString KVSimDirAnalyser::fFilterDataSet

private

name of dataset to be used for filtering the simulation

Definition at line 28 of file KVSimDirAnalyser.h.

◆ fFilterSystem

TString KVSimDirAnalyser::fFilterSystem

private

name of system to be used for filtering the simulation

Definition at line 27 of file KVSimDirAnalyser.h.

◆ fListOfAuxFiles

TList* KVSimDirAnalyser::fListOfAuxFiles

private

[optional] list of original simulated data to be used during filtered data analysis

Definition at line 21 of file KVSimDirAnalyser.h.

◆ fListOfSimFiles

TList* KVSimDirAnalyser::fListOfSimFiles

private

list of files/trees to analyse

Definition at line 20 of file KVSimDirAnalyser.h.

◆ fModel

TString KVSimDirAnalyser::fModel

private

name of model used for simulation

Definition at line 26 of file KVSimDirAnalyser.h.

◆ fSimDir

KVSimDir* KVSimDirAnalyser::fSimDir

private

used for batch analysis

Definition at line 23 of file KVSimDirAnalyser.h.

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

kaliveda.doxygen/KVMultiDet/analysis/KVSimDirAnalyser.h
kaliveda.doxygen/KVMultiDet/analysis/KVSimDirAnalyser.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVSimDirAnalyser()

◆ ~KVSimDirAnalyser()

Member Function Documentation

◆ BuildChain()

◆ DeleteAuxFilesListIfOurs()

◆ DeleteSimFilesListIfOurs()

◆ ExpandAutoBatchName()

◆ GetAnalysedTree()

◆ GetFileList()

◆ GetInfosForJobNameFromFiles()

◆ GetNumberOfFilesToAnalyse()

◆ GetRootDirectoryOfDataToAnalyse()

◆ IsCopyFilesToWorkDir()

◆ Make()

◆ NeedToChooseWhatToAnalyse()

◆ ReadBatchEnvFile()

◆ SetAuxFileList()

◆ SetCopyFilesToWorkDir()

◆ SetDataSetForFilter()

◆ SetFileList()

◆ SetSystemForFilter()

◆ SubmitTask()

◆ WriteBatchEnvFile()

Member Data Documentation

◆ fAnalysisChain

◆ fCopyFilesToWorkDir

◆ fFilterDataSet

◆ fFilterSystem

◆ fListOfAuxFiles

◆ fListOfSimFiles

◆ fModel

◆ fSimDir