Detailed Description

Manage user analysis of filtered simulation data.

Created by KVClassFactory on Thu Mar 23 14:02:40 2017 Author: John Frankland,,,

Definition at line 20 of file KVSimDirFilterAnalyser.h.

#include <KVSimDirFilterAnalyser.h>

Inheritance diagram for KVSimDirFilterAnalyser:

[legend]

Public Member Functions
	KVSimDirFilterAnalyser ()
	Default constructor.

virtual	~KVSimDirFilterAnalyser ()
	Destructor.

KVDBRun *	GetAnalysedRun () const

KVDBSystem *	GetAnalysedSystem () const

const KV2Body *	GetKinematics () const

void	preAnalysis ()

void	preInitAnalysis ()
	Use options passed to KVEventSelector to initialise dataset used for filter.

void	preInitRun ()

void	RegisterUserClass (TObject *c)

void	SetTriggerConditionsForRun (int run)

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

	~KVSimDirAnalyser ()

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

TTree *	GetAnalysedTree () const override

TList *	GetFileList () const

Int_t	GetNumberOfFilesToAnalyse () const override

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

Bool_t	IsCopyFilesToWorkDir () const

Bool_t	ReadBatchEnvFile (const TString &) override

void	SetAuxFileList (TList *l) override

void	SetCopyFilesToWorkDir (Bool_t on=kTRUE)

void	SetDataSetForFilter (const TString &f)

void	SetFileList (TList *l) override

void	SetSystemForFilter (const TString &f)

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

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

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

virtual	~KVDataAnalyser ()
	Default destructor.

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.

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

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

virtual void	preEndRun ()

virtual void	Reset ()

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

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

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)

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

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

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

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)

Private Attributes
KVEventSelector *	fAnalysisClass
	user analysis class

KV2Body *	fKinematics
	kinematics of reaction

KVDBRun *	fRun
	currently analysed run

KVDBSystem *	fSystem
	currently analysed system

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

◆ KVSimDirFilterAnalyser()

KVSimDirFilterAnalyser::KVSimDirFilterAnalyser ( )

Default constructor.

Definition at line 18 of file KVSimDirFilterAnalyser.cpp.

◆ ~KVSimDirFilterAnalyser()

KVSimDirFilterAnalyser::~KVSimDirFilterAnalyser ( )

virtual

Destructor.

Definition at line 30 of file KVSimDirFilterAnalyser.cpp.

Member Function Documentation

◆ GetAnalysedRun()

KVDBRun * KVSimDirFilterAnalyser::GetAnalysedRun ( ) const

inlinevirtual

Reimplemented from KVDataAnalyser.

Definition at line 54 of file KVSimDirFilterAnalyser.h.

◆ GetAnalysedSystem()

KVDBSystem * KVSimDirFilterAnalyser::GetAnalysedSystem ( ) const

inlinevirtual

Reimplemented from KVDataAnalyser.

Definition at line 50 of file KVSimDirFilterAnalyser.h.

◆ GetKinematics()

const KV2Body * KVSimDirFilterAnalyser::GetKinematics ( ) const

inlinevirtual

Returns: pointer to KV2Body object describing kinematics of reaction analysed

Reimplemented from KVDataAnalyser.

Definition at line 39 of file KVSimDirFilterAnalyser.h.

◆ Make()

void KVSimDirFilterAnalyser::Make ( const Char_t * kvsname = "MyFilteredAnalysis" )

static

Generate a new filtered analysis selector class.

Definition at line 111 of file KVSimDirFilterAnalyser.cpp.

◆ preAnalysis()

void KVSimDirFilterAnalyser::preAnalysis ( )

virtual

Called by KVEventSelector just after reading new event and just before calling user analysis

Copy calculated energy losses of all particles into the detectors

Reimplemented from KVDataAnalyser.

Definition at line 89 of file KVSimDirFilterAnalyser.cpp.

◆ preInitAnalysis()

void KVSimDirFilterAnalyser::preInitAnalysis ( )

virtual

Use options passed to KVEventSelector to initialise dataset used for filter.

Reimplemented from KVDataAnalyser.

Definition at line 42 of file KVSimDirFilterAnalyser.cpp.

◆ preInitRun()

void KVSimDirFilterAnalyser::preInitRun ( )

virtual

Use options passed to KVEventSelector to initialise kinematics for reaction and build experimental set-up

Reimplemented from KVDataAnalyser.

Definition at line 59 of file KVSimDirFilterAnalyser.cpp.

◆ RegisterUserClass()

void KVSimDirFilterAnalyser::RegisterUserClass ( TObject * c )

inlinevirtual

Reimplemented from KVDataAnalyser.

Definition at line 31 of file KVSimDirFilterAnalyser.h.

◆ SetTriggerConditionsForRun()

void KVSimDirFilterAnalyser::SetTriggerConditionsForRun ( int run )

virtual

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 3 arguments:

a pointer to the user's analysis class derived from KVEventSelector;
the number of the run currently being analysed
the 3rd optional argument will be set to kTRUE to indicate that we are analysing filtered simulated data

Reimplemented from KVDataAnalyser.

Definition at line 142 of file KVSimDirFilterAnalyser.cpp.

Member Data Documentation

◆ fAnalysisClass

KVEventSelector* KVSimDirFilterAnalyser::fAnalysisClass

private

user analysis class

Definition at line 22 of file KVSimDirFilterAnalyser.h.

◆ fKinematics

KV2Body* KVSimDirFilterAnalyser::fKinematics

private

kinematics of reaction

Definition at line 23 of file KVSimDirFilterAnalyser.h.

◆ fRun

KVDBRun* KVSimDirFilterAnalyser::fRun

private

currently analysed run

Definition at line 25 of file KVSimDirFilterAnalyser.h.

◆ fSystem

KVDBSystem* KVSimDirFilterAnalyser::fSystem

private

currently analysed system

Definition at line 24 of file KVSimDirFilterAnalyser.h.

Detailed Description

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVSimDirFilterAnalyser()

◆ ~KVSimDirFilterAnalyser()

Member Function Documentation

◆ GetAnalysedRun()

◆ GetAnalysedSystem()

◆ GetKinematics()

◆ Make()

◆ preAnalysis()

◆ preInitAnalysis()

◆ preInitRun()

◆ RegisterUserClass()

◆ SetTriggerConditionsForRun()

Member Data Documentation

◆ fAnalysisClass

◆ fKinematics

◆ fRun

◆ fSystem