Detailed Description

Manage analysis of reconstructed INDRA data.

Definition at line 25 of file KVINDRAReconDataAnalyser.h.

#include <KVINDRAReconDataAnalyser.h>

Inheritance diagram for KVINDRAReconDataAnalyser:

[legend]

Public Member Functions
	KVINDRAReconDataAnalyser ()

	~KVINDRAReconDataAnalyser ()

Bool_t	CheckIfUserClassIsValid (const KVString &="") override

Bool_t	CheckTaskVariables (void) override
	Checks the task variables. More...

void	CloneRawAndGeneTrees ()

TTree *	GetAnalysedTree () const override

Int_t	GetDataReleaseNumber () const

KVString	GetDataSeries () const

KVString	GetDataVersion () const

TTree *	GetGeneDataTree () const

TTree *	GetRawDataTree () const

Long64_t	GetRawEntryNumber ()

TEnv *	GetReconDataTreeInfos () const

KVReconstructedEvent *	GetReconstructedEvent ()

Long64_t	GetTotalEntriesToRead () const override

TTree *	GetTree () const

void	preAnalysis () override

void	preInitAnalysis () override

void	preInitRun () override

void	PrintTreeInfos ()
	Print informations on currently analysed TTree. More...

void	RegisterUserClass (TObject *obj) override

void	Reset () override
	Reset task variables. More...

void	SetAnalysedTree (TTree *t) override

void	SetSelectorCurrentRun (KVINDRADBRun *CurrentRun)

void	SetTree (TTree *t)

void	SetTriggerConditionsForRun (int) override

void	SubmitTask () override

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

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

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

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

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

virtual void	preEndRun ()

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

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)

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)

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

◆ KVINDRAReconDataAnalyser()

KVINDRAReconDataAnalyser::KVINDRAReconDataAnalyser ( )

Definition at line 36 of file KVINDRAReconDataAnalyser.cpp.

◆ ~KVINDRAReconDataAnalyser()

KVINDRAReconDataAnalyser::~KVINDRAReconDataAnalyser ( )

inline

Destructor

Definition at line 56 of file KVINDRAReconDataAnalyser.h.

Member Function Documentation

◆ CheckIfUserClassIsValid()

Bool_t KVINDRAReconDataAnalyser::CheckIfUserClassIsValid ( const KVString & = "" )

overridevirtual

Overrides KVDataAnalyser method, for backwards & forwards compatibility.

Old user analysis classes may derive from KVOldINDRASelector (aka KVSelector) instead of KVINDRAEventSelector.

It is also possible to analyse data with a "vanilla" KVReconEventSelector analysis class.

Reimplemented from KVDataAnalyser.

Definition at line 539 of file KVINDRAReconDataAnalyser.cpp.

◆ CheckTaskVariables()

Bool_t KVINDRAReconDataAnalyser::CheckTaskVariables ( void )

overridevirtual

Checks the task variables.

Reimplemented from KVDataAnalyser.

Definition at line 70 of file KVINDRAReconDataAnalyser.cpp.

◆ CloneRawAndGeneTrees()

void KVINDRAReconDataAnalyser::CloneRawAndGeneTrees ( )

Definition at line 524 of file KVINDRAReconDataAnalyser.cpp.

◆ GetAnalysedTree()

TTree* KVINDRAReconDataAnalyser::GetAnalysedTree ( ) const

inlineoverridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 73 of file KVINDRAReconDataAnalyser.h.

◆ GetDataReleaseNumber()

Int_t KVINDRAReconDataAnalyser::GetDataReleaseNumber ( ) const

inline

Definition at line 110 of file KVINDRAReconDataAnalyser.h.

◆ GetDataSeries()

KVString KVINDRAReconDataAnalyser::GetDataSeries ( ) const

inline

Definition at line 106 of file KVINDRAReconDataAnalyser.h.

◆ GetDataVersion()

KVString KVINDRAReconDataAnalyser::GetDataVersion ( ) const

inline

Definition at line 102 of file KVINDRAReconDataAnalyser.h.

◆ GetGeneDataTree()

TTree* KVINDRAReconDataAnalyser::GetGeneDataTree ( ) const

inline

Definition at line 118 of file KVINDRAReconDataAnalyser.h.

◆ GetRawDataTree()

TTree* KVINDRAReconDataAnalyser::GetRawDataTree ( ) const

inline

Definition at line 114 of file KVINDRAReconDataAnalyser.h.

◆ GetRawEntryNumber()

Long64_t KVINDRAReconDataAnalyser::GetRawEntryNumber ( )

Definition at line 342 of file KVINDRAReconDataAnalyser.cpp.

◆ GetReconDataTreeInfos()

TEnv * KVINDRAReconDataAnalyser::GetReconDataTreeInfos ( ) const

Definition at line 469 of file KVINDRAReconDataAnalyser.cpp.

◆ GetReconstructedEvent()

KVReconstructedEvent * KVINDRAReconDataAnalyser::GetReconstructedEvent ( void )

Definition at line 354 of file KVINDRAReconDataAnalyser.cpp.

◆ GetTotalEntriesToRead()

Long64_t KVINDRAReconDataAnalyser::GetTotalEntriesToRead ( ) const

inlineoverridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 50 of file KVINDRAReconDataAnalyser.h.

◆ GetTree()

TTree* KVINDRAReconDataAnalyser::GetTree ( ) const

inline

Definition at line 65 of file KVINDRAReconDataAnalyser.h.

◆ preAnalysis()

void KVINDRAReconDataAnalyser::preAnalysis ( )

overridevirtual

Read and set raw data for the current reconstructed event

Any required data patches ("rustines") are applied.

Reimplemented from KVDataAnalyser.

Definition at line 378 of file KVINDRAReconDataAnalyser.cpp.

◆ preInitAnalysis()

void KVINDRAReconDataAnalyser::preInitAnalysis ( )

overridevirtual

Called by currently-processed KVEventSelector before user's InitAnalysis() method. We build the multidetector for the current dataset in case informations on detector are needed e.g. to define histograms in InitAnalysis(). Note that at this stage we are not analysing a given run, so the parameters of the array are not set (they will be set in preInitRun()).

Note for PROOF: as this will be called both on master and on slave workers, in order to reduce memory footprint we only build INDRA on the slaves

Reimplemented from KVDataAnalyser.

Definition at line 230 of file KVINDRAReconDataAnalyser.cpp.

◆ preInitRun()

void KVINDRAReconDataAnalyser::preInitRun ( )

overridevirtual

Called by currently-processed TSelector when a new file in the TChain is opened. We call gIndra->SetParameters for the current run: whether only physics parameters will be set, or the full set of identification/calibration parameters depends on the value of the environment variable

[dataset].ReconAnalysis.WithCalibInfos: [yes/no]

This can be overridden for any individual analysis by setting the analysis class option

WithCalibInfos=yes

We connect the acquisition parameter objects to the branches of the raw data tree. Infos on currently read file/tree are printed. Any required data patches ("rustines") are initialized.

Reimplemented from KVDataAnalyser.

Definition at line 289 of file KVINDRAReconDataAnalyser.cpp.

◆ PrintTreeInfos()

void KVINDRAReconDataAnalyser::PrintTreeInfos ( )

Print informations on currently analysed TTree.

Definition at line 479 of file KVINDRAReconDataAnalyser.cpp.

◆ RegisterUserClass()

void KVINDRAReconDataAnalyser::RegisterUserClass ( TObject * obj )

inlineoverridevirtual

The user class may inherit from KVEventSelector or KVOldINDRASelector Only one of the two pointers will be valid

Reimplemented from KVDataAnalyser.

Definition at line 92 of file KVINDRAReconDataAnalyser.h.

◆ Reset()

void KVINDRAReconDataAnalyser::Reset ( void )

overridevirtual

Reset task variables.

Reimplemented from KVDataSetAnalyser.

Definition at line 48 of file KVINDRAReconDataAnalyser.cpp.

◆ SetAnalysedTree()

void KVINDRAReconDataAnalyser::SetAnalysedTree ( TTree * t )

inlineoverridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 77 of file KVINDRAReconDataAnalyser.h.

◆ SetSelectorCurrentRun()

void KVINDRAReconDataAnalyser::SetSelectorCurrentRun ( KVINDRADBRun * CurrentRun )

Definition at line 257 of file KVINDRAReconDataAnalyser.cpp.

◆ SetTree()

void KVINDRAReconDataAnalyser::SetTree ( TTree * t )

inline

Definition at line 69 of file KVINDRAReconDataAnalyser.h.

◆ SetTriggerConditionsForRun()

void KVINDRAReconDataAnalyser::SetTriggerConditionsForRun ( int run )

overridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 364 of file KVINDRAReconDataAnalyser.cpp.

◆ SubmitTask()

void KVINDRAReconDataAnalyser::SubmitTask ( )

overridevirtual

Run the interactive analysis make the chosen dataset the active dataset ( = gDataSet; note this also opens database and positions gDataBase & gIndraDB).

Reimplemented from KVDataAnalyser.

Definition at line 99 of file KVINDRAReconDataAnalyser.cpp.

◆ WriteBatchEnvFile()

void KVINDRAReconDataAnalyser::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 KVDataSetAnalyser.

Definition at line 203 of file KVINDRAReconDataAnalyser.cpp.

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVINDRAReconDataAnalyser()

◆ ~KVINDRAReconDataAnalyser()

Member Function Documentation

◆ CheckIfUserClassIsValid()

◆ CheckTaskVariables()

◆ CloneRawAndGeneTrees()

◆ GetAnalysedTree()

◆ GetDataReleaseNumber()

◆ GetDataSeries()

◆ GetDataVersion()

◆ GetGeneDataTree()

◆ GetRawDataTree()

◆ GetRawEntryNumber()

◆ GetReconDataTreeInfos()

◆ GetReconstructedEvent()

◆ GetTotalEntriesToRead()

◆ GetTree()

◆ preAnalysis()

◆ preInitAnalysis()

◆ preInitRun()

◆ PrintTreeInfos()

◆ RegisterUserClass()

◆ Reset()

◆ SetAnalysedTree()

◆ SetSelectorCurrentRun()

◆ SetTree()

◆ SetTriggerConditionsForRun()

◆ SubmitTask()

◆ WriteBatchEnvFile()