Detailed Description

Abstract base class for user analysis of raw data.

Examples: ExampleRawAnalysis.cpp.

Definition at line 27 of file KVRawDataAnalyser.h.

#include <KVRawDataAnalyser.h>

Inheritance diagram for KVRawDataAnalyser:

[legend]

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

virtual	~KVRawDataAnalyser ()
	Destructor. More...

void	AddHisto (TH1 *histo)

void	AddTree (TTree *tree)

virtual Bool_t	Analysis ()=0

void	CalculateTotalEventsToRead ()
	loop over runs and calculate total events More...

Bool_t	CreateTreeFile (const Char_t *filename="")

virtual void	EndAnalysis ()=0

virtual void	EndRun ()=0

void	FillHisto (const Char_t sname, const Char_t label, Double_t weight=1)
	Fill 1D histogram with named bins. More...

void	FillHisto (const Char_t *sname, Double_t one, Double_t two=1, Double_t three=1, Double_t four=1)

void	FillTree (const Char_t *sname="")

KVDBRun *	GetCurrentRun () const

KVDetectorEvent *	GetDetectorEvent () const

Long64_t	GetEventNumber () const

TH1 *	GetHisto (const Char_t *name) const

const KVHashList *	GetHistoList () const

TString	GetOpt (const Char_t *option) const

const KVRawDataReader &	GetRunFileReader () const

Int_t	GetRunNumber () const

Long64_t	GetTotalEntriesToRead () const

TTree *	GetTree (const Char_t *name) const

const KVHashList *	GetTreeList () const

virtual void	InitAnalysis ()=0

virtual void	InitRun ()=0

Bool_t	IsOptGiven (const Char_t *option)

virtual void	SaveHistos (const Char_t filename="", Option_t option="recreate", Bool_t onlyfilled=kFALSE)

void	SetJobOutputFileName (const TString &filename)

void	SetOpt (const Char_t option, const Char_t value)

void	SubmitTask ()

void	UnsetOpt (const Char_t *opt)

Public Member Functions inherited from KVDataSetAnalyser
	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

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 TString &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...

TString	SystemBatchName () const

void	WriteBatchEnvFile (const TString &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 ()

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

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

virtual void	SetAnalysedTree (TTree *)

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)

void	UpdateBatchStatusFile (Int_t totev, Int_t evread, TString disk) const
	Update infos in batch status file. More...

void	UseBaseClassSubmitTask ()

void	WriteBatchInfo (TTree *)

Static Public Member Functions
static void	Make (const Char_t *kvsname="MyOwnRawDataAnalyser")
	Automatic generation of derived class for raw data analysis. 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)

Private Member Functions
void	AbortDuringRunProcessing ()
	Method called to abort analysis during processing of a run. More...

void	FillTH1 (TH1 *h1, Double_t one, Double_t two)

void	FillTH2 (TH2 *h2, Double_t one, Double_t two, Double_t three)

void	FillTH3 (TH3 *h3, Double_t one, Double_t two, Double_t three, Double_t four)

void	FillTProfile (TProfile *h1, Double_t one, Double_t two, Double_t three)

void	FillTProfile2D (TProfile2D *h2, Double_t one, Double_t two, Double_t three, Double_t four)

void	ProcessRun ()

void	SetCombinedOutputFile (const KVString &filename)

Private Attributes
KVString	fCombinedOutputFile
	optional name for single results file with trees and histos More...

KVDBRun *	fCurrentRun
	poiner to current run More...

Long64_t	fEventNumber
	event number in current run More...

KVHashList	fHistoList
	list of histograms of user analysis More...

KVUserAnalysisOptionList	fOptionList
	list of options set by user for analysis More...

KVRawDataReader *	fRunFile
	currently analysed run file More...

Int_t	fRunNumber
	run number of current file More...

KVRawDataPatchList	fRustines

TFile *	fTreeFile

KVHashList	fTreeList
	list of trees of user analysis More...

Long64_t	TotalEntriesToRead

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

Constructor & Destructor Documentation

◆ KVRawDataAnalyser()

KVRawDataAnalyser::KVRawDataAnalyser ( )

Default constructor.

Definition at line 21 of file KVRawDataAnalyser.cpp.

◆ ~KVRawDataAnalyser()

KVRawDataAnalyser::~KVRawDataAnalyser ( )

virtual

Destructor.

Definition at line 34 of file KVRawDataAnalyser.cpp.

Member Function Documentation

◆ AbortDuringRunProcessing()

void KVRawDataAnalyser::AbortDuringRunProcessing ( )

private

Method called to abort analysis during processing of a run.

Definition at line 477 of file KVRawDataAnalyser.cpp.

◆ AddHisto()

void KVRawDataAnalyser::AddHisto ( TH1 * histo )

inline

Definition at line 129 of file KVRawDataAnalyser.h.

◆ AddTree()

void KVRawDataAnalyser::AddTree ( TTree * tree )

Add a user analysis results TTree to list which will be automatically written to disk at end of analysis. User must call CreateTreeFile(const Char_t*) before calling this method

Definition at line 264 of file KVRawDataAnalyser.cpp.

◆ Analysis()

virtual Bool_t KVRawDataAnalyser::Analysis ( )

pure virtual

Implemented in KVRawDataReconstructor.

Examples: ExampleRawAnalysis.cpp, and ExampleReconRawAnalysis.cpp.

◆ CalculateTotalEventsToRead()

void KVRawDataAnalyser::CalculateTotalEventsToRead ( )

loop over runs and calculate total events

Definition at line 246 of file KVRawDataAnalyser.cpp.

◆ CreateTreeFile()

Bool_t KVRawDataAnalyser::CreateTreeFile ( const Char_t * filename = "" )

This method must be called before creating any user TTree in InitAnalysis(). If no filename is given, default name="TreeFileFrom[name of analysis class].root"

Definition at line 437 of file KVRawDataAnalyser.cpp.

◆ EndAnalysis()

virtual void KVRawDataAnalyser::EndAnalysis ( )

pure virtual

Implemented in KVRawDataReconstructor.

Examples: ExampleRawAnalysis.cpp, and ExampleReconRawAnalysis.cpp.

◆ EndRun()

virtual void KVRawDataAnalyser::EndRun ( )

pure virtual

Implemented in KVRawDataReconstructor.

Examples: ExampleRawAnalysis.cpp, and ExampleReconRawAnalysis.cpp.

◆ FillHisto() [1/2]

void KVRawDataAnalyser::FillHisto	(	const Char_t *	sname,
		const Char_t *	label,
		Double_t	weight = `1`
	)

Fill 1D histogram with named bins.

Definition at line 319 of file KVRawDataAnalyser.cpp.

◆ FillHisto() [2/2]

void KVRawDataAnalyser::FillHisto	(	const Char_t *	histo_name,
		Double_t	one,
		Double_t	two = `1`,
		Double_t	three = `1`,
		Double_t	four = `1`
	)

Find in the list, if there is an histogram named "histo_name" If not print an error message If yes redirect to the right method according to its closest mother class to fill it

Definition at line 287 of file KVRawDataAnalyser.cpp.

◆ FillTH1()

void KVRawDataAnalyser::FillTH1	(	TH1 *	h1,
		Double_t	one,
		Double_t	two
	)

inlineprivate

Definition at line 49 of file KVRawDataAnalyser.h.

◆ FillTH2()

void KVRawDataAnalyser::FillTH2	(	TH2 *	h2,
		Double_t	one,
		Double_t	two,
		Double_t	three
	)

inlineprivate

Definition at line 57 of file KVRawDataAnalyser.h.

◆ FillTH3()

void KVRawDataAnalyser::FillTH3	(	TH3 *	h3,
		Double_t	one,
		Double_t	two,
		Double_t	three,
		Double_t	four
	)

inlineprivate

Definition at line 65 of file KVRawDataAnalyser.h.

◆ FillTProfile()

void KVRawDataAnalyser::FillTProfile	(	TProfile *	h1,
		Double_t	one,
		Double_t	two,
		Double_t	three
	)

inlineprivate

Definition at line 53 of file KVRawDataAnalyser.h.

◆ FillTProfile2D()

void KVRawDataAnalyser::FillTProfile2D	(	TProfile2D *	h2,
		Double_t	one,
		Double_t	two,
		Double_t	three,
		Double_t	four
	)

inlineprivate

Definition at line 61 of file KVRawDataAnalyser.h.

◆ FillTree()

void KVRawDataAnalyser::FillTree ( const Char_t * tree_name = "" )

Filltree method, the tree named tree_name has to be declared with AddTTree(TTree*) method

if no sname="", all trees in the list is filled

Definition at line 340 of file KVRawDataAnalyser.cpp.

◆ GetCurrentRun()

KVDBRun* KVRawDataAnalyser::GetCurrentRun ( ) const

inline

Definition at line 112 of file KVRawDataAnalyser.h.

◆ GetDetectorEvent()

KVDetectorEvent* KVRawDataAnalyser::GetDetectorEvent ( ) const

inline

Definition at line 92 of file KVRawDataAnalyser.h.

◆ GetEventNumber()

Long64_t KVRawDataAnalyser::GetEventNumber ( ) const

inline

Definition at line 108 of file KVRawDataAnalyser.h.

◆ GetHisto()

TH1* KVRawDataAnalyser::GetHisto ( const Char_t * name ) const

inline

Definition at line 148 of file KVRawDataAnalyser.h.

◆ GetHistoList()

const KVHashList* KVRawDataAnalyser::GetHistoList ( ) const

inline

Definition at line 139 of file KVRawDataAnalyser.h.

◆ GetOpt()

TString KVRawDataAnalyser::GetOpt ( const Char_t * option ) const

inline

Definition at line 187 of file KVRawDataAnalyser.h.

◆ GetRunFileReader()

const KVRawDataReader& KVRawDataAnalyser::GetRunFileReader ( ) const

inline

Definition at line 122 of file KVRawDataAnalyser.h.

◆ GetRunNumber()

Int_t KVRawDataAnalyser::GetRunNumber ( void ) const

inline

Definition at line 104 of file KVRawDataAnalyser.h.

◆ GetTotalEntriesToRead()

Long64_t KVRawDataAnalyser::GetTotalEntriesToRead ( ) const

inlinevirtual

Reimplemented from KVDataAnalyser.

Definition at line 84 of file KVRawDataAnalyser.h.

◆ GetTree()

TTree* KVRawDataAnalyser::GetTree ( const Char_t * name ) const

inline

Definition at line 152 of file KVRawDataAnalyser.h.

◆ GetTreeList()

const KVHashList* KVRawDataAnalyser::GetTreeList ( ) const

inline

Definition at line 143 of file KVRawDataAnalyser.h.

◆ InitAnalysis()

virtual void KVRawDataAnalyser::InitAnalysis ( )

pure virtual

Implemented in KVRawDataReconstructor.

Examples: ExampleRawAnalysis.cpp, and ExampleReconRawAnalysis.cpp.

◆ InitRun()

virtual void KVRawDataAnalyser::InitRun ( )

pure virtual

Implemented in KVRawDataReconstructor.

Examples: ExampleRawAnalysis.cpp, and ExampleReconRawAnalysis.cpp.

◆ IsOptGiven()

Bool_t KVRawDataAnalyser::IsOptGiven ( const Char_t * option )

inline

Definition at line 183 of file KVRawDataAnalyser.h.

◆ Make()

void KVRawDataAnalyser::Make ( const Char_t * kvsname = "MyOwnRawDataAnalyser" )

static

Automatic generation of derived class for raw data analysis.

Definition at line 461 of file KVRawDataAnalyser.cpp.

◆ ProcessRun()

void KVRawDataAnalyser::ProcessRun ( )

private

Perform treatment of a given run Before processing each run, after opening the associated file, user's InitRun() method is called. After each run, user's EndRun() is called. For each event of each run, user's Analysis() method is called just after calling gMultiDetArray->HandleRawDataEvent(fRunfile). In the Analysis() method the user can test gMultiDetArray->HandledRawData() to know if some pertinent data was found in the event or not.

For further customisation, the pre/post-methods are called just before and just after each of these methods (preInitRun(), postAnalysis(), etc. etc.) Open data file

Definition at line 54 of file KVRawDataAnalyser.cpp.

◆ SaveHistos()

void KVRawDataAnalyser::SaveHistos	(	const Char_t *	filename = `""`,
		Option_t *	option = `"recreate"`,
		Bool_t	onlyfilled = `kFALSE`
	)

virtual

Write in file all histograms declared with AddHisto(TH1*)

If no filename is specified, set default name : HistoFileFrom[name_of_class].root

If a filename is specified, search in gROOT->GetListOfFiles() if this file has been already opened

if yes write in it
if not, create it with the corresponding option, write in it and close it just after

onlyfilled flag allow to write all (onlyfilled=kFALSE, default) or only histograms (onlyfilled=kTRUE) those have been filled

Definition at line 377 of file KVRawDataAnalyser.cpp.

◆ SetCombinedOutputFile()

void KVRawDataAnalyser::SetCombinedOutputFile ( const KVString & filename )

inlineprivate

Call in InitAnalysis() to set the name of the single output file containing all histograms and TTrees produced by analysis. This is equivalent to running the analysis with option CombinedOutputFile=[filename] but setting this option in InitAnalysis() will not work. Note that if this method is not called/the option is not given, histograms and TTrees will be written in separate files.

Definition at line 70 of file KVRawDataAnalyser.h.

◆ SetJobOutputFileName()

void KVRawDataAnalyser::SetJobOutputFileName ( const TString & filename )

inline

Call in InitAnalysis() to set the name of the single output file containing all histograms and TTrees produced by analysis.

For interactive jobs or jos using PROOF, filename will be used for the ROOT file. For jobs using a batch system to execute many jobs in parallel, we use the job name with the '.root' extension.

Definition at line 158 of file KVRawDataAnalyser.h.

◆ SetOpt()

void KVRawDataAnalyser::SetOpt	(	const Char_t *	option,
		const Char_t *	value
	)

inline

Definition at line 179 of file KVRawDataAnalyser.h.

◆ SubmitTask()

void KVRawDataAnalyser::SubmitTask ( )

virtual

Perform analysis of chosen runs Before beginning the loop over the runs, the user's InitAnalysis() method is called. After completing the analysis of all runs, the user's EndAnalysis() method is called.

Further customisation of the event loop is possible by overriding the methods preInitAnalysis() postInitAnalysis() preEndAnalysis() postEndAnalysis() which are executed respectively just before and just after the methods.

Reimplemented from KVDataAnalyser.

Definition at line 163 of file KVRawDataAnalyser.cpp.

◆ UnsetOpt()

void KVRawDataAnalyser::UnsetOpt ( const Char_t * opt )

inline

Definition at line 191 of file KVRawDataAnalyser.h.

Member Data Documentation

◆ fCombinedOutputFile

KVString KVRawDataAnalyser::fCombinedOutputFile

private

optional name for single results file with trees and histos

Definition at line 38 of file KVRawDataAnalyser.h.

◆ fCurrentRun

KVDBRun* KVRawDataAnalyser::fCurrentRun

private

poiner to current run

Definition at line 36 of file KVRawDataAnalyser.h.

◆ fEventNumber

Long64_t KVRawDataAnalyser::fEventNumber

private

event number in current run

Definition at line 32 of file KVRawDataAnalyser.h.

◆ fHistoList

KVHashList KVRawDataAnalyser::fHistoList

private

list of histograms of user analysis

Definition at line 33 of file KVRawDataAnalyser.h.

◆ fOptionList

KVUserAnalysisOptionList KVRawDataAnalyser::fOptionList

private

list of options set by user for analysis

Definition at line 39 of file KVRawDataAnalyser.h.

◆ fRunFile

KVRawDataReader* KVRawDataAnalyser::fRunFile

private

currently analysed run file

Definition at line 30 of file KVRawDataAnalyser.h.

◆ fRunNumber

Int_t KVRawDataAnalyser::fRunNumber

private

run number of current file

Definition at line 31 of file KVRawDataAnalyser.h.

◆ fRustines

KVRawDataPatchList KVRawDataAnalyser::fRustines

private

Definition at line 41 of file KVRawDataAnalyser.h.

◆ fTreeFile

TFile* KVRawDataAnalyser::fTreeFile

private

Definition at line 35 of file KVRawDataAnalyser.h.

◆ fTreeList

KVHashList KVRawDataAnalyser::fTreeList

private

list of trees of user analysis

Definition at line 34 of file KVRawDataAnalyser.h.

◆ TotalEntriesToRead

Long64_t KVRawDataAnalyser::TotalEntriesToRead

private

Definition at line 37 of file KVRawDataAnalyser.h.

Detailed Description

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVRawDataAnalyser()

◆ ~KVRawDataAnalyser()

Member Function Documentation

◆ AbortDuringRunProcessing()

◆ AddHisto()

◆ AddTree()

◆ Analysis()

◆ CalculateTotalEventsToRead()

◆ CreateTreeFile()

◆ EndAnalysis()

◆ EndRun()

◆ FillHisto() [1/2]

◆ FillHisto() [2/2]

◆ FillTH1()

◆ FillTH2()

◆ FillTH3()

◆ FillTProfile()

◆ FillTProfile2D()

◆ FillTree()

◆ GetCurrentRun()

◆ GetDetectorEvent()

◆ GetEventNumber()

◆ GetHisto()

◆ GetHistoList()

◆ GetOpt()

◆ GetRunFileReader()

◆ GetRunNumber()

◆ GetTotalEntriesToRead()

◆ GetTree()

◆ GetTreeList()

◆ InitAnalysis()

◆ InitRun()

◆ IsOptGiven()

◆ Make()

◆ ProcessRun()

◆ SaveHistos()

◆ SetCombinedOutputFile()

◆ SetJobOutputFileName()

◆ SetOpt()

◆ SubmitTask()

◆ UnsetOpt()

Member Data Documentation

◆ fCombinedOutputFile

◆ fCurrentRun

◆ fEventNumber

◆ fHistoList

◆ fOptionList

◆ fRunFile

◆ fRunNumber

◆ fRustines

◆ fTreeFile

◆ fTreeList

◆ TotalEntriesToRead