Detailed Description

Manages user analysis of reconstructed experimental data.

Definition at line 19 of file KVReconDataAnalyser.h.

#include <KVReconDataAnalyser.h>

Inheritance diagram for KVReconDataAnalyser:

[legend]

Public Member Functions
	KVReconDataAnalyser ()

	~KVReconDataAnalyser ()

Bool_t	CheckTaskVariables (void) override
	Checks the task variables.

TTree *	GetAnalysedTree () const override

Int_t	GetDataReleaseNumber () const

KVString	GetDataSeries () const

KVString	GetDataVersion () const

TEnv *	GetReconDataTreeInfos () const

Long64_t	GetTotalEntriesToRead () const override

void	preAnalysis () override
	apply any required patches to data

void	preInitRun () override

void	PrintTreeInfos ()
	Print informations on currently analysed TTree.

virtual void	RegisterUserClass (TObject *obj) override

void	Reset () override
	Reset task variables.

void	SetAnalysedTree (TTree *t) override

virtual void	SetTriggerConditionsForRun (int) override

void	SubmitTask () override

Public Member Functions inherited from KVDataSetAnalyser
	KVDataSetAnalyser ()
	Default constructor.

virtual	~KVDataSetAnalyser ()
	Destructor.

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.

const KVNumberList &	GetRunList () const

Int_t	GetRunNumberFromFileName (const Char_t *)
	Get the run number from the filename.

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

TString	SystemBatchName () const

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

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

virtual	~KVDataAnalyser ()
	Default destructor.

Bool_t	BatchMode () const

virtual Bool_t	CheckStatusUpdateInterval (Long64_t nevents) const

void	ChooseNbEventToRead ()
	Ask user to set number of events to read.

void	ChooseRunningMode ()

void	ChooseUserClass ()
	Choose the user's analysis class.

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

void	DoStatusUpdate (Long64_t nevents) const
	Print infos on events treated, disk usage, memory usage.

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.

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

virtual void	preEndRun ()

virtual void	preInitAnalysis ()

virtual void	Run ()
	Check all task variables, then run analyser.

virtual void	RunMenus ()
	Run data analyser in menu-driven mode.

Bool_t	RunningInLaunchDirectory ()

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)

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.

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=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

Private Attributes
Long64_t	Entry

Int_t	fDataReleaseNum
	KV release number used to write analysed data.

KVString	fDataSeries
	KV series used to write analysed data.

KVString	fDataVersion
	KV version used to write analysed data.

KVDataPatchList	fRustines
	patches to be applied to correct data before analysis

KVReconEventSelector *	fSelector
	the data analysis class

TTree *	theChain
	chain of TTrees to be analysed

Long64_t	TotalEntriesToRead

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

Public Types inherited from TObject
enum	EDeprecatedStatusBits

enum	EStatusBits

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

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

Constructor & Destructor Documentation

◆ KVReconDataAnalyser()

KVReconDataAnalyser::KVReconDataAnalyser ( )

Definition at line 26 of file KVReconDataAnalyser.cpp.

◆ ~KVReconDataAnalyser()

KVReconDataAnalyser::~KVReconDataAnalyser ( )

inline

Destructor

Definition at line 41 of file KVReconDataAnalyser.h.

Member Function Documentation

◆ CheckTaskVariables()

Bool_t KVReconDataAnalyser::CheckTaskVariables ( void )

overridevirtual

Checks the task variables.

Reimplemented from KVDataAnalyser.

Definition at line 53 of file KVReconDataAnalyser.cpp.

◆ GetAnalysedTree()

TTree * KVReconDataAnalyser::GetAnalysedTree ( ) const

inlineoverridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 47 of file KVReconDataAnalyser.h.

◆ GetDataReleaseNumber()

Int_t KVReconDataAnalyser::GetDataReleaseNumber ( ) const

inline

Definition at line 79 of file KVReconDataAnalyser.h.

◆ GetDataSeries()

KVString KVReconDataAnalyser::GetDataSeries ( ) const

inline

Definition at line 75 of file KVReconDataAnalyser.h.

◆ GetDataVersion()

KVString KVReconDataAnalyser::GetDataVersion ( ) const

inline

Definition at line 71 of file KVReconDataAnalyser.h.

◆ GetReconDataTreeInfos()

TEnv * KVReconDataAnalyser::GetReconDataTreeInfos ( ) const

Definition at line 250 of file KVReconDataAnalyser.cpp.

◆ GetTotalEntriesToRead()

Long64_t KVReconDataAnalyser::GetTotalEntriesToRead ( ) const

inlineoverridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 35 of file KVReconDataAnalyser.h.

◆ preAnalysis()

void KVReconDataAnalyser::preAnalysis ( )

overridevirtual

apply any required patches to data

Reimplemented from KVDataAnalyser.

Definition at line 240 of file KVReconDataAnalyser.cpp.

◆ preInitRun()

void KVReconDataAnalyser::preInitRun ( )

overridevirtual

Called by currently-processed TSelector when a new file in the TChain is opened.

We call gMultiDetArray->SetParameters for the current run. Whether or not only physics parameters are set, or the full set of calibrations and identifications for each detector/identification telescope is determined by the environment variable

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

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

WithCalibInfos=yes

Infos on currently read file/tree are printed.

Reimplemented from KVDataAnalyser.

Definition at line 186 of file KVReconDataAnalyser.cpp.

◆ PrintTreeInfos()

void KVReconDataAnalyser::PrintTreeInfos ( )

Print informations on currently analysed TTree.

Definition at line 306 of file KVReconDataAnalyser.cpp.

◆ RegisterUserClass()

virtual void KVReconDataAnalyser::RegisterUserClass ( TObject * obj )

inlineoverridevirtual

The user class inherits from KVReconEventSelector

Reimplemented from KVDataAnalyser.

Reimplemented in KVOnlineReconDataAnalyser.

Definition at line 63 of file KVReconDataAnalyser.h.

◆ Reset()

void KVReconDataAnalyser::Reset ( )

overridevirtual

Reset task variables.

Reimplemented from KVDataSetAnalyser.

Definition at line 36 of file KVReconDataAnalyser.cpp.

◆ SetAnalysedTree()

void KVReconDataAnalyser::SetAnalysedTree ( TTree * t )

inlineoverridevirtual

Reimplemented from KVDataAnalyser.

Definition at line 51 of file KVReconDataAnalyser.h.

◆ SetTriggerConditionsForRun()

void KVReconDataAnalyser::SetTriggerConditionsForRun ( int run )

overridevirtual

When called from the InitRun() method of a user's analysis class, this method will ensure that only data compatible with the experimental trigger will be provided for analysis in the user's Analysis() method.

This will be done by searching for a KVTriggerConditions plugin class defined for the currently-analysed dataset, defined like so:

+Plugin.KVTriggerConditions: [dataset] [classname] [libname] "[default constructor]()"

An object of the plugin class will be instantiated, and then its overridden KVTriggerConditions::SetTriggerConditionsForRun() method will be called with 2 arguments:

a pointer to the user's analysis class derived from KVReconEventSelector;
the number of the run currently being analysed

Reimplemented from KVDataAnalyser.

Definition at line 273 of file KVReconDataAnalyser.cpp.

◆ SubmitTask()

void KVReconDataAnalyser::SubmitTask ( )

overridevirtual

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

Reimplemented from KVDataAnalyser.

Definition at line 81 of file KVReconDataAnalyser.cpp.

Member Data Documentation

◆ Entry

Long64_t KVReconDataAnalyser::Entry

private

Definition at line 24 of file KVReconDataAnalyser.h.

◆ fDataReleaseNum

Int_t KVReconDataAnalyser::fDataReleaseNum

private

KV release number used to write analysed data.

Definition at line 29 of file KVReconDataAnalyser.h.

◆ fDataSeries

KVString KVReconDataAnalyser::fDataSeries

private

KV series used to write analysed data.

Definition at line 28 of file KVReconDataAnalyser.h.

◆ fDataVersion

KVString KVReconDataAnalyser::fDataVersion

private

KV version used to write analysed data.

Definition at line 27 of file KVReconDataAnalyser.h.

◆ fRustines

KVDataPatchList KVReconDataAnalyser::fRustines

private

patches to be applied to correct data before analysis

Definition at line 31 of file KVReconDataAnalyser.h.

◆ fSelector

KVReconEventSelector* KVReconDataAnalyser::fSelector

private

the data analysis class

Definition at line 22 of file KVReconDataAnalyser.h.

◆ theChain

TTree* KVReconDataAnalyser::theChain

private

chain of TTrees to be analysed

Definition at line 23 of file KVReconDataAnalyser.h.

◆ TotalEntriesToRead

Long64_t KVReconDataAnalyser::TotalEntriesToRead

private

Definition at line 26 of file KVReconDataAnalyser.h.

Detailed Description

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVReconDataAnalyser()

◆ ~KVReconDataAnalyser()

Member Function Documentation

◆ CheckTaskVariables()

◆ GetAnalysedTree()

◆ GetDataReleaseNumber()

◆ GetDataSeries()

◆ GetDataVersion()

◆ GetReconDataTreeInfos()

◆ GetTotalEntriesToRead()

◆ preAnalysis()

◆ preInitRun()

◆ PrintTreeInfos()

◆ RegisterUserClass()

◆ Reset()

◆ SetAnalysedTree()

◆ SetTriggerConditionsForRun()

◆ SubmitTask()

Member Data Documentation

◆ Entry

◆ fDataReleaseNum

◆ fDataSeries

◆ fDataVersion

◆ fRustines

◆ fSelector

◆ theChain

◆ TotalEntriesToRead